Versioning and Backwards Compatibility
Your API version controls the way the Sigma API works for you, including which endpoints are available, what parameters they expect, and how they respond. Each Sigma App's API version is set when it's created. When we make changes to the API that aren't backwards compatible, we'll introduce a new version which you can opt in to when you're ready.
Backwards Compatibility
We often make additions and improvements to the API without introducing new versions. We call these changes "backwards-compatible". Your Apps should continue working when we make these additions and improvements.
The following additions and changes may be made to any version of the Sigma API:
- Adding new API endpoints
- Adding new optional request parameters to existing API endpoints
- Adding new properties to existing API responses
- Changing the order of properties in existing API responses
- Changing the length or format of object IDs or other opaque strings
- Adding additional error codes to any API endpoint
Versioning
Every App is assigned to the latest version of the Sigma API when it's created. When newer versions become available, you can manually opt to upgrade to newer versions in the Admin Dashboard.
At any time you can opt to use a newer version of the API by including a Sigma-Version header with the date of the version to use:
curl -H "Sigma-Version: 2019-02-28" https://api.sig.ma/v2/merits/TODO
When you don't pass a Sigma-Version header the API will always use the the API version set for your App in the Admin Dashboard.
Updated over 5 years ago