Documentação da API

Visão geral e arquitetura

Como o servidor do cliente, o BFF e os serviços de carteira e jogos se relacionam ao usar a API pública do BetBackoffice.

A API pública do BetBackoffice permite que a operadora construa a própria experiência do jogador (o front do cliente) e use o BetBackoffice como retaguarda de cadastro, KYC, carteira, depósitos, saques e sessões de jogo.

Arquitetura de referência

Navegador do jogador
        │  (apenas sessão da própria operadora)
        ▼
Servidor do cliente / BFF  ── chamadas assinadas (HMAC) ──▶  API pública do BetBackoffice (/api/v1)
        │                                                          │
        │  ◀── webhooks assinados (eventos) ───────────────────────┤
        │                                                          ▼
        └── abre a gameUrl ◀── sessão de jogo ── Game Provider ◀── Wallet API
  • Navegador: nunca recebe chaves nem assina requisições. Recebe apenas dados já filtrados pelo seu servidor.
  • Servidor do cliente (BFF): guarda os segredos, assina cada chamada, cuida do login do jogador e do meio de pagamento.
  • BetBackoffice: fonte de verdade de cadastro, KYC, carteira, depósitos e saques.
  • Game Provider: fonte de verdade do estado do jogo; você recebe apenas a gameUrl para abrir o jogo.

O que a API cobre

Recurso Operações
Jogadores cadastrar, consultar por id ou por externalId
Carteira saldo, valor disponível para saque e extrato paginado
KYC consultar situação e registrar o envio de um documento
Depósitos criar (pendente), confirmar ou marcar como não concretizado
Saques solicitar, consultar e cancelar antes da aprovação
Jogos catálogo e criação de sessão de jogo
Webhooks eventos de saída e envio de teste
Sandbox rotas que simulam a decisão da equipe (KYC e saque) para você testar sozinho

O que a API não faz

  • Não é chamada diretamente do navegador.
  • Não autentica o jogador: o login (e a senha) são do seu front.
  • Não processa pagamentos: o meio de pagamento é seu; a API só registra o depósito depois que você confirma o recebimento.
  • Nesta versão não recebe o arquivo do documento de KYC (você guarda o arquivo e informa uma referência).
  • Não expõe dados de outros operadores: toda credencial é escopada ao seu operador e à sua marca.

Próximos passos

  1. Primeiros passos (15 minutos)
  2. Onboarding e credenciais
  3. Sandbox
  4. Autenticação HMAC
  5. Referência da API e ferramentas