Toda a régua de cobrança, disponível por API
API REST v1 para pessoas, cobranças, réguas, acordos, disputas, tarefas, templates e notificações. Autenticação por api-key, webhooks de saída assinados, OpenAPI e coleção Postman prontas para importar.
API Pública
80+
endpoints na API v1
25+
recursos disponíveis
HMAC
assinatura nos webhooks de saída
OpenAPI
especificação e Postman inclusos
Da api-key à automação completa em quatro passos
1
Gere sua api-key
Na área de desenvolvedores do painel, com controle e revogação por chave.
2
Integre os recursos
Os mesmos recursos da interface: criar cobranças, vincular réguas, consultar telemetria, abrir disputas, registrar acordos.
3
Assine os webhooks
Configure endpoints de saída para receber eventos, com segredo assinado e rotação.
4
Automatize
Seu ERP cria as cobranças; a régua cuida do resto.
Os mesmos recursos da interface, prontos para integrar
Recursos Completos
Pessoas, cobranças, réguas e etapas, classificações, templates, notificações, interações, tarefas, acordos e parcelas, disputas, negativações, protestos, importações e exportações.
- Mesmas regras de negócio da interface
- Máquinas de estado respeitadas na API
- Dashboard e métricas de recuperação por endpoint
Autenticação Dupla
Sessão para o painel, api-key para integrações servidor a servidor.
- Criação e revogação de chaves no painel
- Rastreio de origem por chave
- Escopo por workspace
Webhooks de Saída
Receba eventos da Régua de Cobrança no seu sistema, com assinatura verificável e rotação de segredo.
- Endpoints configuráveis por evento
- Rotação de segredo com um clique
- Histórico de entregas consultável
Ações de Domínio
Além do CRUD, endpoints de ação: notificar cobrança, aceitar e cancelar acordo, resolver disputa, completar tarefa, reclassificar pessoa, emitir link do portal.
- POST /v1/charges/{id}/notify
- POST /v1/agreements/{id}/accept
- POST /v1/people/{id}/portal-link
Auditoria pela API
Logs de auditoria consultáveis por endpoint — a mesma trilha imutável da interface, integrável ao seu SIEM ou BI.
- Filtros por entidade e ator
- Antes/depois em cada registro
- Append-only garantido pelo banco
Importação e Exportação
Importe carteiras por arquivo, exporte qualquer recurso e acompanhe os jobs de processamento.
- Importação idempotente
- Exportação assíncrona com download
- Status do job consultável
Integre em minutos
Exemplo de criação de cobrança via API:
# Criar uma cobrança
curl -X POST https://app.dunning.kobana.com.br/api/v1/charges \
-H "Authorization: Bearer SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"person_id": "per_123",
"amount": 450.00,
"due_date": "2026-08-15",
"collection_rule_id": "rule_456"
}'
Webhooks de saída: endpoints configuráveis com histórico de entregas e rotação de segredo.
Perguntas frequentes
Integre seu sistema à régua
Fale com a gente para receber acesso à documentação interativa e uma chave de teste.