Games can be launched by using any one of the following methods.
- Explicit launch URL (Recommended).
- Get game URL API.
4.1 Explicit launch URL
In this method, A game launch base URL will be provided to the operator during the integration
process and then the operator can form the URL explicitly along with the following parameters.
An example request could include the following parameters.
https://<GAME-LAUNCH-BASE-URL>/&game_config_id={GAME_ID}&site_id={SITE_ID} &token={TOKEN}&language={LANGUAGE}&platform={PLATFORM}&amount_type={AMOUNT TYPE}&lobby_url={URL}&deposit_url={URL}
4.1.1 Game Launch Parameters
Parameter | Type | Description |
game_config_id | Integer | Game ID provided by the provider |
token | String | Session ID created for the player during login |
site_id | Integer | Site ID allocated to the Operator |
platform | String | Platform or channel player playing the game. EX: desktop, mobile |
amount_type | String | Mode of play, for example: ‘real’ - when playing with real cash 'demo' - when playing with fun/demo mode ‘goldcoins’- when playing with gold coins ‘sweepcoins’- when playing with sweep coins |
language | String | Language in which the game should be displayed. This is defined following the ISO 639-1 standard. e.g., en, in etc... |
lobby_url | String | Home or Lobby URL of the Operator |
deposit_url | String | Deposit URL of the Operator |
4.2 Get Game Launch URL API
In this method, the Operator must make an extra call to this API to get the game launch URL.
4.2.1 Game Launch Request
Type | Input |
Method | POST |
URL | https://<AG-API-BASE-URL>/provider/get_game_launch_url |
Headers | "Content-Type": "application/json" |
POST Parameters | JSON Object (JSON-RPC 2.0) |
Example | { "jsonrpc": "2.0", "id": 0, "method": "get_game_launch_url", "params": { "game_config_id": int, "token": "string", "site_id": int, "platform": "string", "amount_type": "string", "language": "string", "deposit_url": "string", "lobby_url": "string" } } |
4.2.2 Request Parameters
Parameter | Type | Description | |
game_config_id | Integer | Game ID provided by the provider | |
token | String | Session ID created for the player during login | |
site_id | Integer | Site ID allocated to the Operator | |
platform | String | Platform or channel player playing the game. EX: desktop, mobile | |
amount_type | String | Mode of play, for example: ‘real’ - when playing with real cash ‘demo’ - when playing with fun/demo mode ‘goldcoins’- when playing with gold coins ‘sweepcoins’- when playing with sweep coins | |
language | String | Language in which the game should be displayed. This is defined following the ISO 639-1 standard. e.g., en, in etc… | |
lobby_url | String | Home or Lobby URL of the operator | |
deposit_url | String | Deposit URL of the operator |
4.2.3 Response Parameters
Parameter | Type | Description | |
result | JSON Object | The key url contains the Game Launch URL as a value that is used to launch the game. |
4.2.4 Example Response
{ "jsonrpc": "2.0", "result": { "url": "https://demo-ag.vegassoftware.com?game_config_id=2&token=abcd-123-efgh&site_id=4&platform=desktop&amount_type=real&language=EN” } "id": 0 }
4.2.5 Game Launch Error Response
Any error response would be provided in JSON format. Refer to section 12 for more information.
{ "jsonrpc": "2.0", "error": { "code": 1004, "message": "Game Not Found.", "name": "GameNotFound" }, "id": 0 }