Launch

POST

/v1/games/{{gameId}}/launch

Overview

The Launch endpoint is a key part of the Provider API for Aggregators. It allows a game session to be initiated by launching an instance of a game for a specified user. When the Aggregator needs to start a game, it sends a request to this endpoint, and in response, a URL (frameUri) is returned that contains the game interface to be embedded or loaded in the client’s environment.

The Launch method allows the Aggregator to:

Start a new game session for a user.

Validate all required parameters such as user ID, session ID, currency, language, and bet limits.

Generate and return a unique link (frameUri) that can be used by the Aggregator or client to embed the game interface (e.g., within an iframe).

Ensure consistency between session information and game launch parameters across the system.

Security and Authentication

The request must be authenticated using the required HTTP headers. Please see the required headers below in the Header Params section.

📌

Signature of the request shall be calculated using HMAC-SHA256 algorithm and sent in "X-Sign" header of the request.
Please see How to calculate the X-Sign value.

Path Parameters

Parameter	Type	Required	Description
gameId	Integer	Yes	Game type ID.

Request

Header Params

X-Counterparty-Id

string

required

The public identifier of the subject provided during the onboarding process.

Example:

933a215f-a9e6-4f88-9d91-52a87cd50499

X-Timestamp

number

required

Request generation time. All requests longer than 30 seconds will be considered expired.

Example:

1719766120806

X-Request-Id

string

required

A random sequence of 32 hexadecimal digits (Nonce) representing a unique request identifier.

Example:

5a0679b6e5fa48f6892c777b0fa92392

X-Sign

string

required

HMAC.SHA256 message signature.

Example:

c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1

Body Params application/json

userId

string

required

Aggregator user ID.

sessionId

string

required

Game session ID.

Each game will have its own sessions ID assigned to the same user.

currency

string

required

Currency code according to ISO 4217.

language

string

required

Language code according to ISO 639.

If the Game Provider does not support the specified language, or the language is not specified, then EN must be used.

gameMargin

integer

optional

Margin value in percentage. If not specified, it is determined by the Game Provider.

minBet

number

required

Minimum bet amount.

maxBet

number

required

Maximum bet amount.

buttonAmounts

number

required

List of values for sum buttons.

maxOdd

number

optional

Maximum coefficient allowable.

maxWin

number

optional

Maximum winning amount.

gameMode

string

required

Game mode:
• real
• demo

If the demo mode is chosen, the same Session ID that was returned in the launch request must be passed to the API endpoints as the Session ID. The same for the real mode.

viewType

string

required

Display type:
• desktop
• mobile

Example

{
  "userId": "80457",
  "sessionId": "qwetr-12345cvbnj-68769-ghyou",
  "currency": "EUR",
  "language": "en",
  "gameMargin": 5,
  "minBet": 0.5,
  "maxBet": 500,
  "buttonAmounts": [
    0.5,
    1,
    2,
    5,
    10,
    25,
    100,
    250
  ],
  "maxOdd": 100,
  "maxWin": 50000,
  "gameMode": "real",
  "viewType": "desktop"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://mock.apidog.com/m1/820627-0-default/v1/games/{{gameId}}/launch' \
--header 'X-Counterparty-Id: 933a215f-a9e6-4f88-9d91-52a87cd50499' \
--header 'X-Timestamp: 1719766120806' \
--header 'X-Request-Id: 5a0679b6e5fa48f6892c777b0fa92392' \
--header 'X-Sign: c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1' \
--header 'Content-Type: application/json' \
--data-raw '{
  "userId": "80457",
  "sessionId": "qwetr-12345cvbnj-68769-ghyou",
  "currency": "EUR",
  "language": "en",
  "gameMargin": 5,
  "minBet": 0.5,
  "maxBet": 500,
  "buttonAmounts": [
    0.5,
    1,
    2,
    5,
    10,
    25,
    100,
    250
  ],
  "maxOdd": 100,
  "maxWin": 50000,
  "gameMode": "real",
  "viewType": "desktop"
}'

Responses

🟢200Success

application/json

Body

frameUri

string

optional

Link to launch the frame with the game according to the request parameters.

The parameters contained in the link may be specified at the discretion of the Game Provider.

Example

{
    "frameUri": "https://providers-domain.net/games?gameId=1&session=ab85f438cdc..."
}

Games

Aggregator API for Provider

Launch

Overview#

Security and Authentication#

Path Parameters#

Request

Request samples

Responses

Overview

Security and Authentication

Path Parameters