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.

curl --location -g --request POST '/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" }'

Overview#

Security and Authentication#

Path Parameters#

Request

Responses

Overview

Security and Authentication

Path Parameters