Start game

Request

URI: /start?{parameters}

Example usage: https://{base_url}/start?{parameters}

The request is executed using the GET method.

This method is used to get a link to start the game.

note

A new player is registered based on the playerDetails received from the third-party platform.
The currency used during the first game session is assigned to the userId and becomes fixed.
If the same player starts the game with a new currency, a new userId is generated on the aggregator side.
More details about the game start mechanism can be found here.

Request parameters

Name	Type	Required	Description
demo	boolean	No	false: launch game in live mode true: launch game in demo mode (in this case token and userId are not required)
token	string	Yes	Authorization code of the user's session Restrictions: 1..250 token is optional only if demo = true
userId	string	Yes	Unique ID of the user
gameId	string	Yes	Unique ID of the game
lang	string	No	Language code in ISO 639-1 format (e.g. en, ru, es)
exiturl	string	No	For games that support a home URL (e.g. https://example.com)
mobile	boolean	No	For mobile devices Accepted values: true, false
ip	string	No	Mandatory for providers that require IP address (Pariplay)
country	string	Yes	Country code in ISO 3166-1 alpha-2 format (e.g., AU, US) Mandatory for providers that require country code (Pariplay, QT, ELBET)

Freespins Parameters

Accrual of freespins for a player requires inclusion of the parameters presented in the table.

note

The freespins parameters are required only if you want to provide free spins to the player.
These parameters are not required to start the game.
This method is still in use but will be removed soon.

A request to the provider Get game bet values is required for the freespin parameters to work with the following providers:

• Pragmatic
• Gameart
• Platipus
• Endorphina
• Habanero
• Ka gaming
• OnlyPlay
• Caleta gaming
• Mascot gaming
• Smartsoft
• BoldPlay
• Hacksaw Gaming
• Relax Gaming
• AmigoGaming
• AGTsoftware

Name	Type	Required	Description
bonusName	string	Yes	Name of the bonus (for bonus bets)
bonusRounds	integer	Yes	Number of freespins (for bonus bets)
bonusBet	float	Yes	Bet per spin (for bonus bets)
bonusExpired	timestamp	Yes	Date and time of bonus expiration (for bonus bets)

Example of a successful response

Both response types must be supported:

• The JSON response should be parsed when returned.
• A 302 redirect must be followed if received.

Example of a successful response (JSON)

Response: /start?{parameters}

{
  "jsUrl": "https://example.com/renderer.min.js",
  "brandId": "123456789",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOi...<long JWT token>...",
  "theme": "default",
  "lang": "en"
}

note

token is a JWT token to be used for future authenticated requests.
jsUrl provides a path to a remote JavaScript renderer.
lang, theme, and brandId help customize the experience for the user.

Example of a successful response (redirect URL)

info

In some cases, the server may respond with an HTTP 302 Found status and a Location header to redirect the user.

Response: 302 Redirect

HTTP/1.1 302 Found
Location: https://example.com/redirected-url

note

The client (browser, mobile app, etc.) should follow the redirect to the provided URL.

Example of an unsuccessful response

Response: /start?{parameters}

{
    "status": false,
    "errors": {
        "error": "Description"
    }
}