Diferenças principais
Mapeamento de endpoints
Mapeamento de campos
NF-e (productinvoices → nfe)
Diferenças importantes
Empresa sai da URL e vai para o body
Empresa sai da URL e vai para o body
O NFe.io coloca
companyId na URL: /v1/companies/{companyId}/productinvoices. Na engineAPI, o identificador da empresa é o campo issuerId dentro do JSON do body.Cancelamento muda de método HTTP
Cancelamento muda de método HTTP
NFe.io:
DELETE /v1/companies/{id}/productinvoices/{inv}. engineAPI: POST /v1/nfe/{idOuChave}/cancelar com o campo obrigatório justificativa (mínimo 15 caracteres). motivo é o nome do campo em NFS-e, não em NF-e.Terminologia diferente
Terminologia diferente
NFe.io usa
productinvoices para NF-e e serviceinvoices para NFS-e. A engineAPI usa os módulos /nfe e /nfse diretamente.Webhooks são globais, não por empresa
Webhooks são globais, não por empresa
No NFe.io, os webhooks são configurados por empresa. Na engineAPI, um webhook recebe eventos de todas as empresas do seu token. Filtre pelo
issuerId no payload.Checklist de migração
1
Criar conta na engineAPI
Registre-se em app.engineapi.com.br.
2
Cadastrar empresas emissoras
POST /v1/companies para cada CNPJ. Guarde os id retornados.3
Upload dos certificados
POST /v1/companies/{issuerId}/certificate para cada empresa.4
Testar em homologação
Todo emissor novo já nasce em homologação (
ambienteFiscal: 2). Emita notas de teste e valide os campos mapeados, sem precisar configurar nada.5
Adaptar endpoints
Remova
companyId da URL e mova para issuerId no body.6
Configurar webhooks globais
Um webhook global recebe eventos de todas as empresas. Filtre por
issuerId.7
Migrar para produção
Promover o emissor para produção é self-service, ver Sandbox.
Próximos passos
- Autenticação: JWT e API Keys da engineAPI.
- Webhooks: filtrar eventos por empresa emissora.