Passo a Passo NF-e

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áginaarrow-up-right!

Com a criação de um usuário, você terá acesso às 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. Hoje contamos com dois ambientes de APIs, portanto estaremos descrevendo os endpoints disponíveis em cada um deles.

Etapas

Descrição

Utilizado para obter o token de acesso (2.0).

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.

API para efetuar a requisição do download do XML na SEFAZ, após a manifestação da NF-e.

Etapas
Descrição

Utilizado para obter o token de acesso (3.0).

Usado para Enviar o XML de NF-e no layout ProcNFe no formato base64.

Responsável por possibilitar ao integrador a consulta sequencial de todos os eventos relacionados as NF-es Recebidas para seus CNPJs, incluindo XMLs completos, cancelamentos, CC-es, etc.

Responsável por permitir ao integrador a consulta dos XMLs no formato base64 relacionados às NF-es recebidas.

Responsável por permitir ao integrador a consulta dos DANFEs (PDFs) no formato base64 relacionados às NF-es recebidas.

Usado para enviar Anexo no formato base64 e vincular a uma NF-e pelo numero do ID do documento

Usado para consultar o anexo vinculado a NF-e pelo numero do ID do anexo, obtido no momento do envio do mesmo.

Responsável por possibilitar ao integrador a consulta sequencial de todos os eventos relacionados as NF-es Recebidas para seus CNPJs, incluindo XMLs dos eventos e outros campos relacionados ao XML.

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