Configurations

Retrieve all configured settings on Gameball through this endpoint

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 can let you get the below from Gameball settings:

• Gameball publish status

• General settings

• Widget style settings

• Programs configurations

  • Cashback

  • Challenges

  • Levels

• Redemption settings

This endpoint is only available for our GURU customers only

Configurations

GET /integrations/config

Path Parameters

Name	Type	Description
APIKey	string

200

{
    "config": {
        "buttonBackgroundColor": "#FFCF48",
        "buttonFlagColor": "#E7633F",
        "buttonSariColor": "#E7633F",
        "buttonShape": "rounded",
        "buttonForegroundColor": "#000000",
        "botMainColor": "#E7633F",
        "botBackgroundColor": "#FFFFFF",
        "redemptionEnabled": true,
        "enableVisitorProfile": true,
        "enableUserProfile": true,
        "isRankPointsVisible": true,
        "isWalletPointsVisible": true,
        "isLevelCardVisible": true,
        "enableLeaderboard": true,
        "enableCommunities": false,
        "enableNotifications": true,
        "enableAchievements": true,
        "gbEnabled": true,
        "currency": "EGP",
        "programName": "Omar",
        "rankPointsName": "Score",
        "walletPointsName": "Points",
        "levels": [
            {
                "minProgress": 0,
                "order": 1,
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
                "name": "Basic",
                "benefits": {
                    "amountRewardThreshold": null,
                    "rankReward": null,
                    "walletReward": null,
                    "levelDiscount": null,
                    "discountCapping": null,
                    "others": [
                        "This is level 1 benifit"
                    ]
                }
            },
            {
                "minProgress": 400,
                "order": 2,
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
                "name": "Bronze",
                "benefits": {
                    "amountRewardThreshold": null,
                    "rankReward": null,
                    "walletReward": null,
                    "levelDiscount": null,
                    "discountCapping": null,
                    "others": []
                }
            },
            {
                "minProgress": 3500,
                "order": 3,
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
                "name": "Silver",
                "benefits": {
                    "amountRewardThreshold": null,
                    "rankReward": null,
                    "walletReward": null,
                    "levelDiscount": null,
                    "discountCapping": null,
                    "others": []
                }
            },
            {
                "minProgress": 7500,
                "order": 4,
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
                "name": "Gold",
                "benefits": {
                    "amountRewardThreshold": null,
                    "rankReward": null,
                    "walletReward": null,
                    "levelDiscount": null,
                    "discountCapping": null,
                    "others": []
                }
            },
            {
                "minProgress": 20000,
                "order": 5,
                "icon": "https://cdn.gameball.co/uploads/icon-level-platinum%402x.png",
                "name": "Platinum",
                "benefits": {
                    "amountRewardThreshold": null,
                    "rankReward": null,
                    "walletReward": null,
                    "levelDiscount": null,
                    "discountCapping": null,
                    "others": []
                }
            }
        ],
        "challenges": [
            {
                "id":"123",
                "name": "Anniversary",
                "description": "You're gaining this badge as you've been an amazing shopper for one year! Enjoy your rewards!",
                "rewardRankPoints": 0,
                "rewardPoints": 1000,
                "repeatable": true,
                "maxAchievement": null,
                "type": "EventBased",
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
            },
            {
                "id":"124",
                "name": "First Order",
                "description": "Earn this badge after your first order along with lots of other rewards! Once you earn it, check your score and points!",
                "rewardRankPoints": 0,
                "rewardPoints": 0,
                "repeatable": false,
                "maxAchievement": 1,
                "type": "EventBased",
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
            },
            {
                "id":"125",
                "name": "Fifth Order",
                "description": "Earn this badge after your fifth order along with lots of other rewards! Once you earn it and check your wallet and rank points!",
                "rewardRankPoints": 0,
                "rewardPoints": 3000,
                "type": "EventBased",
                "repeatable": false,
                "availability": {
                    "minLevel": 4,
                    "tags": [
                        "VIP"
                    ]
                },
                "icon": "https://cdn.gameball.co/uploads/007/[e-mail]",
            }
        ],
        "cashback": {
            "rewardEnabled": true,
            "rewardFactor": 1.0,
            "amountRewardThreshold": 1.0,
            "rewardWalletFactor": 1.0,
            "rewardRankFactor": 1.0
        },
        "redemption": {
            "redemptionFactor": 0.01,
            "redemptionRules": [
                {
                    "ruleId": 793,
                    "type": 4,
                    "equivalentPoints": 100,
                    "equivalentPointsValue": null,
                    "productId": null,
                    "productName": null
                },
                {
                    "ruleId": 794,
                    "type": 4,
                    "equivalentPoints": 100,
                    "equivalentPointsValue": null,
                    "productId": null,
                    "productName": null
                }
            ]
        }
    }
}