engineAPIengine·API

nfe-io


title: Migrar do NFe.io description: Guia de migração do NFe.io para Engine API: mapeamento de endpoints, campos e diferenças de comportamento.

Migrar do NFe.io

Tempo estimado de migração: 1–3 horas de desenvolvimento


Diferenças Principais

| Aspecto | NFe.io | Engine API | |---------|--------|-----------| | Autenticação | API Key no header Authorization | Bearer JWT ou x-api-key | | Estrutura de URL | /v1/companies/{companyId}/productinvoices/{id} | /nfe/{id} (sem empresa na URL) | | Empresa no pedido | companyId na URL | issuerId no body | | Tipo de nota | Separado por endpoint (productinvoices, serviceinvoices) | Separado por módulo (/nfe, /nfse) | | Webhooks | Configurados por empresa | Configurados globalmente |


Mapeamento de Endpoints

| NFe.io | Engine API | Notas | |--------|-----------|-------| | POST /v1/companies/{id}/productinvoices | POST /nfe/emitir | issuerId no body | | GET /v1/companies/{id}/productinvoices/{inv} | GET /nfe/{id} | — | | GET /v1/companies/{id}/productinvoices | GET /nfe | — | | DELETE /v1/companies/{id}/productinvoices/{inv} | POST /nfe/{id}/cancelar | Método diferente | | POST /v1/companies/{id}/serviceinvoices | POST /nfse/emitir | — | | GET /v1/companies/{id}/serviceinvoices/{inv} | GET /nfse/{id} | — | | DELETE /v1/companies/{id}/serviceinvoices/{inv} | POST /nfse/{id}/cancelar | — | | POST /v1/companies | POST /companies | — | | GET /v1/companies/{id} | GET /companies/{id} | — | | PUT /v1/companies/{id}/certificate | POST /companies/{id}/certificate | Multipart/form-data |


Mapeamento de Campos

NFe (productinvoices → nfe)

| Campo NFe.io | Campo Engine API | Notas | |-------------|-----------------|-------| | cityServiceCode | — | Não aplicável para NFe | | description | naturezaOperacao | — | | borrower.federalTaxNumber | destinatario.cnpj | — | | borrower.name | destinatario.nome | — | | borrower.address.street | destinatario.endereco.logradouro | — | | borrower.address.number | destinatario.endereco.numero | — | | borrower.address.district | destinatario.endereco.bairro | — | | borrower.address.city.code | destinatario.endereco.codigoMunicipio | Código IBGE | | borrower.address.city.name | destinatario.endereco.municipio | — | | borrower.address.state | destinatario.endereco.uf | — | | borrower.address.postalCode | destinatario.endereco.cep | — |


Diferenças importantes


Checklist de Migração

·

Criar conta na Engine API

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

·

Cadastrar empresas emissoras

POST /companies para cada CNPJ. Guarde os id retornados.

·

Upload dos certificados

POST /companies/{issuerId}/certificate para cada empresa.

·

Testar em homologação

Emita notas com environment: 2 e valide os campos mapeados.

·

Adaptar endpoints

Remova companyId da URL e mova para issuerId no body.

·

Configurar webhooks globais

Um webhook global recebe eventos de todas as empresas. Filtre por issuerId.

·

Migrar para produção

Mude environment: 1 e redirecione sua integração para a Engine API.


Próximos passos