Intro

This guide outlines the seamless migration from NFT API v2 to NFT API v3, unlocking new features for creators and collectors alike. Migrate now by following the detailed guide which takes you through everything you need to change or update. Unlock new endpoints and features by migrating to NFT v3!

If you have any difficulties migrating, please contact the support team.

Migrating to NFT API v3

1. Base URL Change

The base URL for NFT v3 will become:

https://token-api.venly.io

https://token-api-sandbox.venly.io

2. Path Change for company wallet and media endpoints

For the following endpoints, replace /v2/ with /v3/ in the path:

3. Path change for all other endpoints

In the path of every other endpoint, replace /v2/ with /v3/erc1155/

For example, the endpoint to create a contract:

Before (v2):

POST /api/v2/contracts/deployments

Now (v3):

POST /api/v3/erc1155/contracts/deployments

📘

Apply this path change for all the remaining endpoints.

4. Replace secretType with chain

Replace secretType with chain everywhere, specifically in the path variable and request bodies.

4.1 Request Bodies

Replace secretType with chain in the request bodies for:

• Mint tokens endpoint (POST /api/v3/erc1155/tokens/mints)
• Create token-type endpoint (POST /api/v3/erc1155/token-types/creations)

4.2 Path Params

Replace {secretType} with {chain} in the path of all the endpoints where applicable.

For example, the path to get a contract by blockchain and contract address:

Before (v2):

GET /api/v2/contracts/{secretType}/{contractAddress}

Now (v3):

GET /api/v3/erc1155/contracts/{chain}/{contractAddress}

4.3 Response Bodies

In the response bodies, secretType will be replaced by the chain parameter.

5. Removed Endpoints

The following endpoints from v2 have been removed in v3:

We decided to remove the endpoint mentioned above because of mass minting. Mass minting allows you to mint a huge number of NFTs simultaneously. You don't need to wait for the entire minting process to be completed before getting your response.

Mass minting takes care of the token-type creation request or an NFT mint request, thus eliminating the need to create company/minter wallets.

6. New Endpoints

Endpoints: v2 → v3 mapping

The following table lists endpoint mappings from v2 to v3 in full, along with the differences.

Token API Endpoints (v3)

Testing

Thoroughly test your integration with NFT API v3 in a sandbox environment to identify and address potential issues before deploying to production.