Introduction

Explore the APIs and test them live from the browser

This section provides a detailed guide for each of the APIs, with sample code and responses.

Testing the APIs from the browser

The reference pages allow you to call the APIs directly from the browser. To get started:

1. Create a developer account on the Staging or Production consoles. Read more about the environments here.
2. Create an API key from the API keys tab on the console, with the permissions required for the APIs you want to use.
3. From the page of your API of choice, insert the right API key in the authorization slot, introduce the different parameters, and call “Send”.
4. (Optional) To call APIs in the production environment, find the API endpoint selector (⌄) next to the endpoint URL, and change it to www.crossmint.com/api.

The following guide will show you how to create a wallet and mint an NFT into it within 5 minutes. For this, make sure your API key has the scopes wallets.create, and nfts.create.

1. Creating Wallets from the API Reference

Follow the next steps to create a wallet within 5 minutes:

1. Navigate to the Create Wallet page

   
2. Select the correct environment for the API key you created

   
3. Input your API key into the Authorization section

   
4. Input the body parameters

   You may add any additional properties. Each API reference page includes the full list of properties and admissible values.

   
5. Send the request

   Scroll back to the top of the page and click the blue Send button to trigger the API call.

   

   Here is an example response object:

   

Success! The next guide will show you how to mint an NFT into this wallet and view the content.

2. Mint NFTs from the API Reference

In the previous guide, you created a wallet. Now you will deliver an NFT into it and read the wallet’s content.

1. Navigate to the Mint NFT page

   Open in a new tab here: /api-reference/minting/nfts/mint-nft

   
2. Enter the default-polygon collectionId

   This is a default collection associated to your account. You can create new ones using the Create Collections API.

   
3. Select the [EVM] Metadata URL metadata option

   The selector to choose between the different metadata option can be hard to spot. Look closely at the screenshots below to see where it is.

   

   
   

   
4. Enter metadata URL

   You can provide your own or use this example URL:

   metadata URL

   https://bafkreidbf4jpxpecwezjbagwmua5qv62ifhhtzsspoml7zls6iq6ms4byi.ipfs.nftstorage.link/
   

   
   

   This URL must point to a valid JSON file that adheres to EVM metadata standards.

   
5. Enter the recipient

   There are two options for the recipient parameter. The first enables minting to an email address. The second enables minting directly to a wallet address.

   email recipient

     // format
     email:<email_address>:<chain>
   
     // example
     email:[e-mail]:polygon
   

   
   

   Enter your own email address on this step and you can login to see your NFT in the Crossmint wallet later, which can be accessed from crossmint.com or staging.crossmint.com if you are in staging.

   
6. Set reuploadLinkedFiles to false

   This will prevent unnecessary uploading of files that are already pinned to IPFS.

   Crossmint has a 10MB re-upload size limit. For larger files, upload your media to IPFS, create a metadata.json as shown above, submit the metadata file’s URL, and ensure reuploadLinkedFiles is set to false.

   The default option is true.

   
7. Send the request

   Scroll back to the top of the page and click the blue Send button to trigger the API call.

   

   Here is an example response object:

   
8. View the NFT in your wallet

   If you followed this guide closely you can view the NFT in the staging wallet at https://staging.crossmint.com/user/collection.

   If you minted directly to a wallet address you can view the NFT in that application. Ensure you are accessing it from a testnet if you used staging.