Overview
SuperControl continues to improve the stability, security and performance of its platform. Over time, older APIs and features are replaced with newer and more reliable solutions. To manage this process fairly and transparently, SuperControl follows a structured deprecation and sunsetting policy.
This policy details how we inform clients, the time frame for migration, what occurs during and after deprecation, and where to find alternative options.
Definitions
Any API endpoint, XML feed, integration or feature that SuperControl provides
A solution is still active, but we no longer develop or recommend its use. A newer alternative is usually available.
A solution has been retired and is no longer available. Requests will cease to function after the sunset date.
The date on which we begin warning users that a solution is being replaced.
The date on which the solution is fully retired.
Policy Summary
SuperControl provides a minimum notice period of ninety days for all deprecations and sunsets.
This includes written communication and the use of standard HTTP headers when applicable.
These headers may appear in API responses during the deprecation period:
Indicates that the solution will be retired.
Indicates the planned retirement date.
Security events notwithstanding, SuperControl will not shorten a published deprecation or sunset timeline.
If needed, we may extend the dates to support our clients.
The Deprecation Life cycle
There are four steps in the deprecation life cycle.
They are:
We publish a notice in the Help Centre and may also communicate via release notes, direct email, and in-product messages. The announcement includes
- The solution is being deprecated
- The replacement or recommended alternative
- The deprecation date
- The planned sunset date
We provide guidance to help you move to the newer solution.
This may include documentation, examples or technical assistance where appropriate
As the sunset date approaches, we may send reminder messages to users who continue to use the deprecated solution.
On the sunset date, the deprecated solution is switched off.
Requests will no longer return data.
Responses may include an error message explaining that the solution has been retired.
Behaviour During and After Deprecation
During the deprecation period
- existing integrations continue to work
- responses may include warning headers
- new development against the solution is discouraged
After the sunset date
Once the sunset date has been reached
- the solution is unavailable
- responses may contain an error indicating retirement
- clients are expected to use the replacement solution
Migration and Alternatives
For each deprecated solution, we offer a recommended replacement.
When a migration path exists, we describe
- describe how to transition
- provide compatibility notes
- provide examples or sample payloads
- provide testing guidelines
Versioning Approach
SuperControl recommends using versioned endpoints for new development.
This enables multiple API versions to run simultaneously and minimises disruption when updates are necessary.