Configurations 👑
The Configurations Endpoints can be used to retrieve client different configurations.
Available Endpoints
Type | Description | Endpoint |
---|---|---|
GET | /integrations/config | |
GET | /integrations/client/redemption/config | |
GET | /integrations/config/challenge/{handle} | |
GET | /integrations/client/cashback |
GET - Configurations
This API call is used to retrieve your configured Gameball Settings along with all Gameball Programs Configurations. This endpoint allows you to retrieve your configured settings on Gameball account which can be used while creating your custom UI for the player profile on your website or mobile app.
It is very important to use this endpoint while building your own UI to keep all configurations related to Gameball are variable. No need to update your loyalty program static content inside your website or mobile app every time you change them through Gameball admin dashboard.
This endpoint is only available for our GURU customers only 👑
Request
Header
Attribute | Type | Required | Description |
| string | Yes | Client API key |
| string | No | Language filter. This could be used to specify the language needed to display your configurations in. If not provided, the response would be in default language. Note: The language provided should be as per configured languages in your account. Example: |
Response
Parameter | Type | Description |
| string | Configured Currency Example: |
| string | Name of your program. Example: |
| string | Name of the rank points, measuring player's progress. |
| string | Name of the points (monetary value). |
| string | The main color of your bot as configured from your Gameball dashboard. |
| object | An object describing the activity of the main factors. |
| array | An array of level objects describing each level along with its configurations. |
| array | An array of challenge objects describing each challenge along with its configurations. |
| object | An object describing the referral program configurations. |
| object | An object describing the cashback program configurations. |
| object | An object describing the redemption configurations The redemption object is described as follows
|
controlConfig
Object
controlConfig
ObjectParameter | Type | Description |
| boolean | Indicates whether Gameball is enabled or not. |
| boolean | Indicates whether redemption configurations is enabled or not. |
| boolean | Indicates whether cashback program is enabled or not. |
| boolean | Indicates whether referral program is enabled or not. |
| boolean | Indicates whether guest view is enabled or not. |
| boolean | Indicates whether user view is enabled or not. |
| boolean | Indicates whether Leaderboard configurations are enabled or not. |
| boolean | Indicates whether Notifications configurations are enabled or not. |
| boolean | Indicates whether Achievements configurations are enabled or not. |
level
Object
level
ObjectParameter | Type | Description |
| integer | The required score to reach the level. |
| integer | Level Order. |
| string | Icon URL of the level. |
| string | Level Name. |
| object | The benefits object is defined as follows:
|
challenge
Object
challenge
ObjectParameter | Type | Description |
| integer | Unique identifier for the challenge. |
| string | Challenge Name. |
| string | Challenge Description. |
| integer | Awarded rank upon challenge completion. |
| integer | Awarded points upon challenge completion. |
| boolean | A flag that indicates whether the challenge is repeatable or not. |
| integer | An integer that defines how many times a player can achieve that challenge. |
| string | The type of the challenge. Possible values are as follows:
|
| string | Defines the visibility of the challenge. Possible values are:
|
| string | The icon's URL of the challenge. |
| object | An object that describes challenge availability to players.
|
| string | Defines the text written on the redirection button (In case the redirection button is enabled for this challenge). |
| string | Defines the redirection link (In case the redirection button is enabled for this challenge). |
referral
Object
referral
ObjectParameter | Type | Description |
| string | Defines how the referral program rewards your players, Possible values:
|
| string | The name of the event which is linked to the referral action. |
| string | The event metadata which value should be monitored and checked for completing the referral. |
| object | An object that defines the referring player's reward. The
|
| object | Defines the referred player reward configurations in case the The object is the same as the |
cashback
Object
cashback
ObjectParameter | Type | Description |
| number | In case you have different merchants (brands) on your platform, The Example: If you give 5% cashback (when the customer pays 100 USD, they will get 5 USD cashback). The |
| integer | Defines the amount of unit currencies needed to reward the player as per cashback rules.
Example: For every 10 USD spent the player gets rewarded by 5 points, implies that the |
| integer | Determine the points rewarded for each unit of currency your player spends. Example: 2 points for every 1 USD spent, implies that the |
| integer | In case your level up method is score, this factor determines the score rewarded for each unit of currency your player spends. Example: 2 Score for every 1 USD spent, implies that the |
Sample Response
Usage Example
GET - Challenge Configurations
This API is used to get the configurations of a specific challenge.
https://api.gameball.co/api/v3.0/integrations/config/challenge/{handle}
Request
Header
Attribute | Type | Required | Description |
| string | Yes | Client API key |
| string | Yes | Client Secret Key |
Path Parameters
Attribute | Type | Required | Description |
| string | Yes | Challenge handle could be either the Challenge Id or the Challenge internal name. |
Response
Attribute | Type | Description |
| object | A single object array of ChallengeConfig object |
challengesConfig
object
challengesConfig
objectAttribute | Type | Description |
| integer | A single object array of c |
| string | Challenge Name. |
| string | Challenge description( In default language if not specified in query parameter). |
| array | An array of Reward objects, these are the rewards that are achieved by completing the specified challenge. |
| boolean | A boolean indicating if the challenge is repeatable for the specified Player or not. |
| integer | Maximum number of times the specified challenge can be achieved (-1 if can be achieved for an unlimited number of times) |
| string | Challenge type, can be one of the following:
|
| string | Challenge visibility type, can be one of the following:
|
| string | URI indicating the file path to the icon of the challenge. |
| object | An availability object specifying the conditions where this challenge is available. |
| string | Defines the text written on the redirection button (In case the redirection button is enabled for this challenge). |
| string | Defines the redirection link (In case the redirection button is enabled for this challenge). |
Sample Response
GET - Redemption Rules
This API endpoint is used to return all client’s redemption rules.
Request
Header
| string | Yes | Client API key |
| string | Yes | Client Secret Key |
| string | No | Preferred language code. (e.g. "en", "es") |
Response
Parameter | Type | Description |
---|---|---|
| boolean | A Boolean flag indicating if the redemption program is active for the client. |
| int | Number of days that the points will expire after being rewarded. |
| array | An array of |
redemptionRule
object
redemptionRule
objectParameter | Type | Description |
---|---|---|
| integer | Unique Identifier of the redemption rule. |
| double | Points needed for the rule to be redeemed. |
| double | In the case of a rule of type |
| string | Indicates the type of the rule and can be one of the following:
|
| DateTime | Starting date when the rule can be applied (If null then it starts from the date of creation). |
| DateTime | Ending date when the rule will expire (If null then it will not expire). |
| object | A coupon object describing the coupon that is awarded when the rule is redeemed. |
| object | An AvailableTo object specifying the availability of the rule (To whom this rule will be available). |
| string | A text displaying the how to redeem section as configured in the dashboard if lang header was provided the returned text will adapt to the sent lang parameter, else the default lang text will be returned. |
availableTo
Object
availableTo
ObjectParameter | Type | Description |
---|---|---|
| object | A Level object indicating the level that the rule is available to, The Level object has the following attributes:
|
| array | An array of tag names that the rule is available to. |
coupon
Object
coupon
ObjectParameter | Type | Description |
---|---|---|
| string | Indicates the type of the coupon, the value of the string can be one of the following:
|
| double | Indicating the discount value of the coupon, in the case of percentage it will indicate the percentage value of the discount. |
| double | Minimum value the order has to reach in order for the coupon to be applied. |
| object | In the case of |
| object | Indicates if the coupon can only be applied to certain orders. It has the following attributes:
|
| object | An object describing the coupon group which the coupon belongs to. |
product
Object
Parameter | Type | Description |
---|---|---|
| integer | Unique identifier of the product. |
| string | Name of the product. |
| array | An array of display names for the product. |
| integer | In case the product has variants this is the id of the variant. |
| string | In case the product has variants this is the name of the variant. |
group
Object
group
ObjectParameter | Type | Description |
---|---|---|
| string | A unique identifier for the coupon group. |
| string | Title of the coupon group. |
| string | URL of the coupon group. |
| string | Icon path of the coupon group. |
| string | Description of the coupon group. |
| integer | Maximum number of times a player can achieve coupons from this group. |
| DateTime | Date at which coupons can start to be redeemed from this group. |
| DateTime | Date at which you can no longer redeem coupons from this group. |
| boolean | A Boolean flag indicating if there are coupons available to be redeemed from this group. |
| boolean | Flag indicating if the group is valid (The group is considered valid if the current date falls between the start and expiry dates). |
| boolean | Flag indicating if the group is active or not (The group is considered active if the client has marked it as active and if the group's dates are valid). |
Sample Response
Get - Cashback Rules
This API endpoint is used to return all client’s cashback rules.
Request
Header
Attribute | Type | Required | Description |
---|---|---|---|
| string | Yes | Client API key |
| string | Yes | Client Secret key |
Response
Parameter | Type | Description |
---|---|---|
| boolean | A boolean flag indicating if the Cashback program is active for the client. |
| integer | Number of days that the player can return an order and points get deducted accordingly. |
| array | An array of |
cashback
Object
cashback
ObjectParameter | Type | Description |
---|---|---|
| integer | Id of the cashback rule. |
| boolean | A boolean indicating if the cashback rule is the default one. |
| double | Amount needed to be spent in order to be rewarded the cashback. |
| double | Points awarded for the amount specified in |
| object | An AvailableTo object specifying the availability of the rule (To whom this rule will be applied on). |
Sample Response
Last updated