Quickstart — primeira NFS-e em ≤5 minutos
Objetivo: ativar o NFS-e Inbound e receber a primeira NFS-e em ≤5 minutos. Para tutorial completo, vá direto a Primeira integração.
Sumário
- Pré-requisitos
- Fluxo em 5 passos
- Passo 1 — Ativar inbound
- Passo 2 — Aguardar primeiro polling
- Passo 3 — Receber webhook ou consultar via API
- Passo 4 — Baixar XML/PDF
- Passo 5 — Próximos passos
Pré-requisitos
- API Key ativa com papel
Nota Fiscal (api.nfe.io)ouNFSeDist (dfe.nfe.io) - CompanyId da empresa (CNPJ) cadastrada no painel
- webhookUrl HTTPS público para receber notificações
Fluxo em 5 passos
Passo 1 — Ativar inbound
export NFEIO_API_KEY="<sua-chave>"
export COMPANY_ID="<id-da-empresa>"
curl -X POST "https://api.nfse.io/v2/companies/inbound/nfse" \
-H "Authorization: $NFEIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"companyId": "'$COMPANY_ID'",
"initialNsu": 0,
"webhookUrl": "https://meu-sistema.com/webhook/nfse"
}'
Resposta 201 Created com isActive: true confirma a ativação.
Passo 2 — Aguardar primeiro polling
A NFE.io passa a consultar o ADN a cada ~30 segundos em nome do seu CNPJ. Se há histórico no ADN, a primeira NFS-e chega em segundos.
Passo 3 — Receber webhook ou consultar via API
Via webhook (preferido): o endpoint recebe POST com eventName: inbound.serviceInvoice.received.
Via API:
curl "https://api.nfse.io/v2/companies/$COMPANY_ID/inbound/nfse?pageCount=10" \
-H "Authorization: $NFEIO_API_KEY"
Passo 4 — Baixar XML/PDF
# XML — segue 302 redirect para signed URL (TTL 30min)
curl -L "https://api.nfse.io/v2/companies/$COMPANY_ID/inbound/nfse/{id}/xml" \
-H "Authorization: $NFEIO_API_KEY" -o nfse.xml