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.

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 user's session Restrictions: `1..250` token is optional only if demo = `true`
userId	string	`Yes`	The unique ID of the user
gameId	string	`Yes`	The 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 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)

Accrual of freespins for a player would require 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 for a game start.

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

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

Response: /start?{parameters}
{
    "status": false,
    "errors": {
        "error": "Description"
    }
}