APIs
EventsApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new EventsApi(config);
Parameters
config Configuration
The API key for your application. You can generate an API key in the Admin Panel for your application. Please note: Don’t expose the API key in unsecure environments like Web Apps.
getChallengeTypes
ChallengeEventType[]|Error getChallengeTypes();
Returns a list of all available event types.
Returns
getEventRates
EventRate|Error getEventRates();
Returns info about the current event limit and event count
Returns
AppsApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new AppsApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
getApps
Apps|Error getApps();
Get all apps linked to the account provided in the Auth Bearer
Returns
createApp
inline_response_200|Error createApp(AppPayload body);
Use this endpoint to create a new app linked to your account
Parameters
body AppPayload
Payload for creating an app
Returns
appInfo
App|Error appInfo(string appId);
Get basic information about the app
Parameters
appId string
The app id
Returns
setAppInfo
ActionResponse|Error setAppInfo(AppPayload body, string appId);
Update basic app info
Parameters
body AppPayload
Payload for updating an app
appId string
The app id
Returns
deleteApp
ActionResponse|Error deleteApp(string appId);
The app will be set to inactive mode.
Parameters
appId string
The app id
Returns
ApiKeyApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new ApiKeyApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
getApiKeys
ApiKeyInfo[]|Error getApiKeys(string appId);
Every app can have multiple API keys. With this endpoint you can get all api keys issued for the provided app id.
Parameters
appId string
The app id
Returns
createApiKey
inline_response_200_1|Error createApiKey(LabelPayload body, string appId);
Create an api key
Parameters
body LabelPayload
Payload for the label to be used for this API key
appId string
The app id
Returns
inline_response_200_1 or Error
getApiKeyInfo
ApiKeyInfo|Error getApiKeyInfo(string appId, string apiKey);
Get info about your API key
Parameters
appId string
The app id
apiKey string
The API key (url encoded)
Returns
ApiKeyInfo or Error
resetApiKey
ActionResponse|Error resetApiKey(string appId, string apiKey);
Reset the api key
Parameters
appId string
The app id
apiKey string
The API key (url encoded)
Returns
deleteApiKey
ActionResponse|Error deleteApiKey(string appId, string apiKey);
Delete the API key. All subsequent requests with this API key will be blocked.
Parameters
appId string
The app id
apiKey string
The API key (url encoded)
Returns
WebhooksApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new WebhooksApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
createWebhook
Webhook|Error createWebhook(WebhookPayload body);
Creates a new webhook for a specified game and type
Parameters
body WebhookPayload
Payload to create a Webhook
Returns
getWebhooks
Webhook[]|Error getWebhooks(string appId);
Get a list of Webhook objects for the specified app id
Parameters
appId string
The app id
Returns
getWebhookInfo
Error getWebhookInfo(string appId, string webhookId);
Get a Webhook object for the specified webhook id
Parameters
appId string
The app id
webhookId string
The id of the webhook
Returns
updateWebhook
ActionResponse|Error updateWebhook(WebhookPayload body, string appId, string webhookId);
Update a webhook data like the target_url or the type
Parameters
body WebhookPayload
Payload to update a Webhook
appId string
The app id
webhookId string
The id of the webhook
Returns
deleteWebhook
ActionResponse|Error deleteWebhook(string appId, string webhookId);
The webhook will be deleted
Parameters
appId string
The app id
webhookId string
The id of the webhook
Returns
ChallengesApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new ChallengesApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
getChallengeCategoryTypes
ChallengeCategoryType[]|Error getChallengeCategoryTypes();
Get an access token for the Websockets server notifying of updates in real time
Returns
ChallengeCategoryType[] or Error
getChallengeCategories
ChallengeCategory[]|Error getChallengeCategories(string appId);
Get challenge categories available for the app
Parameters
appId string
The app id
Returns
createChallengeCategory
ChallengeCategory|Error createChallengeCategory(ChallengeCategoryPayload body, string appId);
Create a challenge category object for the app
Parameters
body ChallengeCategoryPayload
Payload for creating a challenge category
appId string
The app id
Returns
updateChallengeCategory
ChallengeCategory|Error updateChallengeCategory(ChallengeCategoryPayload body, string appId, string categoryId);
Update a challenge category object for the app
Parameters
body ChallengeCategoryPayload
Payload for updating a challenge category
appId string
The app id
categoryId string
The challenge category id
Returns
deleteChallengeCategory
ActionResponse|Error deleteChallengeCategory(string appId, string categoryId);
Delete the challenge category
Parameters
appId string
The app id
categoryId string
The challenge category id
Returns
getChallenges
Challenge[]|Error getChallenges(string appId);
Get challenges available for the app
Parameters
appId string
The app id
Returns
Challenge[] or Error
createChallenge
Challenge|Error createChallenge(ChallengePayload body, string appId);
Create a challenge object for the app
Parameters
body ChallengePayload
Payload for creating a challenge
appId string
The app id
Returns
updateChallenge
ChallengeCategory|Error updateChallenge(ChallengeCategoryPayload body, string appId, string challengeId);
Update a challenge category object for the app
Parameters
body ChallengeCategoryPayload
Payload for updating a challenge category
appId string
The app id
challengeId string
The challenge category id
Returns
deleteChallenge
ActionResponse|Error deleteChallenge(string appId, string challengeId);
Delete the challenge category
Parameters
appId string
The app id
challengeId string
The challenge id
Returns
getAvailablePersonalChallengesRewards
ChallengeRewardType[]|Error getAvailablePersonalChallengesRewards();
Get a list of available personal challenge reward types. Can be used when creating challenges.
Returns
ChallengeRewardType[] or Error
BattlePassesApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new BattlePassesApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
getBattlePasses
BattlePass[]|Error getBattlePasses(string appId);
Get available battle passes for your app
Parameters
appId string
The app id
Returns
createBattlePass
BattlePass|Error createBattlePass(BattlePass body, string appId);
Create a battle pass for the app. Once you have created the battle pass you can create battle pass levels
Parameters
body BattlePass
Payload for creating a battle pass
appId string
The app id
Returns
BattlePass or Error
getBattlePass
BattlePass|Error getBattlePass(string appId, string battlePassId);
Get a specific battle pass by id
Parameters
appId string
The app id
battlePassId string
The id of the battle pass
Returns
BattlePass or Error
updateBattlePasss
BattlePass|Error updateBattlePasss(BattlePass body, string appId, string battlePassId);
Update the battle pass object for your app. You may change images, names, and descriptions
Parameters
body BattlePass
Payload for creating a battle pass
appId string
The app id
battlePassId string
The id of the battle pass
Returns
BattlePass or Error
getBattlePassChallenges
BattlePassChallenge[]|Error getBattlePassChallenges(string applicationId);
Get available battle pass challenges for your app
Parameters
applicationId string
The app id
Returns
BattlePassChallenge[] or Error
createBattlePassChallenge
BattlePassChallenge|Error createBattlePassChallenge(BattlePassChallenge body, string applicationId);
Create a battle pass challenge for the app which can then be attached to battle pass levels
Parameters
body BattlePassChallenge
Payload for creating a battle pass challenge
applicationId string
The app id
Returns
getBattlePassChallenge
BattlePassChallenge|Error getBattlePassChallenge(string applicationId, string challengeId);
Get a battle pass challenge by id
Parameters
applicationId string
The app id
challengeId string
The battle pass challenge id
Returns
updateBattlePassChallenge
BattlePassChallenge|Error updateBattlePassChallenge(BattlePassChallenge body, string applicationId, string challengeId);
Update a battle pass challenge. Best approach is to load the challenge, then changing properties, then apply this object as payload to this function.
Parameters
body BattlePassChallenge
Payload for creating a battle pass challenge
applicationId string
The app id
challengeId string
The battle pass challenge id
Returns
deleteBattlePassChallenge
ActionResponse|Error deleteBattlePassChallenge(string applicationId, string challengeId);
Delete a battle pass challenge by id
Parameters
applicationId string
The app id
challengeId string
The battle pass challenge id
Returns
getBattlePassLevels
BattlePassLevel[]|Error getBattlePassLevels(string battlePassId);
Get available battle pass levels
Parameters
battlePassId string
The id of the battle pass
Returns
createBattlePassLevel
ActionResponse|Error createBattlePassLevel(BattlePassLevel body, string battlePassId);
Create a battle pass for the app. Once you have created the battle pass you can create battle pass levels
Parameters
body BattlePassLevel
Payload for creating a battle pass
battlePassId string
The id of the battle pass
Returns
getBattlePassLevel
BattlePassLevel|Error getBattlePassLevel(string battlePassId, string battlePassLevelId);
Get a battle pass level by id
Parameters
battlePassId string
The id of the battle pass
battlePassLevelId string
The id of the battle pass level
Returns
updateBattlePassLevel
BattlePassLevel|Error updateBattlePassLevel(BattlePassLevel body, string battlePassId, string battlePassLevelId);
Update the a battle pass level with new values
Parameters
body BattlePassLevel
Payload for creating a battle pass
battlePassId string
The id of the battle pass
battlePassLevelId string
The id of the battle pass level
Returns
deleteBattlePassLevel
ActionResponse|Error deleteBattlePassLevel(string battlePassId, string battlePassLevelId);
Delete a battle pass level by id
Parameters
battlePassId string
The id of the battle pass
battlePassLevelId string
The id of the battle pass level
Returns
UsersApi
constructor
It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.
new UsersApi(config);
Parameters
config Configuration
You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.
getAvailableLanguages
Language[]|Error getAvailableLanguages();
Returns a list of all available languages
Returns
Language[] or Error