Quick Start
Da API Key à primeira NF-e autorizada em 4 passos.
Emita sua primeira NF-e em 4 passos. A autorização na SEFAZ é assíncrona: você cria o rascunho, enfileira o envio e recebe um webhook (recomendado) — ou faz polling a cada 3–5 s até o status terminal.
- 1 · API Key
- 2 · Cliente
- 3 · Criar NF-e
- 4 · Send + poll
No cadastro (Criar conta) ou via POST /v1/companies, a API Key é exibida uma única vez. Guarde com segurança.
Pode cadastrar o cliente antes ou enviar destinatario direto no POST /v1/nfe. O cMun pode vir no payload ou ser resolvido (UF+cidade / CEP) na base IBGE local.
| Operação | Método e Rota | Referência Técnica |
|---|---|---|
| Cadastrar Cliente | POST /v1/customers | Ver Parâmetros → |
Modo smart: informe destinatarioId ou destinatario inline, e fiscalProfileId no item. O número da nota é reservado na hora.
Compatibilidade: aliases customerId e customer continuam aceitos normalmente.
| Operação | Método e Rota | Referência Técnica |
|---|---|---|
| Criar NF-e | POST /v1/nfe | Ver Parâmetros & Presets → |
POST /v1/nfe/:id/send responde 202 e Preferência: cadastre um webhook. Sem webhook, faça polling em GET /v1/nfe/:id a cada 3–5 s até sair de processando (não menos que 3 s — rate limit da API).
| Operação | Método e Rota | Referência Técnica |
|---|---|---|
| Transmitir à SEFAZ | POST /v1/nfe/:id/send | Ver Envio → |
| Consultar Status | GET /v1/nfe/:id | Ver Retorno → |