Game Launch URL Details
Launch Details
This section provides a comprehensive breakdown of how game launch URLs are structured, the supported query parameters, and best practices for embedding games securely.
Launched games can be embedded either to iframe (for desktop browsing players) or via direct game provider url with referalUrl parameter passed as a url where player should be redirected after a game session.
Game can be launched on platform side based on game launch url template provided by provider.
Game provider provides a way to launch individual product by identifier in a format described below.
Template are of form:
https://<game_provider_base_url>?<query_parameters>
where:
<game_provider_base_url>- is a base url where game launch controller is hosted<query_parameters >- is a set of query parameters needed for a specific product to launch
Parameters supported
Required parameters for data object
| Parameter Name | Descriptio | Type | Notes |
|---|---|---|---|
| partnerId | platform partner id | number | Partner id issued by Platform. can be the same on stage and prod environment |
| gameId | game id | number | Exact game id to be launched (game identifier). defined on game provider side |
| gameMode | Game launch mode | string | Game launch mode expected values are fun or real |
| lang | language code | string(2) | Language code in ISO 639-1 format |
| country | country codee | string(2) | Country code code in ISO 3166-1 alpha-2 format |
| playerId | Player Identifier | string | Unique per platform, the same playerId value which is retrieved from playerInfo method |
| ip | ip address | string | Player's ip address |
| platform | platform indetifier | number | Platform provided by provider side |
| externalToken | player session token | string(255) | Session token which identifies unique player token on Platform side. generated by Platform. not present when launching game in Demo mode |
The exitURL parameter (when provided) tells the game where to redirect the player after the session ends.
Example of final game launch url
- Live
- Demo
Example of Live mode game launch url:
except for externalToken.
Example of Demo mode game launch url:
Demo mode game launch URL generated by Platform has the same set of parameters as for a regular game launch