Pular para conteúdo

API REST — contrato público

Status: Aprovado · Responsável: Gustavo Madruga · Atualizado em: 2026-08-25

Referência pública da API do central-backend: endpoints, corpo das requisições, respostas. O spec é gerado do código a cada build de docs (o micronaut-openapi emite o OpenAPI a partir dos controllers ao compilar) — é a fonte da verdade sobre o que este app expõe. Para experimentar ao vivo, o app também serve /swagger-ui em runtime; a fonte publicada é esta página.

Quem integra com o central (ex.: a skill /xadm-setup chamando POST /api/setup/provision no build-time de um app) linka esta página para ler o shape — em vez de re-digitar o contrato (decisão 0020).

Como autenticar

As superfícies M2M usam Authorization: Bearer <token> (o /api/setup/** usa o token de serviço do broker; o /api/admin/** aceita o CENTRAL_INTEGRATOR_TOKEN ou o JWT admin). Detalhe por rota no spec abaixo. Tokens nunca são publicados aqui.

O contrato