Referência API
OpenAPI 0.5.0 curada para a superfície de portefólio.
Âmbito do contrato publicado
OpenAPI v0.5.0 curada· parcialmente implementado
- Descarregar openapi.yaml
Servido a partir da pasta public do Next.js
Convenções
- Base path: /api/v1 via gateway same-origin
- Portais SPA: sessão cookie Sanctum + CSRF
- Integrações: bearer + headers HMAC (ver Autenticação de integração)
- Dinheiro: minor units inteiros; sem montantes float nos contratos
- Correlação: X-Correlation-Id nas respostas quando presente
Grupos no OpenAPI
| Tag | Exemplos |
|---|---|
| Health | GET /api/v1/health |
| Auth | login, MFA verify |
| Integration | POST /api/v1/integration/events |
| Portal | balances, payout requests, branding |
| Admin | branding, payout approve/mark-paid, rule deactivate |