Versioning
We follow the globally accepted semantic versioning for Sandbox API. Below is an example
Type | Compatibility | Current Version | New Version |
---|---|---|---|
Major | Backward-non compatible | 1.0.0 | 2.0.0 |
Minor | New functionality added, backward compatible | 2.0.0 | 2.1.0 |
Patch | Bug-fix in the current version, backward compatible | 2.1.0 | 2.1.1 |
Specifying API Version
By specifying a version in a request, you can get expected responses regardless of future changes to the API. This can be done via the x-api-version
header.
API requests without any version specification go to the latest stable version.
Deprecation
Any major changes in the API are communicated in the Changelog while minor changes are communicated in the API Document. Major changes always lead to the previous version being deprecated and eventually discontinuance.
The dates for discontinuance are communicated in the Changelog and API Docs.
Updated 3 months ago