NFS-eAPIGlossário
Glossário técnico de termos usados em APIs de notas fiscais
· 5 min de leitura
Um glossário direto dos termos mais comuns em documentação de APIs de notas fiscais, útil pra quem está começando a ler a documentação técnica do Ambiente Nacional ou de qualquer ferramenta de integração.
Termos de autenticação
- mTLS (TLS mútuo): modelo de conexão segura em que tanto quem consulta quanto o servidor apresentam certificado, usado para autenticar as chamadas ao Ambiente Nacional.
- Certificado A1: certificado digital em arquivo, usado para autenticar integrações automatizadas: veja mais em autenticação e certificado digital em APIs.
- ICP-Brasil: infraestrutura oficial brasileira de certificação digital, responsável por emitir os certificados aceitos nessas integrações.
Termos de payload
- NSU (Número Sequencial Único): identificador que marca a posição de cada lote de documentos na distribuição do Ambiente Nacional: veja como a consulta usa o NSU na prática.
- DPS (Declaração de Prestação de Serviços): documento que dá origem à NFS-e, enviado pelo prestador ao Emissor Nacional.
- Schema: a definição formal da estrutura esperada de um documento XML ou JSON, usada para validar se um payload está no formato correto.
Termos de status e retorno
- Lote: conjunto de documentos retornado numa única chamada de consulta, limitado em tamanho por chamada.
- Evento: registro associado a uma nota além da emissão original, como o cancelamento.
- Ambiente de homologação: ambiente de testes que simula o Ambiente Nacional real, usado para validar uma integração antes de operar em produção.
Perguntas frequentes
Onde encontro a lista oficial completa de termos?
A documentação técnica completa do Ambiente Nacional, incluindo manuais de integração e definições formais, está disponível no portal gov.br/nfse; este glossário cobre só os termos mais recorrentes para quem está começando.
Se sua equipe está avaliando integrar diretamente, veja também o que considerar antes de integrar uma API de NFS-e recebidas. A IntegroBR NFS-e Recebidas também expõe uma API própria e documentada, caso prefira integrar sem lidar com esses termos diretamente no Ambiente Nacional.
