API Reference
Referência funcional por domínios da API pública Beacon.
reference • updated 2026-03-15
Como usar esta referência
A referência está organizada por domínio funcional para reduzir tempo de descoberta e facilitar ownership por equipa.
Grupos de endpoints
- Billing API: subscrições, checkout e portal de cliente.
- Stripe Connect API: onboarding de contas e ciclos de refresh.
- Webhooks API: ingestão de eventos, validação de assinatura e replay.
- Fiscal API: documentos, reconciliação e estado de configuração.
- Observability API: saúde, métricas e alertas operacionais.
Convenções globais
| Tema | Regra |
|---|---|
| Autenticação | Authorization: Bearer <access_token> |
| Idempotência | Idempotency-Key recomendada para operações mutáveis |
| Versionamento | Prefixo de rota com /v1 |
| Erros | Payload com code, message e request_id |
OpenAPI
Usa OpenAPI Spec para consumir o contrato parcial e preparar evolução para ferramentas como Scalar/Redoc.