We are excited to announce the release of NFT API v3, bringing enhanced features and performance updates. As part of this update, NFT API v2 is now deprecated, and we encourage all users to migrate to NFT API v3 for continued support and access to future updates.

Key Updates in NFT API v3:

• Contract Owner Management: Easily update the owner of an NFT contract with admin rights using new v3 endpoints.
• Royalty Configuration: NFT API v3 allows you to configure royalties, specifying the recipient’s wallet address and percentage.
• Unlock the Token API: Create ERC20 token contracts and mint ERC20 tokens using the Token API.

Why Migrate?

All future updates, improvements, and new features will only be available on NFT API v3. Staying on v2 means missing out on vital upgrades, including performance improvements, bug fixes, and new capabilities that v3 offers.

By migrating to NFT API v3, you future-proof your platform with advanced features, better performance, and seamless integrations, ensuring you can continue to grow and innovate with Venly’s latest technologies.

Migration Guide NFT v2 ⟶ v3

👍

Click here to read the detailed migration guide on how to migrate to NFT v3.

Reasons for Deprecating NFT API v2

As part of Venly's commitment to providing the best possible developer experience, NFT API v2 has been deprecated in favor of the improved NFT API v3. Here are the main reasons for this change:

1. Enhanced Feature Set

NFT API v3 introduces several new capabilities, such as contract ownership updates, royalty configuration, and integration with the Token API for creating and minting ERC20 tokens. These features were not available in NFT API v2, and the upgrade allows users to access these crucial improvements.

2. Improved Scalability and Performance

NFT API v3 is built with a more scalable and robust framework, optimized to handle higher transaction volumes and deliver faster response times, ensuring a smoother experience for both developers and users.

3. Future-Proofing and Security

To ensure the API remains future-proof, all future updates, security enhancements, and new features will only be made available in NFT API v3. This allows Venly to focus development on a single, more secure service without having to support legacy versions.

4. Streamlined Developer Experience

With a refined structure and simplified endpoint paths, NFT API v3 offers a cleaner and more consistent API experience. For example, the secretType parameter is now replaced by chain, providing a more intuitive setup.

5. Better Integration with New Venly Ecosystem Services

NFT API v3 has been designed to integrate seamlessly with other Venly services, such as the Zapier integration, SiteManager integration, and Shopify integration. This ensures a more cohesive experience across Venly’s suite of products.

By deprecating NFT API v2, Venly is focused on delivering a more advanced and secure API infrastructure, with NFT API v3 becoming the standard for all new developments.

📘

NOTE: We will continue to support the NFT API v2. Meaning a migration is not a must, but we do highly recommend it.

How to access NFT API v2 docs?

• Click here to view the deprecated NFT API v1.0 documentation.
• Alternatively, you can switch between v2.0(deprecated) & v3.0(stable) of our documentation from the top left corner as shown below:
  • The v2.0 includes the deprecated NFT API v2 (Guides + API Reference)
  • The v3.0 has the latest product features including the NFT API v2.

How to Migrate?

👍

Click here to read the detailed migration guide on how to migrate to NFT v3.

FAQs

Q#1: Is there a deadline for migrating from NFT API v2.0 to v3.0, and what happens if I continue using the deprecated version?

Answer: There is no deadline and the v2.0 endpoints will continue to work without any disruptions. Although, we encourage you to migrate to use the latest features.

Q#2: Why should I migrate to v3.0?

Answer: All the new development features like configuring royalties and updating the contract owner will only be released on the NFT v3. Future features will also only be deployed on the v3.0.

Q#3: Can I still access my existing NFTs created with NFT API v2.0 after migrating to v3.0, and will there be any impact on their metadata or functionality?

Answer: Migrating to v3.0 will not affect your existing NFTs and their metadata. All of your existing assets will remain safe.

Q#4: Are there any specific changes in the payload structure for minting requests in NFT-API v2, and how should developers adjust their integrations to comply with the updated specifications?

Answer: We have a migration guide that describes all the changes from v2.0 to v3.0 in detail. Click here to read.

Q#5: What testing options are available for developers to ensure a smooth migration process, and are there any testing environments?

Answer: Developers can use the sandbox credentials (can be found in the Developer Portal) and run the API calls on a sandbox environment to carry out tests safely before deploying to production.

Q#6: How do I configure royalties for an NFT contract?

Answer: Royalties can only be configured on NFT contracts created using the NFT v3 endpoints. Read the guide on how to configure royalties on an NFT contract.

Q#7: How do I update the owner of an NFT contract?

Answer: Read the guide on how to update the owner of an NFT contract.