Documentação da API
A API do O Meu Banco é servida em https://api.omeubanco.xyz e usa autenticação bearer para chamadas protegidas. Esta página reúne os links públicos necessários para descoberta por humanos e agentes.
Resumo rápido
Base URL: https://api.omeubanco.xyz
Formato principal: JSON sobre HTTPS.
Saúde: GET /health
OpenAPI: /docs/api/openapi.json
Autenticação
Os endpoints protegidos exigem Authorization: Bearer <token>. O token é emitido pelo backend após login de pais, responsáveis ou crianças.
O backend também publica metadados de protected resource em /.well-known/oauth-protected-resource para facilitar descoberta automatizada do recurso protegido.
A API ainda não expõe um authorization server OAuth/OIDC público e completo. Os fluxos atuais continuam sendo first-party e o bearer token é emitido pelo próprio backend após autenticação do usuário.
Grupos de endpoint
| Caminho | Descrição |
|---|---|
/health | Health check público do backend. |
/api/v1/auth/* | Autenticação da família, login infantil, Google OAuth e Passkeys. |
/api/v1/families/* | Dados da família e preferências principais. |
/api/v1/children/* | Cadastro de filhos, extrato, analytics, contratos, wishlist e agendamentos. |
/api/v1/invitations/* | Convites de responsáveis e aceite de convites. |
/api/v1/upload/* | Uploads de avatar, comprovantes e imagens da wishlist. |
/api/v1/subscription/* | Estado da assinatura e limites do plano. |
Endpoints de descoberta
/.well-known/api-catalog
Catálogo machine-readable com ponteiros para a OpenAPI, documentação humana e health check.
/docs/api/openapi.json
Descrição OpenAPI pública da API, útil para integração automatizada.
https://api.omeubanco.xyz/.well-known/oauth-protected-resource
Metadados do recurso protegido publicados pelo host da API para clientes OAuth-aware.
/.well-known/agent-skills/index.json
Índice de skills públicas para agentes que interagem com o site institucional.