API REST — contrato público¶
Status: Aprovado · Responsável: Gustavo Madruga · Atualizado em: 2026-07-16
Esta é a referência pública da API do integrador: 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 contra uma instância, o app também serve /swagger-ui em runtime; a
fonte publicada é esta página.
Quem integra com o integrador linka esta página. Re-digitar o contrato do outro lado é o que produz o exemplo que mente: a cópia nasce certa e envelhece calada.
Como autenticar¶
As rotas /api/** exigem Authorization: Bearer <token>. O token é acordado por instalação
(há uma por cliente) e entregue por canal seguro — nunca publicado aqui.