Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.engineapi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
FAQ

Respostas para as dúvidas mais comuns de parceiros e desenvolvedores.

​
Certificados

Nao. A Engine API trabalha exclusivamente com certificados A1 (arquivo .pfx/.p12). O certificado A3 (token USB/cartao) nao e compativel com APIs cloud por exigir interacao fisica com o dispositivo.Se seu cliente usa A3, ele precisara adquirir um certificado A1 junto a uma Autoridade Certificadora (AC) como Certisign, Serasa ou SafeWeb.
Arquivo .pfx ou .p12 com senha. O upload e feito via endpoint:
POST /v1/companies/:id/certificate
O certificado e encriptado em repouso com AES-256.
As emissoes passam a retornar erro 422 com mensagem da SEFAZ indicando certificado invalido. Recomendamos:
  • Monitorar a validade via GET /v1/companies/:id
  • Configurar webhook para alertas de vencimento proximo
  • Renovar com antecedencia de 30 dias
Sim, mas nao recomendamos. O ideal e usar certificados de teste (alguns ACs emitem gratuitamente para homologacao) no ambiente sandbox e reservar o certificado de producao para emissoes reais.

​
NFSe

Depende. A NFSe nao e padronizada nacionalmente. Cada municipio implementa seu proprio webservice. A Engine API suporta municipios que seguem o padrao ABRASF (maioria das capitais e grandes cidades).Consulte o suporte para verificar se o municipio do seu cliente e suportado.
O codigo segue a Lista de Servicos da LC 116/2003. Exemplos comuns:
  • 01.07: Suporte tecnico em informatica
  • 01.01: Analise e desenvolvimento de sistemas
  • 17.01: Assessoria e consultoria
O seu cliente/contador sabe qual codigo se aplica.
Sim. Cada municipio define suas aliquotas. Geralmente variam entre 2% e 5%. A Engine API nao calcula o ISS automaticamente. Voce precisa informar a aliquota correta no payload.

​
Planos e precos

PlanoIssuersEmissoes/mesPreco
Starter5500Consulte
Professional505.000Consulte
EnterpriseIlimitadoIlimitadoSob medida
Entre em contato pelo Dashboard para detalhes de precos.
Sim. Voce pode usar o ambiente de homologacao (sandbox) gratuitamente para testar todas as funcionalidades. As notas emitidas em homologacao nao tem validade fiscal e nao sao cobradas.
Depende do plano. O plano Starter e Professional tem limite mensal de emissoes incluidas. Acima do limite, valores adicionais podem ser aplicados.

​
Integracao tecnica

Sim. O SDK TypeScript e oficial e esta publicado no npm:
npm install @engineapi/sdk
SDKs para Python e PHP estao em desenvolvimento. Enquanto isso, voce pode integrar diretamente via REST com qualquer HTTP client.
Nao. O certificado digital A1 e obrigatorio para assinar os documentos fiscais junto a SEFAZ. Sem ele, nenhuma emissao (NFe, NFCe, CTe, MDFe) e possivel.Excecao: Boletos nao exigem certificado digital — apenas conta bancaria cadastrada.
Todas as respostas seguem o formato padrao:
{
  "success": true,
  "data": { ... },
  "message": "Operacao realizada com sucesso"
}
Em caso de erro:
{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "Rejeicao SEFAZ",
  "sefazCode": "539",
  "sefazMessage": "Duplicidade de NF-e"
}
Sim. A Engine API e AI-Ready. A primeira API fiscal do Brasil com suporte nativo a agentes de IA. Veja o guia AI-Ready API para detalhes.

​
Operacional

O SLA da Engine API e de 99.9% de disponibilidade. O uptime real pode ser acompanhado em tempo real na pagina de status.A SEFAZ, porem, tem manutencoes programadas (geralmente domingos a noite). Nesses periodos, emissoes podem falhar com erro 503. A API retorna automaticamente quando o servico volta.
A Engine API retorna erro 503 Service Unavailable com a mensagem da SEFAZ. Recomendamos:
  1. Implementar retry com backoff (ver Rate Limits)
  2. Monitorar o status do SEFAZ via GET /v1/nfe/status
  3. Informar o usuario final que o servico esta temporariamente indisponivel
Sim. Voce pode configurar webhooks para receber notificacoes em tempo real sobre:
  • NFe autorizada, cancelada ou rejeitada
  • Boleto pago, vencido ou cancelado
  • DFe novos documentos recebidos
  • Certificado proximo do vencimento
Veja o guia Webhooks para configuracao completa.

​
Suporte

Email

suporte@engineapi.com.br. Resposta em ate 4 horas uteis

Dashboard

Chat integrado no Dashboard