Sign in

APIs

AuthApi

Constructor

It’s not recommended to manually initialize APIs. Please use SCILLClient class to initiate API instances.

new AuthApi($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.

generateAccessToken

\SCILL\Model\AccessToken generateAccessToken($body);
Parameters

body ForeignUserIdentifier

Foreign user identifier.

getUserChallengeNotificationTopic

\SCILL\Model\NotificationTopic getUserChallengeNotificationTopic($challenge_id);

Get a topic to be used with an MQTT client to receive real time updates whenever the challenge changes.

Parameters

challenge_id string

The challenge id you want to get notified

getUserChallengesNotificationTopic

\SCILL\Model\NotificationTopic getUserChallengesNotificationTopic();

Get a topic to be used with an MQTT client to receive real time updates whenever challenges for the user provided by the access token change.

getUserBattlePassNotificationTopic

\SCILL\Model\NotificationTopic getUserBattlePassNotificationTopic($battle_pass_id);

Get a topic to be used with an MQTT client to receive real time updates whenever a battle pass changes.

Parameters

battle_pass_id string

The battle pass you want to get notified

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.

sendEvent

\SCILL\Model\ActionResponse sendEvent($body);

Post an event to the SCILL backend

Parameters

body EventPayload

Event payload

getAvailableEvents

\SCILL\Model\EventDescription[] getAvailableEvents();

Get all available events and required and optional properties

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.

getPersonalChallenges

\SCILL\Model\ChallengeCategory[] getPersonalChallenges($appId);

Get personal challenges organized in categories

Parameters

appId string

The app id

getUnresolvedPersonalChallenges

\SCILL\Model\ChallengeCategory[] getUnresolvedPersonalChallenges($appId);

Get personal challenges organized in categories that are not yet finished

Parameters

appId string

The app id

getAllPersonalChallenges

\SCILL\Model\ChallengeCategory[] getAllPersonalChallenges($appId);

Get personal challenges organized in categories that are not yet finished

Parameters

appId string

The app id

getPersonalChallengeById

\SCILL\Model\Challenge getPersonalChallengeById($appId, $challengeId);

Get personal challenges organized in categories

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

getActivePersonalChallenges

\SCILL\Model\ChallengeCategory[] getActivePersonalChallenges($appId);

Get active personal challenges organized in categories

Parameters

appId string

The app id

unlockPersonalChallenge

\SCILL\Model\ActionResponse unlockPersonalChallenge($appId, $challengeId);

Unlock a personal challenge by product id and challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

activatePersonalChallenge

\SCILL\Model\ActionResponse activatePersonalChallenge($appId, $challengeId);

Activate a personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

cancelPersonalChallenge

\SCILL\Model\ActionResponse cancelPersonalChallenge($appId, $challengeId);

Cancel an active personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

claimPersonalChallengeReward

\SCILL\Model\ActionResponse claimPersonalChallengeReward($appId, $challengeId);

Claim the reward of a finished personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

generateWebsocketAccessToken

\SCILL\Model\SocketToken generateWebsocketAccessToken();

Get an access token for the Websockets server notifying of updates in real time

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

\SCILL\Model\BattlePass[] getBattlePasses($appId);

Get battle passes for the product

Parameters

appId string

The app id

getActiveBattlePasses

\SCILL\Model\BattlePass[] getActiveBattlePasses($appId);

Get active battle passes for the app

Parameters

appId string

The app id

getUnlockedBattlePasses

\SCILL\Model\BattlePass[] getUnlockedBattlePasses($appId);

Get unlocked battle passes for the user encoded in the access token

Parameters

appId string

The app id

getBattlePass

\SCILL\Model\BattlePass getBattlePass($appId, $battlePassId);

Get battle pass for the product with id

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).

getBattlePassLevels

\SCILL\Model\BattlePassLevel[] getBattlePassLevels($appId, $battlePassId);

Get battle pass levels for a battle pass

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).

getAllBattlePassLevels

\SCILL\Model\BattlePassLevel[] getAllBattlePassLevels($appId);

Get all battle pass levels for an app

Parameters

appId string

The app id

activateBattlePassLevel

\SCILL\Model\ActionResponse activateBattlePassLevel($appId, $levelId);

Activate a given battle pass level by id

Parameters

appId string

The app id

levelId string

The id of the battle pass level.

claimBattlePassLevelReward

\SCILL\Model\ActionResponse claimBattlePassLevelReward($appId, $levelId);

Claim the battle pass level id

Parameters

appId string

The app id

levelId string

The id of the battle pass level.

unlockBattlePass

\SCILL\Model\BattlePassUnlockInfo unlockBattlePass($appId, $battlePassId);

Unlock the battle pass for a user

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).