ACBrAPI¶
O adaptador ACBrAPI reproduz o contrato do provedor: os mesmos caminhos, os mesmos corpos e os mesmos códigos. Migrar é trocar o endereço base e a credencial.
Estas páginas cobrem apenas o que muda. Tudo o que é idêntico continua descrito na documentação do próprio ACBrAPI. Não reescrevemos nada disso de propósito. Duplicado aqui, o texto divergiria do original com o tempo, e você teria duas fontes discordando sobre a mesma rota.
- Guia de migração — para onde apontar, como autenticar e um
curlde emissão, consulta e cancelamento, do começo ao fim. - Compatibilidade — o que o adaptador aceita, o que ele recusa e onde ele diverge do provedor, item a item.
- Referência — contrato completo, gerado a partir do código.
Superfície atendida¶
| Rota | O que faz |
|---|---|
POST /realms/ACBrAPI/protocol/openid-connect/token |
Emite o Bearer (client_credentials) |
POST /nfce |
Emite um documento |
GET /nfce/{id} |
Consulta pelo id gerado por nós |
GET /nfce |
Lista, com os filtros e a paginação do provedor |
POST /nfce/{id}/cancelamento |
Cancela |
GET /nfce/{id}/cancelamento |
Lê o evento de cancelamento |
POST /nfce/inutilizacoes |
Inutiliza uma faixa de numeração |
GET /nfce/inutilizacoes/{id} |
Lê o evento de inutilização |
GET /nfce/{id}/xml |
XML processado (nfeProc) |
GET /nfce/{id}/xml/nota |
Só a NFe |
GET /nfce/{id}/xml/protocolo |
Só o protNFe |
O que não está nesta lista não está implementado nesta versão. Lotes, prévia, ESC/POS, e-mail, sincronização, status do serviço SEFAZ e a API de empresas estão detalhados, com o motivo, na página de compatibilidade.
Diferenças que mais afetam código existente¶
- Sem webhooks. O provedor não tem, e nós também não. O acompanhamento é por consulta. Como a nossa emissão é síncrona, a primeira consulta já encontra o documento resolvido.
- Numeração. Por padrão o número é nosso, e
ide.nNFé ignorado. Se o seu sistema é o dono da numeração, peça a credencial na faixa de numeração pelo cliente. Nesse caso,nNFpassa a ser obrigatório. Ver Numeração. - IBS/CBS obrigatório. Todo item precisa do grupo
imposto.IBSCBS. Sem ele, a SEFAZ rejeita. Ver Validação. - Subconjunto estrito. Grupos fora do subconjunto suportado são recusados pelo nome, não ignorados.