Documentação da API do FazNota
API REST para emissão e gestão de Nota Fiscal Eletrônica (NFe, NFCe, NFSe), notas de fornecedor, clientes e produtos. Escolha a versão da documentação abaixo.
Escolha a versão
API v3 — Recomendada ✅ Versão atual e recomendada. Envelope de resposta padronizado, request-id para suporte, headers de rate limit, reconhecimento de nota de fornecedor, NFSe completa e paginação por query string. Comece por aqui.
API v2 — Deprecated ⚠️ Documentação de referência para quem ainda está na v2. Será desligada em 31/12/2026. Consulte a página de migração para mover sua integração para a v3.
Qual versão usar?
- Nova integração: use a v3. Não comece nada novo na v2.
- Já integrado na v2: planeje a migração para a v3 ainda em 2026. Veja o guia Migrar para a v3.
- Ambas as versões cobrem NFe, NFCe, NFSe, clientes e produtos, com o mesmo fluxo assíncrono (emissão → recibo → polling). A v3 adiciona recursos, padroniza o contrato e melhora observabilidade e segurança.
Principais diferenças e melhorias da v3
A tabela abaixo resume o que muda da v2 para a v3 — para você avaliar o esforço e o ganho da migração.
| Aspecto | v2 (deprecated) | v3 (recomendada) |
|---|---|---|
| Envelope de resposta | JSON ad-hoc, formato diferente por endpoint (ex.: {recibo, status, sefaz}) | Padronizado: { status, descricao, data, meta } em todos os endpoints |
| Rastreabilidade (suporte) | Sem identificador de requisição | meta.request_id + header X-Request-Id em toda resposta (inclusive erros) — facilita o suporte correlacionar sua chamada |
| Rate limit | Sem visibilidade — você só descobre ao tomar 429 | Headers X-RateLimit-Limit / Remaining / Reset em toda resposta |
| Reconhecimento de nota de fornecedor | Não existe | Novo: /nffornecedor (reconhecer e consultar notas de entrada) |
| NFSe | Apenas emissão (POST /nfse/emissao) | Completa: listar, consultar por recibo, editar e cancelar |
| Paginação | Só por path: /paginacao/{pagina}/{quantidade} | Query string ?page=&page_size= (mais ergonômica), mantendo o path legado |
| Autenticação | Authorization: Token (aceita Bearer) | Igual — Authorization: Token como forma canônica |
| Consistência de erros | Mistura {"erro": "..."} e {"error": {...}} conforme a origem | Envelope de erro uniforme com status de um conjunto fixo |
| Segurança / robustez | Endurecida, mas com queries de busca concatenadas | Queries de busca parametrizadas, erro sanitizado no retorno |
Contato
- 📧 Suporte técnico: [email protected]
- 🌐 Site institucional: myse.com.br