REST API Action Integration Spec

This specification defines how to integrate via REST endpoints to validate the eligibility for specific actions.

Request

When an action needs to be validated, the system will send a GET request to the specified endpoint.

Request Configuration

• Endpoint URL (required)

  • e.g., https://api.example.com/validate-quest-action

• Request Header Values (optional), for authentication purposes. Use hyphens to separate words, not underscores

  • e.g., header-key: value

  • e.g., header-key2: value2

• Query Parameters in the Request (required)

  • address (mandatory): The address to validate

CURL Example:

curl -X GET \
  'https://api.example.com/validate-quest-action?address=0x5853eD4f26A3fceA565b3FBC698bb19cdF6DEB85' \
  -H 'header-key: value' \
  -H 'header-key2: value2'
 

Response

The endpoint should return a JSON-formatted response.

Successful Case

If the action is validated successfully, return a 200 status code and the following JSON response:

{
  "status": "success"
}

Failed Case

If the action validation fails, return a 200 status code and the following JSON response:

{
  "status": "failed"
}

Error Case

• If the request input is invalid or required parameters are missing, return a 4xx status code.

• If an internal error occurs on the endpoint, return a 5xx status code.

The error response may include a message key to provide additional error information, but it is not required.

{
  "status": "error",
  "message": "Invalid request parameters"
}

By implementing this specification, you can develop a REST endpoint to validate specific actions. The system will send requests to your endpoint, and your endpoint should return the corresponding JSON response and status code based on the validation result for the action.