Tech Corner: API Versioning

Written by Software Engineering Manager Josh Hutter

Welcome to the latest edition of FMTC’s Tech Corner. We’re committed to providing our subscribers with the best tools and resources to acquire and post high-quality, monetized affiliate deals and product links. We are thrilled to introduce a new versioning system with greater stability, flexibility, and transparency that will enhance your API experience.

Why Versioning Matters

APIs are the backbone of modern applications, enabling seamless interactions and data exchange. As FMTC’s technology evolves, our APIs must adapt and improve. However, changes in APIs can sometimes lead to compatibility issues, which is why versioning is essential. This allows us to introduce new features and improvements while ensuring that existing integrations remain unaffected. In other words, upgrading to new features will be on your timeline, allowing FMTC to continue to push innovation forward while giving you the flexibility to upgrade when the time is right for you.

Our New Versioning Strategy

We are excited to announce that FMTC has adopted the Major.Minor.Patch semantic versioning strategy. The version number indicates the type and risk of changes: major for breaking, minor for new features, and patch for small fixes.

• Major Version: Significant updates that may require changes to your existing code. For example, moving up an integer, such as from 3 to 4, indicates a major redesign or new functionality that might not be backward-compatible.
• Minor Version: Enhancements or new features that do not disrupt existing functionality. Upgrading from 3.0 to 3.1 adds new capabilities without affecting current integrations.
• Patch Version: Bug fixes, security patches, and non-disruptive changes to maintain stability and performance. An update from 3.0.0 to 3.0.1 ensures your applications continue to run smoothly.

Choosing the Right Approach

Our new versioning system offers flexibility to choose the versioning approach that best suits your needs. 

• Major Only: Automatically receive the latest updates within that major version series to keep you updated with all the latest features and improvements. This is ideal for those who want to stay on the cutting edge, benefiting from the latest features and improvements as soon as they are available.

• Major.Minor: Lock in to the latest patch available by using the most recent major and minor versions. This is best for those who prioritize stability and want to incorporate bug fixes without introducing new features unexpectedly.

• Major.Minor.Patch: Ensure absolute consistency by specifying the complete version, guaranteeing your integration remains unchanged until you decide to update. This is perfect for those who require a consistent and reliable integration with no changes, ensuring a stable environment.

Our Recommendation

We recommend using the Major.Minor approach for most integrations. This method balances stability and progress, allowing you to incorporate bug fixes and improvements without disrupting your current setup. It provides a smooth transition path as we enhance our API capabilities. FMTC will update a Change Log located in our API documentation when new versions have been released and include a new version page of the affected endpoints. 

Transitioning From Old Endpoints

For users currently utilizing our existing API endpoint, the deprecated endpoint structure will remain active as long as the 3.0.0 endpoint remains active. Requests using the old format will be automatically redirected to the current version (3.0.0):

For more information, see more detailed documentation here. 

As always, a dedicated team is here to assist you! If you have any questions or concerns, feel free to contact your account manager or email us at [email protected]. 

Curious about other FMTC technologies? Find more information on FMTC’s tools in Tech Corner:

• FMTC Tech Corner: New Incremental
• FMTC Tech Corner: API v3
• FMTC Tech Corner: Metadata