NFTs
API information
The nft
resource is managed by the NFTs API.
XPKit Portal
It is recommended configuration
resources are configured in XPKit Portal mint
requests are triggered by your applications directly.
Service URLs
Region | URL |
---|---|
AMER | https://nfts.amer.xpkit.net |
APAC | https://nfts.apac.xpkit.net |
China | https://nfts.china.xpkit.cn |
EMEA | https://nfts.emea.xpkit.net |
OpenAPI Specification
Resource name | Documentation | Download |
---|---|---|
Configuration, NFT | View | Link |
Example NFT configuration
{
"configuration_name": "NFTs for developer conference",
"description": "Configuration used to mint the personalised videos and images. Uses 'XPKit Wallet' from Phantom.",
"blockchain": "solana",
"blockchain_options": {
"wallet_auth": "private_key",
"private_key": "<redacted>",
"network": "mainnet-beta",
"grant_ownership_to_profile": false
}
}
Notes on configuration
s
- Currently the Solana blockchain is supported.
- It is never recommended that you distribute private keys however XPKit needs access to your wallet to pay blockchain minting fees.
- We highly recommend that you create a wallet specifically for XPKit usage that contains only the amount of cryptocurrency needed to fulfil your minting requirements. Do not provide your primary wallet.
Example NFT mint
request
curl --location --request POST 'https://nfts.emea.xpkit.net/api/nft/mint/' \
--header 'Authorization: Bearer <redacted>' \
--form 'nft=@"/path/to/file/bill_prize_winner.jpg"' \
--form 'thumbnail=@"/path/to/thumbnail/bill_prize_winner_thumb.jpg"' \
--form 'nft_name="Bill wins first prize"' \
--form 'configuration_id="nfts-for-developer-conference"' \
--form 'profile_id="14e95b67-c928-48bd-b03d-9266c93e71f5"' \
--form 'experience_id="developer-conference-2022"' \
--form 'nft_metadata="{\"colour\": \"red\"}"' \
--form 'grant_ownership_to_profile="true"'
NFT files and thumbnails
- When making a
mint
request either nft (file) or nft_location (web address) can be provided. Regardless of the method chosen the file will be uploaded to an Amazon S3 bucket where it will remain permanently. - You can provide an optional thumbnail image of the asset to be minted. Much like the NFT itself either a file or location can be provided: thumbnail or thumbnail_location.
Ownership of minted asset
By default a mint
request will mint the asset and assign ownership to the wallet provided in the configuration
. You may wish to override this behaviour and grant ownership to an XPKit profile
. To do this two things are required:
- XPKit needs to know the wallet address that should be granted ownership. Inside an XPKit
profile
there needs to be a blockchain_options.public_key field. Example:
{
"blockchain_options": {
"public_key": "<wallet address goes here>"
}
}
- In the
mint
request provide the ID of theprofile
that should be used (profile_id) and set a param called grant_ownership_to_profile to true
Notes on mint
requests
- The maximum permitted size for uploaded assets is 150MB.