Observability API

Disponibilidade: taxa de sucesso por endpoint crítico.
Latência: p95/p99 de operações de checkout, webhooks e fiscal.
Backlog: eventos/documentos pendentes por organização.
Qualidade: taxa de retries, erros por tipo e tempo médio de recuperação.

Endpoints de health, métricas e alertas para operação contínua.

reference • updated 2026-03-15

Objetivo

Dar visibilidade operacional sobre saúde da plataforma, desempenho fiscal e condições de alerta para resposta rápida a incidentes.

Endpoint	Utilização	Cadência recomendada
`GET /v1/health`	estado global e disponibilidade	checks contínuos (30s-60s)
`GET /v1/metrics/fiscal`	métricas de emissão/reconciliação	dashboards e revisões horárias
`POST /v1/alerts`	criação/disparo de alertas operacionais	quando limiares são ultrapassados

bash

curl -X GET https://api.beacon.pt/v1/health \
  -H "Authorization: Bearer <access_token>"

json

{
  "ok": true,
  "timestamp": "2026-03-15T10:15:00Z",
  "services": {
    "billing": "up",
    "webhooks": "up",
    "fiscal": "up"
  }
}