API Reference
Referencia funcional por dominios de la API pública de Beacon.
reference • updated 2026-03-15
Cómo usar esta referencia
La referencia está organizada por dominio funcional para reducir el tiempo de descubrimiento y facilitar ownership por equipo.
Grupos de endpoints
- Billing API: suscripciones, checkout y portal de cliente.
- Stripe Connect API: onboarding de cuentas y ciclos de refresh.
- Webhooks API: ingesta de eventos, validación de firma y replay.
- Fiscal API: documentos, conciliación y estado de configuración.
- Observability API: salud, métricas y alertas operacionales.
Convenciones globales
| Tema | Regla |
|---|---|
| Autenticación | Authorization: Bearer <access_token> |
| Idempotencia | Idempotency-Key recomendada en operaciones mutables |
| Versionado | Prefijo de ruta con /v1 |
| Errores | Payload con code, message y request_id |
OpenAPI
Usa OpenAPI spec para consumir el contrato parcial y preparar evolución para herramientas como Scalar/Redoc.