Redeem Console

Welcome to the Redeem Console section of the API documentation. RE:DREAMER Lab provides the Redeem Console dashboard to manage campaigns and API keys. It is available on 2 domains:
Mainnet (https://console.redreamer.io/)
The Mainnet domain provides access to the live blockchain network and should be used for production applications.
Testnet (https://console-testnet.redreamer.io/)
The Testnet domain is intended for developers to test their applications in a sandbox environment. This domain operates on a separate test network.
To use the functions in Redeem Console, click on the Login button located under the profile icon and connect your wallet address.
Redeem Console Login
Redeem Passport
To create a new Passport's campaign, follow these steps:
1.Click on the "PASSPORT" menu.
2.Click the "Campaign Manage" menu.
3.Click the "Create" button.
4.Set the campaign parameters.
5.Click "Save" to complete the process.
Passport Campaign Configurations
Parameter
Description
Network
Unique identifier of the network.
Image url
The image for the campaign. It is recommended that the image size should not exceed 3MB with a resolution of 1920x1920px (1:1 ratio). Accepted formats are JPG, PNG, or GIF.
Campaign Name
The name of a campaign.
Description
The description of a campaign.
Start Time
Exact time when a campaign should begin.
End Time
Exact time when a campaign should end.
Maximum Validated Count
The maximum number of times an NFT redemption can be validated as part of a campaign.
Redeem Methods
Please refer to the Redeem Methods table below.
isPublic
When querying campaigns, only campaigns that are marked as public will be returned.
Validated Description
The description will be displayed on the PASSPORT QR code page.
Redeemed Description
The description will be displayed after a successful redemption.
Webhook Url
When a redemption occurs, an event will be emitted to the specified webhook URL.
Requestable Contract addresses
The addresses of NFTs that are eligible for redemption.
Passport Redeem Methods
Method
Description
Validate QR Code
Display a QR code which needs to be validated.
Only Show Description
Display the text specified in the Redeemed Description parameter. This text can provide information on the next steps required, such as instructions for claiming a reward or accessing a service, or any other relevant details.
Show Plain Text
Show a plain text. This option is used when an NFT can be redeemed for a promotional code, and the code needs to be displayed as plain text.
Redeem Center
To create a new Redeem Center's campaign, follow these steps:
1.Click on the "REDEEM CENTER" menu.
2.Click on the "Campaign Manage" menu.
3.Click the "Create" button.
4.Click "Save" to complete the process.
5.Set the campaign parameters.
Redeem Center Campaign Configurations
Parameter
Description
Network
Unique identifier of the network.
Image url
The image for the campaign. It is recommended that the image size should not exceed 3MB with a resolution of 1920x1920px (1:1 ratio). Accepted formats are JPG, PNG, or GIF.
Campaign Name
The name of a campaign.
Description
The description of a campaign.
Start Time
Exact time when a campaign should begin.
End Time
Exact time when a campaign should end.
Redeem Methods
Please refer to the Redeem Methods table below.
isPublic
When querying campaigns, only campaigns that are marked as public will be returned.
Requestable Contract addresses
The addresses of NFTs that are eligible for redemption.
User Input Data Schema
The schema defines the data fields that must be completed during redemption, usually to gather shipping information.
Redeem Methods
Method
Description
Redeem with Mark
After the redemption process is completed, the NFT will be marked as redeemed.
Redeem with Transfer
Once the redemption process is completed, the NFT will be transferred to the designated address.
Redeem with Burn
After the redemption process, the NFT will be permanently removed from circulation (burned).
Manage API Key
To authorize your wallet for creating API keys, please contact our team at [email protected].
To create a new API key, follow these steps:
1.Click on the "API key Manage" menu.
2.Click the "Create" button.
3.Enter the desired name for the API key.
4.Select the scope.
5.Click "Save" to complete the process.
Scopes
For security reasons, scopes can be added or removed to limit the API functions that can be accessed by an API key. The available scopes are as follows:
Scope
Description
passport:campaign:read
Permission to get Passport's campaigns.
passport:campaign:write
Permission to create Passport's campaigns.
passport:redeem
Permission to redeem NFT for Passport's campaign.
passport:validate
Permission to validate the code created from NFT redemption for Passport's campaign.
passport:report:read
Permission to get Passport's report.
redeemcenter:campaign:read
Permission to get Redeem Center's campaigns.


​

Parameter	Description
Network	Unique identifier of the network.
Image url	The image for the campaign. It is recommended that the image size should not exceed 3MB with a resolution of 1920x1920px (1:1 ratio). Accepted formats are JPG, PNG, or GIF.
Campaign Name	The name of a campaign.
Description	The description of a campaign.
Start Time	Exact time when a campaign should begin.
End Time	Exact time when a campaign should end.
Maximum Validated Count	The maximum number of times an NFT redemption can be validated as part of a campaign.
Redeem Methods	Please refer to the Redeem Methods table below.
isPublic	When querying campaigns, only campaigns that are marked as public will be returned.
Validated Description	The description will be displayed on the PASSPORT QR code page.
Redeemed Description	The description will be displayed after a successful redemption.
Webhook Url	When a redemption occurs, an event will be emitted to the specified webhook URL.
Requestable Contract addresses	The addresses of NFTs that are eligible for redemption.

Method	Description
Validate QR Code	Display a QR code which needs to be validated.
Only Show Description	Display the text specified in the Redeemed Description parameter. This text can provide information on the next steps required, such as instructions for claiming a reward or accessing a service, or any other relevant details.
Show Plain Text	Show a plain text. This option is used when an NFT can be redeemed for a promotional code, and the code needs to be displayed as plain text.

Parameter	Description
Network	Unique identifier of the network.
Image url	The image for the campaign. It is recommended that the image size should not exceed 3MB with a resolution of 1920x1920px (1:1 ratio). Accepted formats are JPG, PNG, or GIF.
Campaign Name	The name of a campaign.
Description	The description of a campaign.
Start Time	Exact time when a campaign should begin.
End Time	Exact time when a campaign should end.
Redeem Methods	Please refer to the Redeem Methods table below.
isPublic	When querying campaigns, only campaigns that are marked as public will be returned.
Requestable Contract addresses	The addresses of NFTs that are eligible for redemption.
User Input Data Schema	The schema defines the data fields that must be completed during redemption, usually to gather shipping information.

Method	Description
Redeem with Mark	After the redemption process is completed, the NFT will be marked as redeemed.
Redeem with Transfer	Once the redemption process is completed, the NFT will be transferred to the designated address.
Redeem with Burn	After the redemption process, the NFT will be permanently removed from circulation (burned).

Scope	Description
`passport:campaign:read`	Permission to get Passport's campaigns.
`passport:campaign:write`	Permission to create Passport's campaigns.
`passport:redeem`	Permission to redeem NFT for Passport's campaign.
`passport:validate`	Permission to validate the code created from NFT redemption for Passport's campaign.
`passport:report:read`	Permission to get Passport's report.
`redeemcenter:campaign:read`	Permission to get Redeem Center's campaigns.

Last modified 23d ago