Skip to main content

Migrar do eNotas

Migre do eNotas para a Engine API mantendo sua operação ativa. A Engine API é compatível com os mesmos conceitos — a diferença está na estrutura de payload e autenticação. Tempo estimado de migração: 2–4 horas de desenvolvimento

Diferenças Principais

AspectoeNotasEngine API
AutenticaçãoAuthorization: ApiKey {key}Authorization: Bearer {jwt} ou x-api-key: {key}
Multi-tenancyEmpresa no URLissuerId no body
NotificaçõesCallbacks por requestWebhooks configuráveis
Formato de respostaPróprioJSON padronizado
AmbienteHeader X-AmbienteCampo environment na empresa

Mapeamento de Endpoints

eNotasEngine APINotas
POST /empresas/{id}/nfesPOST /nfe/emitirissuerId vai no body
GET /empresas/{id}/nfes/{nfeId}GET /nfe/{id}
GET /empresas/{id}/nfesGET /nfe
POST /empresas/{id}/nfes/{nfeId}/cancelarPOST /nfe/{id}/cancelar
POST /empresas/{id}/nfes/{nfeId}/carta-correcaoPOST /nfe/{id}/carta-correcao
GET /empresas/{id}/nfes/{nfeId}/xmlGET /nfe/{id}/xml
GET /empresas/{id}/nfes/{nfeId}/pdfGET /nfe/{id}/pdf
POST /empresasPOST /companies
POST /empresas/{id}/certificadoPOST /companies/{id}/certificateMultipart/form-data

Mapeamento de Campos

Emitente

Campo eNotasCampo Engine APINotas
empresa_id (URL)issuerId (body)UUID retornado em POST /companies

Destinatário

Campo eNotasCampo Engine APINotas
cnpj_cpfcnpj ou cpfCampos separados na Engine API
razao_socialnome
indicador_inscricao_estadualindicadorIE1, 2 ou 9
endereco.codigo_municipioendereco.codigoMunicipioMesmo código IBGE

Item

Campo eNotasCampo Engine APINotas
item_numeronumero
codigo_produtocodigo
descricaodescricao
codigo_ncmncm
cfopcfop
unidade_comercialunidade
quantidade_comercialquantidade
valor_unitario_comercialvalorUnitario
valor_total_brutovalorTotal

Gotchas — O que é diferente

O eNotas usa API Key no header Authorization. A Engine API aceita JWT Bearer (via login) ou API Key no header x-api-key. Não misture os dois formatos.
No eNotas, a empresa vai na URL (/empresas/{id}/nfes). Na Engine API, o issuerId é um campo dentro do body do JSON.
O eNotas usa callbacks por polling ou por URL de callback. A Engine API usa webhooks com payload padronizado e verificação HMAC. Configure em POST /webhooks.
O eNotas retorna ref como identificador. A Engine API retorna id (UUID) e accessKey (chave de acesso de 44 dígitos) diretamente.

Checklist de Migração

1

Criar conta na Engine API

Registre-se em app.engineapi.com.br.
2

Cadastrar empresas emissoras

POST /companies para cada CNPJ que emite notas.
3

Fazer upload dos certificados

POST /companies/{issuerId}/certificate com o .pfx de cada empresa.
4

Testar em homologação

Configure environment: 2 nas empresas e emita notas de teste.
5

Adaptar a integração

Ajuste os campos do payload conforme a tabela de mapeamento acima.
6

Configurar webhooks

POST /webhooks com os eventos que precisa receber.
7

Migrar para produção

Mude environment: 1 nas empresas e aponte sua aplicação para a Engine API.

Próximos passos

Autenticação

JWT e API Keys explicados

Webhooks

Configurar notificações em tempo real