[POST] Trigger Gamification events
This guide is for external Gamification Condition - events created in Flarie Studio.
Example / Use Case
Company X run an e-commerce selling clothes online and want to increase their sales on t-shirts. To do so they incentives Customers by giving out 5 game attempt to a promotional competition with great prizes every time a Customer buy a t-shirt.
Company X has created a Gamification Condition in Flarie Studio that is configured to give 5 game attempts to the customer every time this api is called.
When the Customer purchase a t-shirt, Company X will trigger the api from their backend.
Company X has a unique identifier on their end on every Customer. This is passed as the playerIdentifier in the api. When it’s time for the Customer to play in the competition the same playerIdentifier is passed to the game as a URL Parameter.
[POST] https://prod-api.flarie.com/v1/public/gamification
Payload
{
"accessKey": "string",
"gamificationConditionId": "string",
"playerIdentifier": "string"
}
Name | Type | Description |
accesskey |
string |
Brand Access Key. You can generate your accessKey in Flarie Studio → Manage Brand Assets |
gamificationConditionId |
string |
Gamification Condition Id. You will find your gamificationConditionId in your Flarie Studio Gamification Condition. |
playerIdentifier |
string |
Player unique identifier |
Response Message
Status code |
Message |
201 |
Created |
400 |
Bad Request Your accessKey / gamificationConditionId / playerIdentifier is invalid. |
403 |
Forbidden Your accessKey isn't permitted to access the gamificationConditionId |
500 |
Internal Server Error |