Reserve Digital Passports
Reserve digital passports from your pool for your target customers.
Before you begin
Some digital passports can be reserved from your digital passports pool. This feature is helpful to give versatility to brands. This feature provides a number of digital passport link(s) to reserve for a specific audience from a batch you previously created.
Use case example: Your brand wants to secure 50 digital passports for loyal customers or VIPs.
- When a user scans a code or click on the reserved link, but does not necessarily request the ownership of the digital passport, The digital passport is removed from the pool of digital passport to be distributed. This is secure the claiming experience of each user.
- In the case of many digital passports that have been scanned but not claimed, you can reset digital passports to make them available for distribution again.
- You must trigger an API call per digital passport. Example, if you need the generate 50 individual links, the API must be called 50 times.
![](https://files.readme.io/0d3ea1e-Reserve_NFTs.png)
Let's start 🚀
To reserve 100 digital passports, use the dispenser/distribution/reserveOne
.
The API is authenticated with the user rights required →
certCreate
Parameter | Type | Mandatory | Description |
---|---|---|---|
tags | String | ✅ | Tags to pickup a digital passport and reserve it. Can be 1 tag or a list of tags (see how to format query params array - separated by comma for example) |
format | link , linkObject | ✅ | → link : returns text plain link such as https://arianee.net/passportId,passphrase → linkObject : returns link as .json object |
Result:
httpCode | Description |
---|---|
200 | The digital passport is reserved. |
400 | → Your tag may not exist. → There is not available digital passport to reserve. |
// linkObject return
{
"method": "requestOwnership",
"certificateId": 440105186,
"passphrase": "v6lsj4vhg5dx",
"deeplink": {
"certificateId": 440105186,
"passphrase": "v6lsj4vhg5dx",
"link": "https://test.arianee.net/440105186,v6lsj4vhg5dx"
}
}
// link return
https://test.arianee.net/440105186,v6lsj4vhg5dx
{
"name": "API Error",
"description": "No NFT found to distribute",
"code": "nmp.back.dispenser.oneToOne.noNFTsToSend",
"httpCode": 400
}
Updated 4 months ago