Passo a Passo

Legal! Que bom que você deseja integrar sua solução com a gente! Nesta página nós iremos te auxiliar em como realizar este processo.

Contato Inicial

Primeiramente precisamos criar um usuário para você. Para isto, basta entrar em contato conosco através desta página!‌

Com a criação de um usuário, você terá acesso as nossas APIs!‌

Pré-Requisitos

Para iniciar os seus testes, você precisará ter em mãos os dados de uma empresa credenciada para o recebimento de NF-e e o certificado digital da mesma.‌

Após isso, basta seguir os seguintes passos:‌

Tudo em ordem? Então podemos começar os testes!‌

Conhecendo as APIs

Antes de iniciar seu desenvolvimento, separamos algumas APIs para que você possa testar pelo Swagger, a fim de que possa conhecer suas características e retornos.

Etapas

Descrição

Utilizado para obter o token de acesso.

Utilizado para obter as NF-es consultadas automaticamente na SEFAZ, objetivando obter a chave de acesso das mesmas.

Utilizado para flagar as chaves de acessos obtidas na API de consulta de XML resumido, com o intuito de que não retornem a aparecer na consulta.

Utilizado para realizar a entrada do documento no sistema pela chave de acesso.

Usado para realizar a entrada do documento no sistema diretamente por seu XML completo.

Utilizado para efetuar a operação de manifesto em uma NF-e.

Utilizado para realizar o download dos dados completos da nota diretamente da SEFAZ utilizando o seu ID.

Utilizado para obter as NF-es que já possuem o XML completo baixado, a fim de obter a chave de acesso das mesmas.

Utilizado para flagar as chaves de acessos obtidas na API de consulta de XML completo, com o intuito de que não retornem a aparecer na consulta.

Utilizando o ID da nota, é possível consultar detalhadamente os dados da mesma.

Utilizando o ID da nota, é possível consultar detalhadamente o XML deste documento.

Utilizando o ID da NF-e, realizar o envio da mesma por e-mail.

Testou e entendeu como tudo funciona? Então já podemos iniciar o desenvolvimento.‌

Desenvolvimento

Da mesma forma proposta na etapa de testes, nós deixaremos um passo a passo de desenvolvimento como guia. Nele, você verá todos os fluxos operacionais e as APIs que devem ser utilizadas.‌

Checklist

Etapa

Descrição

A autenticação será utilizada para obter o token de acesso que será passado em todas as chamadas de API.

Etapa principal, onde toda a operação de Recebimento irá ocorrer

Last updated