Integrações
Uma API para a sua operação, não só uma tela
Tudo o que importa na carteira está disponível por API: clientes, envios, achados, mensagens e métricas. Eventos chegam ao seu sistema por webhooks assinados.
Escopos das chaves de API
- read
- Leitura de clientes, envios, documentos, achados, carteira, simulações, mensagens e métricas. Geração e download das fichas de correção.
- uploads:write
- Envio de XML e ZIP por URL pré-assinada.
- clients:write
- Cadastro, edição e importação de clientes.
- messages:write
- Rascunho, aprovação e registro de aviso ao cliente. Links de leitura da ficha de correção e rascunho com o link.
- webhooks:manage
- Cadastro e gestão dos endpoints de webhook.
curl -s "$ARCONTA_API/v1/findings?clientId=$CLIENT_ID&limit=100" \
-H "Authorization: Bearer $ARCONTA_KEY"curl -s -X POST "$ARCONTA_API/v1/correction-sheets" \
-H "Authorization: Bearer $ARCONTA_KEY" \
-H "Content-Type: application/json" \
-d '{"clientId":"'"$CLIENT_ID"'","period":"2026-10"}'Eventos de webhook
- upload.completed
- Um envio terminou de ser processado.
- document.processed
- Uma nota foi validada.
- finding.created
- A validação de uma nota gerou achados.
- message.approved
- Um rascunho de mensagem foi aprovado.
- client.notified
- O contador registrou que avisou o cliente.
- simulation.saved
- Uma simulação foi salva.
{
"id": "5d3f0c8a-2b1e-4c7d-9a6f-1e2d3c4b5a69",
"type": "finding.created",
"createdAt": "2026-10-30T14:05:12.000Z",
"tenantId": "8a4b2c1d-3e5f-4a6b-8c7d-9e0f1a2b3c4d",
"apiVersion": "1.15.0",
"data": {
"documentId": "6f1c2a9e-7b3d-4e5f-8a9b-0c1d2e3f4a5b",
"client": {
"id": "0b7d4e21-9c8b-4a7d-8e6f-5a4b3c2d1e0f",
"cnpjMasked": "11.***.***/****-81"
},
"findings": [
{
"id": "c2e4a6b8-1d3f-4a5b-9c7e-2f4a6b8c0d1e",
"ruleId": "NFE-UB56-10",
"severity": "critical",
"rejectionCode": "1037"
}
]
}
}A referência completa da API fica em /docs no endereço da API, gerada do mesmo contrato OpenAPI usado pelo produto.
Sua carteira inteira, sob controle.
Receba o XML, confira a orientação e envie o feedback. Comece com um cliente e acompanhe o fluxo completo.