Multi Dimensional Config
Learn how to configure REST Multi-Dimensional Credential
Overview
REST Multi-Dimensional Credential allows you to fetch user data via RESTful APIs and validate eligibility across multiple dimensions. used to retrieve data for the extent of user participation.
Config process
1. Basic Config
- ID Type
ID Type
provides various identity options, including social accounts, blockchain addresses, and other unique identifiers.
- Title
Give your credential an enticing title.
- Credential Source
Choose REST
type and select GET
or POST
based on your API request type.
- Type
Choose Multi Dimension
2. Specify Dimensions
In Multi-Dimensional Credential configuration, you need to define specific dimensions to ensure each dimension is clearly identified and usable.
-
Identifier:
- Enter a unique identifier for the dimension, e.g.,
mainnet_eth_balance
. - The identifier is used for internal calls and logic operations, and it must be globally unique.
- Enter a unique identifier for the dimension, e.g.,
-
Display Name:
- Enter a display name for the dimension, e.g.,
ETH balance on Mainnet
. - This name will be displayed in the UI for user understanding.
- Enter a display name for the dimension, e.g.,
-
Type:
- Select the dimension type
COUNTER
from the dropdown menu.
- Select the dimension type
-
Description:
- Enter a description to explain the purpose of the dimension, e.g., “This dimension tracks the ETH balance of a user on Mainnet”.
- The description must be within 256 characters.
3. Configure API
- Input Endpoint:
GET Request Example:
POST Request Example:
- Add Headers (Optional):
- Input Body (For POST Requests Only):
4. Test API Response
- Input a test address and send the request to confirm the response:
5. Write Expressions
- Token Balance Output:
6. Description
Description of the certificate, supports rich text input, maximum 200 characters.
7. Call-to-Action Link
Guide users to specific operation pages to complete interactive tasks.
8. Participation End Time && Update Frequency (Optional)
- Participation End Time:
Control the time range of the credential, prohibiting new validations after the deadline.
- Update Frequency:
Remind users of the frequency of API data source updates, such as once a day or once every two days.
9. Config Rule
Configure rules in Quest to determine whether users meet the criteria.
- Threshold Evaluation:
When a certain threshold condition is met (e.g., >0), assign a fixed points directly.
- Multiple Entries(Optional):
Enable users to claim rewards repeatedly once certain credentials are fulfilled, for example, a user earns 10 points for each 1 ETH they hold. If the user holds 5 ETH, they will earn 50 points.
Example
ETH Balance Amount
- Specify Dimensions
Identifier:mainnet_eth_balance
Display Name:ETH balance on Mainnet
Type:COUNTER
Description:The amount of ETH you hold on mainnet
- Endpoint
- Request Type
POST
- Headers
No header
- Body
- Response
- Expression