Games API

Games API Reference - Operator API

Games API is the core API for using Bingão do Brasil. It allows Operators to request and receive the list of available games, one singular game URL as well as a game round. All the games provided via the API are provided and implemented by Bingão do Brasil.

Retrieves a list of all available games for the authenticated player.

post

Fetches all available games from BINGAO provider with detailed information including metadata, thumbnails, categories, and technical specifications.

Process Flow:

  1. Validate player session and authentication token

  2. Query available games from Room Manager service

  3. Retrieve game metadata and specifications

  4. Filter active and enabled games only

  5. Return comprehensive game catalog

Requirements:

  • Valid X-Player-Token header for authentication

  • Active player session

Game Code Format: All game codes follow the pattern: BINGAO_{roomId}

Sample request:

POST /api/v1/games/list
Headers:
  X-Player-Token: {player-authentication-token}
Body: (empty)

Sample response:

[
  {
    "name": "Classic Bingo",
    "gameCode": "BINGAO_550e8400-e29b-41d4-a716-446655440000",
    "urlThumb": "https://example.com/thumb.jpg",
    "category": "Bingo",
    "enabled": true,
    "freebetSupport": false,
    "phoenixJackpotSupport": false,
    "releaseDate": "2025-10-08T00:00:00Z",
    "volatility": 5,
    "rtp": "94.5%",
    "paylines": 0
  }
]

Performance Notes:

  • Results are fetched directly from the game provider

  • Only active and enabled games are included in the response

  • Game metadata may be cached for optimal performance

  • Response may return empty array if no games are available

Authorizations
AuthorizationstringRequired

REQUIRED - JWT Authorization header using the Bearer scheme. All API endpoints require authentication, except for authentication endpoints (Connect/authentication). Example: "Authorization: Bearer {token}"

Query parameters
api-versionstringOptional
Header parameters
X-Player-TokenstringOptional

Player access token for session validation

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Successfully retrieved the games list. Returns array of game objects (may be empty if no games available).

post
/games/list

Generates a secure, temporary game launch URL for a player.

post

Creates a personalized game launch URL with player authentication and OTP security.

Process: Validate game code → Verify game availability → Generate OTP → Create URL

Game code format: "BINGAO_{roomId}" Required headers: X-Player-Token, X-Request-Id

Sample request:

{
    "playerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "gameCode": "BINGAO_550e8400-e29b-41d4-a716-446655440000"
}

Sample success response:

{
    "url": "https://game.example.com/launch?roomId=550e8400-e29b-41d4-a716-446655440000&otp=eyJhbGciOiJIUzI1NiJ9..."
}

Usage guidelines:

  • URLs are single-use and expire after the configured timeout period

  • Each request generates a fresh OTP for maximum security

  • The same player can have multiple concurrent game sessions

  • URLs should not be cached or stored long-term

Authorizations
AuthorizationstringRequired

REQUIRED - JWT Authorization header using the Bearer scheme. All API endpoints require authentication, except for authentication endpoints (Connect/authentication). Example: "Authorization: Bearer {token}"

Query parameters
api-versionstringOptional
Header parameters
X-Transaction-Idstring · uuidOptional

Unique transaction identifier for request tracking

Example: aa532d7c-418e-4009-91b9-f7ae42c0a2ef
X-Player-TokenstringOptional

Player access token for session validation

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Body
playerIdstring · uuidOptional
gameCodestring | nullableOptional
Responses
200

Game URL generated successfully and ready for player launch.

post
/games/url

Last updated