Consulta de NF-e (Distribuição)
Introdução
Seja bem-vindo a documentação da API de Consulta de NF-e (Distribuição)! Nossa API foi criada utilizando o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada abaixo.
Esta API tem como objetivo manipular o produto de consulta de NF-e. O processo tem como pré-requisitos o cadastro de uma empresa, na sequência o cadastro de um certificado A1 válido desta empresa, e o cadastro de um endpoint de webhook para você receber as notificações. Para mais detalhes de como cadastrar empresa, certificado e webhook, você pode ver nossa documentação da nota fiscal de produto, ou fazer o procedimento via dashboard da nfe.io.
Com os pré-requisitos atendidos, o próximo passo é habilitar a busca automática e observar os webhooks chegando em seu endpoint cadastrado.
Como usar a API?
Logo a seguir você encontrará todos os recursos e metódos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.
Autenticação
Você precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API. Para isso você deve colocar sua chave de API no campo que se encontra no topo desta página para que os métodos funcionem corretamente. No seu código de integração temos suporte para autenticação de diversas formas sendo eles: HTTP Header (Authorization ou X-NFEIO-APIKEY) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).
Authentication
- API Key: apiKey
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |