API Lifecycle Policy
Policies regarding the lifecycle of our API services
To ensure that we can deliver a consistent and best experience for our customers, Roaring phases out API versions marked as deprecated four times a year (March 1st, June 1st, September 1st, or December 1st).
Affected customers will be notified at least six months before phasing out to allow ample time for planning and upgrading. Full support is always provided for the latest API version, and notices about deprecations will be available in our change log to inform the customer when it’s time to change versions.
For the customers using retired API versions, there will be price adjustments in several levels, and Point 4 “Remedy for Failure to Meet Target Availability”, in Roaring's SLA will be excluded from the SLA after the retirement date.
Stage 1 - Published API version
Roaring publishes new API:s and versions on a steady basis. A published API version is a stable version ready for consuming from client applications. Full support is always given to the latest API version.
Stage 2 - Deprecated API version
A deprecated API is the second stage of Roaring's API lifecycle. Information about deprecated API versions will be communicated via our change log at app.roaring.io and to specific selected e-mail registered by the customer. Customers are no longer recommended to use this version, though it is still operational. At this stage the customers are encouraged to switch to the newer API version that is published.
Roaring will hold a deprecated API version alive for at least 6 months after notice before it becomes retired. The most common reasons for deprecation are that the feature has been replaced by a more powerful alternative feature.
Stage 3 – Retired API version
A retired version is the last stage of Roaring's API lifecycle. When an API version has been marked as retired it should no longer be used, and the customers should have switched to the latest API version at this stage. Some of the services in Roaring's Service level Agreement (SLA) will no longer be valid at this stage.
In order to make sure that we are able to maintain the retired API until all customers have switched, we conduct price adjustments when these are deemed appropriate.
Receiving notifications from the change log
To receive notifications on our latest releases, deprecations and retirements of API versions, please add and/or edit your notification settings in the web app, following these steps:
- Go to "Admin" and then "Notifications"
- Add a receiver of notifications using the green button on the top right.
- Edit notification settings by clicking the three dots next to your name, and then click "Edit".
- Choose your new settings and click "Save".