API Key Scopes
API keys are needed to authorize requests against some of the Crossmint HTTP APIs. By using an API key, Crossmint knows which project is making the call, and can deduct credits off your quota.
API key scopes are the permissions a key has to access or modify certain resources in your Crossmint developer project. It's a good security practice to enable only the permissions you need, and not more.
API keys are not needed to use Crossmint to accept credit card or cross chain payments
Crossmint's payment products do not require API keys. To use them follow the documentation under payments.
API key scopes can be configured from the API Keys section of the developer console. Please note that these are project based and you can have multiple keys with different levels of permissions.
Minting API
Scope | Description |
---|---|
collections.create | Create Minting API collections |
collections.read | Read Minting API collections |
collections.update | Update Minting API collections |
nfts.create | Mint NFTs, SFTs and cNFTs |
nfts.delete | Burn NFTs, SFTs and cNFTs |
nfts.read | Read NFTs, SFTs and cNFTs |
nfts.update | Update NFTs, SFTs and cNFTs |
nfts.mint | Grants all the scopes above. This scope is deprecated but still active for previous developers |
Wallets API
Scope | Description |
---|---|
wallets.create | Create wallets programmatically |
wallets.read | Get wallet addresses |
wallets:nfts.read | Fetch the wallet contents |
wallets:nfts.transfer | Initiate an NFT transfer request from a user wallet |
Payments
Scope | Description |
---|---|
nfts.checkout | Generate a checkout url programmatically |
Updated about 1 month ago