Website
PC and Mobile
Last updated
PC and Mobile
Last updated
No leaderboard is provided after the game. The brand’s system send the user ID (e.g., customer ID) to the mini-game system, and the game results, along with the user ID, are sent back to the brand's system via a webhook. To use this service, the brand’s system must support the Webhook feature.
You can use the userid and Webhook to send game-related data to the brand's server after the game.
When the mini-game is launched on the website, the user ID (userid) is retrieved from the brand's server via a GET request and sent to the mini-game execution URL.
The mini-game runs within a web page environment.
After the game ends, the game score is displayed on the result screen.
The brand server receives game-related data through a Webhook.
Based on the received data, the brand's server operates its own leaderboard and reward program.
The brand creates a mini-game using Studio.
The brand must set up a Webhook program on their server to receive game result data.
The brand applies the received data to their own leaderboard or reward program based on the data transmitted via Webhook.
When retrieving the mini-game URL value from the Webview, the 'userid' parameter and its value must be included using the GET method.
Parameter
Example, Original campaign URL address https://branded.mini-games.io/?php=landing@8NKHT2hK&campaign_no=1 The brand's system must call this URL and send the "userid".
https://branded.mini-games.io/?php=landing@8NKHT2hK&campaign_no=1&userid=T4g4fLTa
After the game, the result value and various data are received by the brand’s server through the Webhook created by the brand.
* Indicates a required value.
Return Code
The brand server must return the result code to our studio system.
PHP example
To obtain parameter values when the returned data is in JSON format, you must first parse the data.
Name | Description | Format | Sample |
---|---|---|---|
Name | Description | Sample |
---|---|---|
Code value | Description |
---|---|
userid *
Unique ID generated from the customer's system
Alphanumeric (case-sensitive) + up to 20 digits
T4g4fLTaorjames
userid *
User's unique ID
T4g4fLTa or james
tx_id *
Unique ID for each game played
234234
time *
Datetime when the game player attempted to play
2023-04-10 06:39:23
score *
Score obtained by the game player
3500
playtime*
Duration of play by the game player (in seconds)
20
S
When successful
F
When failing If you want to state the reason for failure, you can add text after the "F" code. Example) "F: Score is missing."