RE:VIVE
If you wish to use RE:VIVE before its official release, please reach out to [email protected] to request early access as the product is currently under development.
Welcome to the RE:VIVE - Redeem as Settlement section of the API documentation. The RE:DREAMER API documentation below outlines the essential steps to enable your end-users to utilize NFTs as settlement in your web store.
Redemption process:
- 1.Select "NFT Redemption" as your preferred settlement method at checkout.
- 2.The shop will initiate a request to create an RE:VIVE order.
- 3.You will be redirected to the RE:DREAMER website.
- 4.On the RE:DREAMER website, connect your wallet.
- 5.A list of available NFTs for the order will be displayed.
- 6.Choose an NFT to redeem.
- 7.RE:DREAMER will redirect you back to the shop after the redemption process is complete.
To make use of RE:VIVE, a redemption protocol smart contract called RE:ALM is required. You will need to pass the address of your RE:ALM smart contract as
realm_address in the request body parameter to create an order. Please contact our team at [email protected] to obtain the realm_address.To initiate an order for the product that the end-user wishes to redeem, send a POST request to the following endpoint:
post
/api/v1/revive/:network/orders
Create an Order
Create an order for the product that the end-user wishes to redeem.
Parameters
Path
network*
String
Unique identifier of the network. Please refer to the "Network" section located on the "General" page for more information.
Header
x-api-key*
String
API key.
Body
contract_addresses*
Array of String
A list of eligible NFT smart contract addresses that can be used for settlement.
custom_id*
String
The unique identifier of the order, as provided by the shop owner.
item_name*
String
The name of the item that the end-user wishes to redeem.
item_url*
String
A URL of the image of the item that the end-user wishes to redeem.
redirect_link*
String
A URL that the end-user will be directed to after the redemption process is complete and has been broadcasted to the blockchain network.
realm_address*
String
The address of the redemption protocol smart contract that is specifically created for the redemption operator.
Responses
200: OK
To obtain details about a created order, issue a GET request to the specified endpoint:
get
/api/v1/revive/:network/orders/:uuid
Retrieve Order Details
Get detailed information about a created order.
Parameters
Path
network
String
Unique identifier of the network. Please refer to the "Network" section located on the "General" page for more information.
uuid
String
The unique identifier of the order for which the information is being retrieved.
Responses
200: OK
To retrieve the list of NFTs eligible for redemption for a specific order, send a GET request to the following endpoint:
get
/api/v1/revive/:network/nfts
List NFTs for an Order
Returns a list of eligible NFTs owned by the connected wallet for a specific order.
Parameters
Path
network*
String
Unique identifier of the network. Please refer to the "Network" section located on the "General" page for more information.
Query
order_uuid*
String
The unique identifier of the order for which the list of eligible NFTs is being retrieved.
Header
Authorization*
String
Bearer ${token}. Replace ${token} with the actual JWT.Responses
200: OK
To use the selected NFT as settlement, send a POST request to the following endpoint:
post
/api/v1/revive/:network/redemption
Use an NFT as settlement for specific order
Settle an order by redeeming the selected NFT.
Parameters
Path
network*
String
Unique identifier of the network. Please refer to the "Network" section located on the "General" page for more information.
Header
x-api-key*
String
API key.
Body
contract_address*
String
The address of the smart contract for the selected NFT.
custom_id*
String
The unique identifier of the order, as provided by the shop owner.
order_uuid*
String
The unique identifier of the order for which the list of eligible RNFTs is being retrieved.
redeemer_address*
String
The address of the user.
realm_address*
String
The address of the redemption protocol smart contract that is specifically created for the redemption operator.
token_id*
Integer
Unique identifier for an NFT within a specific smart contract.
user_input_data*
JSON Object
Additional key-value pairs
{"key":"value",...} which can be used to store shipping information.Responses
200: OK
Last modified 2mo ago