Summary

SoQuest supports verified project owners to add custom task templates in the Dashboard. These templates require users to complete interactions in your designated product and use your API as verification. This type of custom interface is suitable for third-party action verification, such as registration, login, or using a certain function of your product.

When SoQuest verifies user actions, it passes the user's address as a parameter and requests the interface you have implemented. You only need to return true of false. the verification result, and SoQuest will determine whether the user's action passes the verification based on the result returned by your interface.

Technical Specs

When submitting a Custom Task Template, it is necessary to provide the correct API URL. The system will automatically test your API to verify that it returns in correct format. Once the review is completed, the title, jump link, and API URL of your customized task type cannot be modified.

Please ensure that:

  1. The API you provide is an open API that does not require any API key or login verification.
  2. Your API interface remains stable and can be easily request at any time.

Interface Pattern:

https://<domain>/<request_path>

When making a request, SoQuest will use the GET method to request the interface and attach a "address" parameter.

GET https://<domain>/<request_path>?address=<address>

The result should be as follows:

// Case 1
{
	   "code": 0, // 0 - No Errors
	   "message": "OK" // feedback message
     "data": { // the result of user action
         "result": <true | false> // bool, true for success, false for fail
     }
}

API Example