overview
title: API Reference description: Referência completa dos endpoints da Engine API: autenticação, rate limits, idempotência e módulos disponíveis.
API Reference
A Engine API expõe endpoints REST organizados por módulo. Use o playground interativo ao lado de cada endpoint para testar em tempo real com seu token.
Base URL: https://api.engineapi.com.br
Autenticação no Playground
Para usar o playground, clique em "Authorize" no topo da página de referência e insira seu token:
Obtenha seu token
curl -X POST https://api.engineapi.com.br/auth/login \
-H "Content-Type: application/json" \
-d '{ "email": "SEU_EMAIL", "password": "SUA_SENHA" }'
Copie o campo token da resposta
{ "token": "eyJhbGciOiJIUzI1NiIs..." }
Cole no campo Bearer Token do playground
No topo da página de referência, clique em "Authorize" e cole o token.
Módulos
NFe
8 endpoints: emissão, cancelamento, carta de correção, consulta, download XML/PDF, emissão em lote
NFCe
4 endpoints: emissão, cancelamento, consulta, download
NFSe
5 endpoints: emissão, cancelamento, consulta, download, consulta por período
MDFe
🗓 Roadmap — sem previsão de data
CTe
🗓 Roadmap — sem previsão de data
Empresas
6 endpoints: CRUD de emissores, upload de certificado, status de certificado
Webhooks
4 endpoints: criar, listar, atualizar, remover webhook
Queries
3 endpoints: consulta CNPJ, CPF e status SEFAZ por UF
Admin
Acesso restrito: gestão de parceiros, planos, logs de auditoria
Rate Limits
Os limites são aplicados por token de acesso e reiniciam a cada minuto:
| Plano | Requests/min | Requests/dia | Notas simultâneas | |-------|-------------|-------------|-------------------| | Dev | 5 | 100 | 1 | | Starter | 60 | 1.000 | 5 | | Growth | 300 | 10.000 | 20 | | Scale | 600 | Ilimitado | 50 | | Enterprise | Customizado | Customizado | Ilimitado |
Quando o limite é excedido, a API retorna 429 com o header:
Retry-After: 45
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1714176000
Idempotência
Para operações críticas (emissão de notas), use o header Idempotency-Key para garantir que a nota só seja emitida uma vez, mesmo que a requisição seja repetida por retry:
curl -X POST https://api.engineapi.com.br/nfe/emitir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-12345-nfe-1" \
-d '{ ... }'
Se a mesma Idempotency-Key for usada novamente em até 24 horas, a API retorna o resultado original sem reprocessar. Use um ID único por nota (ex: pedido-{id}-nfe-{numero}.
Versionamento
A Engine API segue Semantic Versioning para breaking changes:
| Tipo de mudança | Como é tratado |
|----------------|----------------|
| Novos campos opcionais | Retro-compatível |
| Novos endpoints | Retro-compatível |
| Remoção de campos | Aviso com 6 meses de antecedência |
| Breaking changes | Nova versão no path (ex: /v2/nfe/emitir) |
A versão atual é v1. O path /nfe/emitir equivale a /v1/nfe/emitir.
Ambiente de Homologação
Use "environment": 2 no cadastro da empresa emissora para transmitir ao SEFAZ de teste. O endpoint da API é sempre o mesmo:
https://api.engineapi.com.br
Veja o guia de Sandbox para instruções completas.