API Standards

How to Integrate External APIs for Degame Quest Verification

Overview

DeGame allows the community to verify whether a user has completed a specific task using an open API. The verification data is not accessible to DeGame and requires the project team to provide an API interface for DeGame to access, such as verifying the number of hours a user has played in the game.

Process

DeGame calls the API provided by you to verify if a user has completed a task. It passes the user address and verification ID as parameters. The functionality of the API is to verify whether the user has completed the task. The API returns "True" to DeGame if the task is completed. If the task is incomplete, the API returns "False" to DeGame.

API Description

• The API must be an open API and should not require an API key.

• The interface request type is GET with the following parameters:

📌 2.1. verifyId: Type - string, an optional field, an additional field that can be used for verifying if the user has played a game for a certain number of hours. For example, passing a verifyId of 5 represents verifying if the user has played the game for over 5 hours. You can determine the specific functionality.

📌 2.2. verifyAddress: Type - string, required field, used to verify if the user's address has completed the task. It supports EVM addresses, Solana addresses, and email addresses.

• API Response:

📌 3.1. result: Type - boolean, the validation result. "true" indicates a successful validation, while "false" indicates a failed validation.

📌 3.2. msg: Type - string, a description of the validation result. If the validation fails, the "msg" field should provide the reason for the failure.

API Request Example: https://test.com/test?verifyId=&verifyAddress=[e-mail]

Response Example：

{

"code": 200,

"msg": "success!",

"data": {

"result": false,

"msg": "fail, address is error"

}

}