🚀 Version Releases

We aim to release monthly incremental updates to the API, with new features and small patches. Those incremental updates do not break any existing code. You do not need to adapt your code to receive these updates: all users of a given version of the API receive those minor updates belonging to that version as soon as the updates go live.

Occasionally, major releases of a new version might happen. Find in this page the answers to your questions about switching to Apicbase API v2:

How do I know if I need to switch from Apicbase API v1 to v2?

Start by creating a list of the specific endpoints that your application currently utilizes. Take a close look at the list of changes provided (those are communicated in the changelog), paying special attention to the global changes, then ask yourself: Do any of these changes offer potential benefits to your operations?

If you identify changes that could positively impact your application or enhance its functionality, then it's highly recommended to make the switch to v2.

How do I know which version of the API I'm using?

It depends on the base URL you are working with: If your base URL contains "v1," you're interacting with a v1 endpoint, the default URL since the API's inception. If your base URL contains "v2," you're accessing the v2 version of that endpoint.

Keep in mind that moving forward, new endpoints will only be introduced to v2 or the current version following major updates. Those endpoints will not be reachable via a "v1" URL.

For how long will v1 remain available?

We have not determined a shutdown horizon: we plan to keep v1 available for the foreseeable future.

It's important to note that while v1 will remain accessible, no new functionalities will be introduced in this version. All v1 endpoints should now be regarded as legacy endpoints and will receive only occasional security updates.

Switching to v2 will break my code. Should I still do it?

Major releases like v2 are specifically designed to introduce breaking changes into the API. Consequently, v2 endpoints are not fundamentally backwards compatible with v1, so there is a possibility that your application will experience disruptions if you choose to make the switch.

Make sure to test every scenario thoroughly to ensure that your application functions as expected in the new environment.

However, it's vital to remember that v1 has now transitioned to a legacy version. While it will continue to function, no new features or functionalities will be introduced for v1. This implies that staying with v1 may limit your access to the latest features and improvements in the long run.

If you require any assistance or have questions about making the switch to v2, please do not hesitate to reach out to us!

I'm starting a new application using the Apicbase API, which version should I use?

You should use v2. Version 2 is not only stable but also the sole supported version at this time, so by using it, you ensure compatibility with the latest features and developments, as well as ongoing support and updates.

When will you introduce a new major version?

We do not have any scheduled major releases, including a v3, on the horizon. Our approach is to initiate a new major version only when enough breaking changes are deemed necessary, justifying its development.

In the meantime, our commitment is to regularly release new features and incremental updates to the API on a monthly basis, as we have consistently done - but those won't disrupt or break any existing code.

How do I look up documentation for a v1 endpoint?

Now that this documentation has v2 as the main version, you need to select the desired version on the dropdown available on the top left corner of the navigation bar to switch between versions.