Skip to main content

​
Migrar do Focus NFe

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

​
Diferenças Principais

AspectoFocus NFeEngine API
AutenticaçãoToken no header Authorization: Token {key}Bearer JWT ou x-api-key
Identificador da notaref (string livre)id (UUID gerado automaticamente)
Empresa no pedidoQuery param ref_emitente ou headerissuerId no body
WebhooksURL de callback por notaWebhooks configuráveis globalmente
AmbienteSubdomínio diferente (sandbox.)Campo environment na empresa

​
Mapeamento de Endpoints

Focus NFeEngine APINotas
POST /v2/nfePOST /nfe/emitirPayload diferente
GET /v2/nfe/{ref}GET /nfe/{id}ref → id UUID
DELETE /v2/nfe/{ref}POST /nfe/{id}/cancelarMétodo diferente
POST /v2/nfe/{ref}/carta_correcaoPOST /nfe/{id}/carta-correcao—
GET /v2/nfe/{ref}.xmlGET /nfe/{id}/xml—
GET /v2/nfe/{ref}.pdfGET /nfe/{id}/pdf—
GET /v2/nfce/{ref}GET /nfce/{id}—
POST /v2/nfsePOST /nfse/emitir—
POST /v2/emitentesPOST /companies—

​
Mapeamento de Campos (Emissão NFe)

​
Raiz

Campo Focus NFeCampo Engine APINotas
ref—Engine API gera o id automaticamente
natureza_operacaonaturezaOperacaocamelCase na Engine API
forma_pagamentopagamento.formaObjeto separado

​
Destinatário

Campo Focus NFeCampo Engine API
cnpj_destinatariodestinatario.cnpj
cpf_destinatariodestinatario.cpf
nome_destinatariodestinatario.nome
logradouro_destinatariodestinatario.endereco.logradouro
numero_destinatariodestinatario.endereco.numero
bairro_destinatariodestinatario.endereco.bairro
municipio_destinatariodestinatario.endereco.municipio
uf_destinatariodestinatario.endereco.uf
cep_destinatariodestinatario.endereco.cep
codigo_municipio_destinatariodestinatario.endereco.codigoMunicipio

​
Item

Campo Focus NFeCampo Engine API
numero_itemitens[].numero
codigo_produtoitens[].codigo
descricaoitens[].descricao
codigo_ncmitens[].ncm
cfopitens[].cfop
unidade_comercialitens[].unidade
quantidade_comercialitens[].quantidade
valor_unitario_comercialitens[].valorUnitario
valor_total_brutoitens[].valorTotal
origem_mercadoriaitens[].icms.origem
situacao_tributaria / csosnitens[].icms.cst / itens[].icms.csosn

​
Gotchas — O que é diferente

No Focus NFe, você define um ref livre para identificar a nota. Na Engine API, o id é um UUID gerado automaticamente no momento da emissão. Armazene-o no seu banco de dados.
Focus NFe: DELETE /v2/nfe/{ref}. Engine API: POST /nfe/{id}/cancelar com o campo motivo no body (texto de 15 a 255 caracteres).
Focus NFe usa sandbox.focusnfe.com.br. Na Engine API, o ambiente é o campo environment: 2 no cadastro da empresa — o endpoint é sempre api.engineapi.com.br.
O Focus NFe usa snake_case nos campos. A Engine API usa camelCase. Use a tabela de mapeamento acima como referência.

​
Checklist de Migração

1

Criar conta na Engine API

Registre-se em app.engineapi.com.br e gere sua API Key.
2

Cadastrar empresas emissoras

POST /companies para cada CNPJ. Guarde os id retornados (issuerId).
3

Upload dos certificados

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

Testar em homologação

Configure environment: 2 e emita notas de teste verificando os mapeamentos.
5

Adaptar payloads

Converta snake_case → camelCase e reorganize os campos conforme a tabela acima.
6

Configurar webhooks

Configure POST /webhooks em vez de callback por nota.
7

Migrar para produção

Mude environment: 1 e atualize a integração para usar a Engine API.
8

Desativar Focus NFe

Após validar a estabilidade por 1–2 semanas, cancele o plano no Focus NFe.

​
Próximos passos

Autenticação

JWT e API Keys da Engine API

Webhooks

Configurar notificações em tempo real