Back to top

Alterdata Software

Introdução

Documentações dos Produtos

Esta é uma plataforma que permite os clientes da Alterdata acessarem as documentações dos seus produtos.

Documentações aqui presentes:

NF-Stock:

  • MS-Importação;

  • MS-Contas.

MS-Importação

A API MS-Importação é um serviço da Alterdata que permite realizar a importação de documentos fiscais (NFe, NFCe, NFSe, CTe e SAT). Para enviar seu documento informe o tamanho e a extensão do seu arquivo. O sistema retornará uma url que será utilizada no envio do mesmo.

A autenticação na nossa API é realizada por meio de token de acesso. Um token de acesso é uma chave única que você precisa incluir no cabeçalho de autenticação da solicitação a fim de provar que está autorizado a acessar os recursos protegidos.Mantenha seu token de acesso em segurança. Não compartilhe seu token com terceiros e não o armazene em locais de fácil acesso.

  • Tipo de Documentos Fiscais Compatíveis: NFe, NFCe, NFSe, CTe e SAT;

  • Eventos: ProcNFE ou ProcEvento;

  • Tipo de Extensões Suportadas: .xml .zip;

  • Tamanho de Arquivo Permitido: Máximo: 6mb

Importante: O tamanho do arquivo deverá ser informado em bytes. Exemplo: se o seu arquivo tiver 6mb, o informe como “6000000”.

Obter o token de acesso

Passo 1: Obtenha o token no site do NF-Stock

O token de acesso é gerado no site do NF-Stock. Após se autenticar, acesse as ‘Opções da Conta’ e clique na aba ‘Integração’. Copie esse token para usá-lo no próximo passo.

Passo 2: Enviar as informações prévias do arquivo

Obter o URL Upload
POST/storage

Através deste endpoint, faça o envio das informações do arquivo. Para fazer isso, utilize uma das seguintes URL’s: URL da ‘Example URI’ (ambiente de teste) ou para a URL de produção: https://ms-importacao-service-nfstock.alterdatasoftware.com.br/storage

Campos obrigatórios

size - Informe o tamanho em bytes do arquivo (até 6mb)

extension - Informe a extensão do arquivo: “.zip” ou “.xml”

Example URI

POST https://www.alterdata.com.br/storage
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer INSIRA_AQUI_SEU_TOKEN
Body
{
  "size": 2999999,
  "extension": ".xml"
}
Response  200
HideShow

Esta resposta devolverá o atributo “url”, que é o endpoint para o envio do documento no passo 2, com tempo de expiração de 1 minuto.

Body
{
  "mensagem": "Url gerada com sucesso.",
  "url": "https://ms-importacao.s3.amazonaws.com/Identificador?AWSAccessKeyId=&Expires=&Signature="
}

Passo 2: Enviar o arquivo

Upload do arquivo
PUT/{Identificador}{?AWSAccessKeyId,Expires,Signature}

Através deste endpoint, faça o envio do arquivo para a url da Amazon. O corpo da solicitação precisa ser do tipo Binary File, para que você possa selecionar e enviar o arquivo desejado. Para fazer isso, utilize a url obtida na Response 200 do passo 1.

Example URI

PUT https://www.alterdata.com.br/Identificador?AWSAccessKeyId=&Expires=&Signature=
URI Parameters
HideShow
Identificador
guide (required) 
AWSAccessKeyId
string (required) 
Expires
number (required) 
Signature
string (required) 
Request
HideShow
Body
Binary file
Response  200

MS-Contas

A API MS-Contas é um serviço da Alterdata que permite realizar o cadastro de Cliente. Para cadastrar seu cliente informe o Codigo CRM, CPF ou CNPJ, Nome da Empresa e Email. O sistema retornará uma mensagem de “Cliente cadastrado com sucesso!”.

A autenticação na nossa API é realizada por meio de token de acesso. Um token de acesso é uma chave única que você precisa incluir no cabeçalho de autenticação da solicitação a fim de provar que está autorizado a acessar os recursos protegidos. Mantenha seu token de acesso em segurança. Não compartilhe seu token com terceiros e não o armazene em locais de fácil acesso.

  • O token de acesso que você usará nessa API, expira a cada 5 minutos, sendo necessário realizar o passo 1 para obter um novo token válido.

Passo 1: Obter token de acesso

Copie o token gerado no “access_token” do objeto da Response 200 para usá-lo no próximo passo.

Obter o token de acesso
POST/auth/realms/alterdata/protocol/openid-connect/token

Example URI

POST https://www.alterdata.com.br/auth/realms/alterdata/protocol/openid-connect/token
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
grant_type: client_credentials
client_id: INSIRA_SEU_CLIENT_ID
client_secret: INSIRA_SEU_CLIENT_SECRET
Response  200
HideShow
Body
{
  "access_token": "string",
  "expires_in": 300,
  "refresh_expires_in": 1800,
  "refresh_token": "string",
  "token_type": "Bearer",
  "not-before-policy": 1652379069,
  "session_state": "string",
  "scope": "email profile"
}

Passo 2: Enviar Cliente no NF-Stock

Cadastrar Cliente
POST/api/contas/nfstock/contador/{CRM}/cliente

Campos obrigatórios

cpfCnpj - CPF ou CNPJ do cliente

nomeEmpresa - Nome da empresa sendo cadastrada (Até 200 caracteres e mínimo de 2 caracteres)

email - Email do cliente

  • Se quiser enviar certificado digital, serão obrigatórios:

arquivoCertificado - Certificado Digital A1 (inserir no formato Base64)

senhaCertificado - Senha do certificado digital (inserir no formato Base64)

ufCertificado - Unidade Federativa do certificado digital

Enviar as informações do Cliente neste passo. Para fazer isso, envie uma solicitação HTTP POST para uma das seguintes URL’s: URL da ‘Example URI’ (ambiente de teste) ou para a URL de produção: https://contas-service-nfstock.alterdatasoftware.com.br/api/contas/nfstock/contador/{CRM}/cliente

Example URI

POST https://www.alterdata.com.br/api/contas/nfstock/contador/CRM/cliente
URI Parameters
HideShow
CRM
string (required) 

Filtrar por código CRM

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer INSIRA_AQUI_SEU_TOKEN
Body
{
  "cpfCnpj": "111111111",
  "nomeEmpresa": "Teste Contas",
  "email": "a@a.com",
  "arquivoCertificado": "string",
  "senhaCertificado": "string",
  "ufCertificado": "string",
  "trabalhaComProcuracao": true
}
Response  200
HideShow
Body
{
  "data": {
    "id": 111111,
    "message": "Cliente cadastrado com sucesso!"
  }
}

Atualizar Cliente no NF-Stock

Atualizar Cliente
PUT/api/contas/nfstock/contador/{CRM}/cliente/{CPFCNPJ}

Envie as informações que deseja atualizar do Cliente. Para fazer isso, envie uma solicitação HTTP PUT para uma das seguintes URL’s: URL da ‘Example URI’ (ambiente de teste) ou para a URL de produção: https://contas-service-nfstock.alterdatasoftware.com.br/api/contas/nfstock/contador/{CRM}/cliente/{CPFCNPJ}

Example URI

PUT https://www.alterdata.com.br/api/contas/nfstock/contador/CRM/cliente/CPFCNPJ
URI Parameters
HideShow
CRM
string (required) 

Filtrar por código CRM

CPFCNPJ
string (required) 

Filtrar por CPF/CNPJ

Request
HideShow
Body
{
  "nomeEmpresa": "Teste Contas",
  "email": "a@a.com",
  "arquivoCertificado": "string",
  "senhaCertificado": "string",
  "ufCertificado": "string",
  "trabalhaComProcuracao": true
}
Response  200
HideShow
Body
{
  "message": "Cliente (11111111) atualizado com sucesso!"
}

Dúvidas?

Fale com nosso suporte

Para verificar questões relacionadas a API, entre em contato com nosso suporte.

Generated by aglio on 14 Dec 2023