API Sacador
Documentação para integradores que vão consumir a API e/ou receber webhooks do Sacador.
| Tópico | O que cobre |
|---|---|
| Autenticação | Como criar tokens de API, formato (sct_…), envio em requisições e revogação |
| Convenções | URL base, versionamento, content type, status codes, paginação, rate limit, formato de erro e regras de multi-tenancy comuns a todos os endpoints |
| Cobranças | GET/POST/PATCH/DELETE /v1/billings + cancel e pay_off — campos, validações, edibilidade, itens com destruição implícita |
| Boletos bancários | GET/v1/billings/:billing_id/bank_billets — somente leitura. Campos do boleto registrado no banco (barcode, linha digitável, Pix), status, snapshots de pagador/beneficiário |
| Contatos | GET/POST/PATCH/DELETE /v1/contacts — PF vs PJ, normalização aplicada, filtros e busca |
| Grupos | GET/POST/PATCH/DELETE /v1/groups — recurso de classificação de contatos e cobranças em massa |
| Webhooks | Headers enviados, esquema de assinatura HMAC-SHA256 e exemplos de validação em Ruby, Node, Python e PHP |
Onde gerenciar credenciais
Tokens de API e endpoints de webhook são gerenciados em /integrations, na aba API e Webhook. Cada conta pode ter múltiplos tokens nomeados e até 3 URLs de webhook (cada uma com seu próprio secret de assinatura).