Documentação da API

Changelog e política de versões

Como a API é versionada, como avisamos mudanças e onde acompanhar o histórico de versões.

Política de versões

  • A versão principal aparece no caminho (/api/v1); a versão completa (1.0.0) consta em info.version da especificação e em apiVersion nos webhooks.
  • Mudanças compatíveis (novos campos, novos endpoints, novos eventos) entram na mesma versão principal — por isso os clientes devem ignorar campos desconhecidos.
  • Mudanças incompatíveis só ocorrem em nova versão principal, com período de convivência e aviso prévio.

Onde acompanhar

  • O histórico completo, por versão, está em GET /api/v1/changelog.
  • A versão da especificação exibida na referência é a fixada neste site; o seletor de versão do portal lista as versões disponíveis.
  • O histórico de mudanças é publicado pela própria API em GET /api/v1/changelog (Markdown, sem autenticação) e acompanha cada versão da especificação.
  • A especificação completa está em GET /api/v1/openapi.json.

Versão atual

1.1.0

  • Sandbox isolado por marca (br-sandbox) e rotas de decisão de KYC e de saque exclusivas de sandbox.
  • Documentação e testador assinado em GET /api/v1/docs; coleção Postman, snippets e vetores de teste públicos.
  • OpenAPI com exemplos reais e code samples assinados; GET /me informa o ambiente.

1.0.0 — primeira versão: autenticação HMAC por operador, idempotência, jogadores, carteira, KYC, depósitos, saques, catálogo e sessão de jogo, webhooks e OpenAPI.