Referência da API

A engineAPI expõe endpoints REST organizados por módulo, todos sob o prefixo /v1. Importe a especificação OpenAPI no Postman, Insomnia ou Hoppscotch para testar cada endpoint com seu token. Base URL: https://api.engineapi.com.br (todo path desta doc já inclui o /v1)

Testar os endpoints

Importe o OpenAPI direto na sua ferramenta de API testing:

https://api.engineapi.com.br/api-docs-json

Todos os endpoints aparecem organizados por módulo, com parâmetros e responses tipados (o mesmo caminho usado em Integração com IA).

Obtenha seu token

curl -X POST https://api.engineapi.com.br/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{ "email": "dev@minhaempresa.com", "password": "suaSenha" }'

Copie o access_token da resposta

{ "data": { "access_token": "eyJhbGciOiJIUzI1NiIs...", "user": { "...": "..." } } }

Use o token nas suas requisições

Envie o token no header Authorization: Bearer {token} (dashboard) ou use uma API Key com x-api-key para integrações server-to-server.

Módulos

NFe

Emissão, cancelamento, carta de correção, inutilização, consulta, download XML/PDF, lote/fila

NFCe

Emissão, cancelamento, inutilização, consulta, download HTML/XML

NFSe

Emissão, cancelamento, consulta na SEFIN, download XML/PDF

MDFe / CTe

Implementados no motor, fora da superfície pública documentada hoje

Empresas

CRUD de emissores, upload de certificado, consulta de CNPJ

Webhooks

Configuração (URL + eventos), secret HMAC, logs de entrega, DLQ

Admin

Acesso restrito (SUPERADMIN): provisionamento de parceiros, planos

Rate Limits

Os limites são por partner (todas as suas chaves compartilham o mesmo orçamento) e a tabela completa por plano vive em Rate Limits, fonte única, não duplicada aqui.

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/v1/nfe \
  -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, inclusive para rejeições (400 com error.erros[]), que são replays determinísticos sem retransmitir à SEFAZ. Use um ID único por nota (ex: pedido-{id}-nfe-{numero}).

Versionamento

A engineAPI 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`)

A versão atual é v1: todo endpoint desta API vive sob /v1, sem exceção.

Ambiente de Homologação

Todo emissor (Issuer) nasce em homologação (ambienteFiscal: 2). O endpoint da API é sempre o mesmo:

https://api.engineapi.com.br

Veja o guia de Sandbox para o estado real da promoção pra produção.

Próximos passos

Os endpoints completos (navegáveis por operação, gerados direto do contrato real) estão no grupo Endpoints desta mesma aba, no menu lateral.

Catálogo de campos: NFe

Todo campo do payload de emissão, navegável por grupo, gerado do schema real

Catálogo de campos: NFCe

Todo campo do payload de emissão, navegável por grupo, gerado do schema real

Catálogo de campos: NFSe

Todo campo do payload de emissão, navegável por grupo, gerado do schema real

SDKs

Integre com TypeScript, Python ou PHP em minutos

Autenticação

JWT e API Keys explicados em detalhes

​Testar os endpoints

​Módulos

NFe

NFCe

NFSe

MDFe / CTe

Empresas

Webhooks

Admin

​Rate Limits

​Idempotência

​Versionamento

​Ambiente de Homologação

​Próximos passos

Catálogo de campos: NFe

Catálogo de campos: NFCe

Catálogo de campos: NFSe

SDKs

Autenticação

Testar os endpoints

Módulos

Rate Limits

Idempotência

Versionamento

Ambiente de Homologação

Próximos passos