Setting up Game Data Hub API (In-depth)
Last updated
Last updated
Game Data Hub API serves as a bridge between third-party applications and the DeQuest platform. It allows for the secure collection, storage, and validation of user achievement data from third-party services (in this case Games) with the aim of using this data to confirm the completion of quests (in-game activities) by users on the DeQuest platform.
First of all, an admin and a developer of a game should decide which data is needed and can be provided via Game Data Hub.
After that, an admin creates an API key for authentication access to GDH API routes via the Admin Panel. To create a key go to the Game Data Hub page and press “+ New key”.
After the “+ New key” button is pressed, the key is created and a modal window appears to give an admin the opportunity to copy the key to share it with the developers of the game.
Important! The “Created API key” modal appears only once and can be copied only once as well. After the “Close” button is pressed, the key can’t be copied or seen again. The reason is to ensure secure data access. Created keys can be deleted.
The next step for an admin is to create a scheme. A scheme contains all the data that will be provided by the game with the help of the key, created in the previous step.
A scheme consists of a scheme name, a user identification type and keys.
A scheme name should be unique to avoid confusion when creating quests.
A user identification type is needed to identify a user and to check required data about him, at the moment when this user will try to pass a quest based on the data.
Key is a list of property names and types received from the third-party service. An admin can create one or several keys for one scheme. It depends on the way the game uses it to transmit data.
To create a key, an admin should write a key name (e.g. shots) and a type - a number or a string. A key name and a type should be the same as those used by the game developer in the code of the implemented GDH API.
The created key as well as information about schemes should be copied and sent to the game developer to be implemented into their platform code to ensure secure and authorized access to Data which will be used to create quests on DeQuest.
Check DeQuest's .
After keys and schemes are created and implemented in the game's code, quests can be created. Check for more information.
