Skip to content

Game Launch API

The Game Launch API is used by the Operator to initiate a new game session for a player. It returns a launch_url that should be used to embed the game in your frontend (typically via an iframe).

Overview

  • Endpoint: {BASE_URL}/api/v1/launch/{game}
  • Method: GET
  • Authentication: Requires X-Public-Key header.

Request Specification

Path Parameters

Parameter Type Description
game String The unique identifier for the game (e.g., chicken-race).

Query Parameters

Parameter Type Required Description
userToken String Yes Your unique, one-time token for the player.
currency String Yes 3-letter currency code (e.g., USD, EUR).
platform String Yes Client platform. Values: mobile, desktop.
portalMode String Yes Game mode. Values: real, demo.
returnUrl String Yes URL to redirect the user to when they exit the game.
language String Yes ISO 639-1 language code (e.g., en, es).
skinId String No Custom skin identifier for the game UI.
generalCode String No Optional promotional or tracking code.
realityCheckInterval Integer No Interval for reality check popups in minutes.
elapsedRealityCheckTime Integer No Time already elapsed in the current session (for reality check).

Required Headers

Header Description
X-Public-Key Your assigned public API key.
User-Agent Standard browser user agent string.

Response Specification

A successful request returns a JSON object containing the launch URL and a session token.

Response Example

{
  "launch_url": "https://games.game-provider.com/play/chicken-race?token=ps_123abc&portalMode=real&language=en&platform=desktop",
  "session_token": "ps_123abc"
}

Response Fields

Field Type Description
launch_url String The full URL to be loaded in the game iframe.
session_token String A unique identifier for the created session.

Usage Example (Frontend)

Once you receive the launch_url, you can embed it in your casino site:

<iframe 
    src="https://games.game-provider.com/play/chicken-race?token=ps_123abc..." 
    width="100%" 
    height="600px" 
    frameborder="0" 
    allowfullscreen>
</iframe>

[!IMPORTANT] Always generate the launch URL from your backend to protect your API keys and ensure session integrity.