Consulta de Notas Fiscais
Introducão
Seja bem-vindo a documentação da API de consulta de Notas Fiscais! 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.
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 topo desta página para que os métodos funcionem corretamente. No seu código e integração temos suporte para autenticação de diversas formas sendo eles: HTTP Header (Authorization) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).
Fontes de consulta
A NFE.io oferece duas opções de consulta de NF-e pela mesma chave de acesso, ambas com cobertura nacional:
- Consulta SEFAZ (endpoints sem
/serpro/): usa o portal público nacional da Receita Federal (nfe.fazenda.gov.br). Inclui consulta de eventos da nota. - Consulta Irrestrita (endpoints com
/serpro/): usa um provedor oficial autorizado pela autoridade federal, com maior previsibilidade.
Documentação funcional:
Authentication
- API Key: Authorization_Header
- API Key: Authorization_QueryParam
Autenticar usando o Cabeçalho HTTP Authorization com sua API Key
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |
Autenticar usando o Parametro na URL, exemplo: "/?apikey={APIKEY_TOKEN}"
Security Scheme Type: | apiKey |
|---|---|
Query parameter name: | apikey |