Game Launch Flow

The Start Game flow is initiated by the Operator whenever a player selects a game on the casino front end. The Operator sends a Start Game request to CloudAggregator, which returns a game launch URL. The Operator's front end then opens this URL in an iframe or a new browser tab to deliver the game to the player.

The complete flow is as follows:

- The player clicks on a game tile on the Operator's casino website or app.
- The Operator's backend sends a Start Game request to the CloudAggregator API, providing player session details, game configuration, and wallet callback information.
- CloudAggregator validates the request, creates a game session, and returns a redirect URL pointing to the requested game.
- The Operator's frontend opens the redirect URL in an iframe, a new browser tab, or a native WebView.
- The game loads and begins communicating with CloudAggregator. CloudAggregator then relays wallet transactions (GetBalance, Wager, Result) to the Operator's registered wallet endpoint throughout the game session.

Note: For Sports Book game launches, refer to Section 9: Sports Book Integration (Appendix B) for the dedicated launch flow, which returns a JSON configuration object instead of a redirect URL.

Step 1: Generate Launch Url

API Endpoint

GET http(s)://<Regional Server (Staging / Production)>/game/launch

{
  "session_id": "<operator_player_token>", 
  "account_id": "<player_uuid>", 
  "game_id": "<game.id>", 
  "operator_id": "<operator_id>", 
  "device": "desktop | mobile" 
}

Field	Description
Session Id	Encrypted player token
Account Id	Player Unique Id (UUID)
Game Id	Game Identifier
Operation Id	Tenant Identifier

Success Response

{  
  "success": true,  
  "data": {  
    "launchGameUrl": "<Rummy / Rummy Lobby Launch Url>"  
  }  
}

This URL launches the Rummy game session

Even on failure, API may return:

{
  "success": false,  
  "message": "Please try again after sometime"  
}

Step 2: Launch Url

Now operator can open the generated launch url in to Iframe, WebView or in new browser tab based on operator site / app implementation.

Game Launch Flow

sequenceDiagram
autonumber

actor Player
participant CloudAgg as Cloud Aggregator

Note over Player: Player is browsing the Operator's game lobby

Player->>CloudAgg: Request game launch<br/>(playerId, sessionId, gameId, currency)
CloudAgg-->>Player: Game launch URL
Note over Player: Open game URL in new page<br/>or embed in iframe

Note: It is recommended to use proxy endpoint on operators end (as below) to avoid cross domain issues and enhanced security

sequenceDiagram
autonumber

actor Player

box Operator
participant Casino as Operator
end

participant CloudAgg as Cloud Aggregator

Player->>Casino: Click game in lobby
Casino->>CloudAgg: Get launch URL<br/>(playerId, sessionId, gameId, currency)
CloudAgg-->>Casino: Game launch URL
Casino-->>Player: Return game launch URL
Note over Player: Open game URL in new page<br/>or embed in iframe

GET

Game Launch API

Effective URL

https://cloudaggregator.net/api/t/WORKSPACE_ID_PROVIDED_TO_YOU_BY_CLOUD_AGGREGATOR/v2/game/launch?operator_id=OPERATOR_ID_PROVIDED_TO_YOU_BY_CLOUD_AGGREGATOR&game_id=GAME_ID_TO_LAUNCH&session_id=SESSION_ID_OF_YOUR_PLAYER_FROM_OPERATOR&account_id=UNIQUE_ID_OF_YOUR_PLAYER_FROM_OPERATOR&currency=EUR&is_test_account=false

Required Parameters

tenant_id

account_id

session_id

game_id

operator_id

currency

Optional Parameters

device_type

country

mode

language

Event ID

Competition ID

is_test_account

Start Game Request

This endpoint launches a game and initiates a new game session.

Property	Value
Request Endpoint	https://<ca_domain>/v2/game/launch/
HTTP Method	GET
Encoding	All query parameters must be URL-encoded (encodeURIComponent)
Authentication	X-CA-API-Key header required

Request Query Parameters

Parameter	Data Type	Required	Description	Example
operator_id	String	Y	Your CloudAggregator Operator ID, assigned during onboarding.	CA_OP_42
game_id	Integer	Y	CloudAggregator unique game identifier. Obtain from the Game Catalog API.	50301
session_id	String(36)	Y	Unique session identifier generated by the Operator for this game launch. Must be prefixed with operator_id. Format: {operator_id}_{uuid}. Must be 0 in demo mode.	CA_OP_42_f3d2-9a1b-...
account_id	String(32) [0-9a-zA-Z]	Y	The Operator's unique player identifier. In demo mode, use any non-null placeholder. Must be 0 in demo mode alongside session_id.	PLR_78345
currency	String	Y	ISO 4217 currency code for the game session. Must be a currency pre-registered with CloudAggregator.	EUR
language	String	Y	ISO 639-1 language code followed by underscore and ISO 3166-1 alpha-2 country code.	en_GB
mode	String	Y	Game mode. Accepted values: real \| demo.	real
country	String	Y	ISO 3166-1 alpha-2 country code of the player's location. Required in real mode; dummy value in demo mode.	SE
home_url	String(255)	Y	The URL to redirect the player to when they exit or close the game.	https://yourcasino.com/lobby
device_type	String	Y	The player's current device. Accepted values: desktop \| mobile \| tablet. Not all games are available on all device types.	mobile
is_test_account	Boolean	Y	Set to true for internal test accounts to exclude them from production reporting. Required in real mode only.	false
license	String	Y	The gambling jurisdiction applicable to this player session. Examples: MGA, UKGC, Curacao, Sweden, Denmark.	UKGC
game_category	String	Y	Game category hint for routing. Values: slots \| rummy \| bingo \| lottery \| live \| sportsbook.	slots
history_url	String(255)	N	URL to the player's game history page within the Operator's platform. Required for certain regulated markets.	https://yourcasino.com/history
reality_check_elapsed	Integer	N	Minutes since the session began before the first reality check prompt appears. Mandatory for UKGC compliance.	30
reality_check_interval	Integer	N	Interval in minutes between subsequent reality check prompts during a session. Mandatory for UKGC compliance.	30
exit_url	String(255)	N	URL shown to the player after they confirm exit through the reality check dialog. Mandatory for UKGC compliance.	https://yourcasino.com/exit
rc_url	String(255)	N	CloudAggregator-hosted reality check application URL. Provided by your integration manager.	https://rc.cloudaggregator.com
deposit_url	String(255)	N	URL to your deposit/cashier page, surfaced when the player has insufficient funds.	https://yourcasino.com/deposit
frb_id	String(255)	N	Free Rounds Bonus offer ID. Include when launching a game as part of an FRB promotion.	FRB_OFFER_9182

Request Example

GET https://api.cloudaggregator.com/api/t/:tenantId2/game/launch/

?operator_id=CA_OP_42

&game_id=50301

&session_id=CA_OP_42_3e4f2a1b-9c8d-4e5f-a6b7-c8d9e0f1a2b3

&account_id=PLR_78345

&currency=EUR

&language=en_GB

&mode=real

&country=SE

&home_url=https%3A%2F%2Fyourcasino.com%2Flobby

&device_type=desktop

&is_test_account=false

&license=MGA

&game_category=slots

Header: X-CA-API-Key: your_operator_api_key_here

Success Response

HTTP Status: 302 Found. The player is automatically redirected to the game launch URL. No additional processing is required by the Operator for this redirect.

Error Response

{

"error_code": "INVALID_GAME_ID",

"error_message": "The specified game_id does not exist in the CloudAggregator catalog.",

"request_id": "req_abc123xyz"

}