Individual Links
Generate individual links to distribute each digital passport.
Before you begin
The individual links are ideal when brands want to distribute distinct digital passport links or QR codes to each user. Once a customer lands on this link or scans the QR code, the digital passport will be reserved for this customer to avoid a disappointing claiming experience.
These individual links are ideal for distributing digital passports as a gift after purchase for example that is sent via email. Each digital passport is associated with its link which makes your distribution more secure and limits the potential farming of the pool of digital passports.
Use case example: Your brand wishes to send a digital passport as a gift after a purchase for customers.
- When a user scans a code or clicks an individual 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 to generate 50 individual links, the API must be called 50 times.
Let's start 🚀
URL
To distribute your digital passports, use the dispenser/distribution/reserveOne
.
GET - https://{{nmpUrl}}/dispenser/distribution/reserveOne
The API is authenticated with the user rights required →
certCreate
Query Parameters | Type | Required | 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/nftId,passphrase → linkObject : returns link as .json object |
Return Payload
Status Code | Description |
---|---|
200 | The digital passport is reserved and the deeplink to claim the digital passport is returned. |
// 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
Errors
Status Code | Success | Code | Error Message |
---|---|---|---|
400 | false | nmp.back.dispenser.oneToOne.noNFTsToSend | No NFT was found to distribute. |
{
"name": "API Error",
"description": "No NFT found to distribute",
"code": "nmp.back.dispenser.oneToOne.noNFTsToSend",
"httpCode": 400
}
Updated 8 months ago