Redeem Console
Last updated
Last updated
Welcome to the Redeem Console section. RE:DREAMER Lab provides the Redeem Console dashboard to manage campaigns and API keys. It is available on 2 domains:
Mainnet () The Mainnet domain provides access to the live blockchain network and should be used for production applications.
Testnet () 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.
To create a new PASSPORT's campaign, follow these steps:
Click on the "PASSPORT" menu.
Click the "Campaign Manage" menu.
Click the "Create" button.
Set the campaign parameters.
Click "Save" to complete the process.
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.
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.
To create a new API key, follow these steps:
Click on the "API key Manage" menu.
Click the "Create" button.
Enter the desired name for the API key.
Select the scope.
Click "Save" to complete the process.
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:
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.
To authorize your wallet for creating API keys, please contact our team at .
