Articles on: Getting Started

API Deprecation policy

Quortex I/O comes with a fully documented API that allows you to fully automate the platform.

API deprecation is the process of progressively discontinuing an API.
It starts by informing customers that the API is no longer actively supported even though it remains operational for a while.
A migration path is proposed.
Eventually, the deprecated API is no longer functional.
This article describes the Quortex.io API deprecation policy.

Why do we deprecate ?



In a continuous improvement process, reasons to deprecate an API are multiple, typically:
Support new use cases
Improve the security
Increase the efficiency and performances
Simplify maintenance activities

How do we inform customers ?



Customers are informed by email about a deprecation plan, specifying the reason for a change and the impacted parts of the API.
The API documentation is updated to specify deprecated parts from the announcement date.
Articles in the HelpCenter are also be added to explain the benefits and how to migrate to the new API.

Sunset period



The sunset period is the delay between the deprecation announcement and the date when the deprecated API ceases to function.
This period is specified in the deprecation announcement.
Both the deprecated and the replacing API are operational during the sunset period to allow customers planning their transition.

Email reminders about the deprecation before the deadline.

Migration



The API documentation and HelpCenter articles provide guidance about how to migrate.
Our support is also available to help about any question related to a transition.

Beta API



New features may imply a beta API, meaning that the API may evolve without deprecation.

Updated on: 03/02/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!