API versioning
API versioning explained
All API endpoints contain a numbered version in the URL. Whenever breaking changes are made to the API, a new major version will be created. A new version will not be created for non-breaking changes.
https://api.crbcos.com/core/v1/cm/customersBreaking changes | Non-breaking changes |
|---|---|
Adding new required fields to request | Adding new optional fields to request |
Changes to the response format | Adding new fields to response |
Data type changes | Adding new values to fields (e.g. a new status value) |
Modifying an endpoint URL | Bug fixes |
Removing endpoints | Adding new endpoints |
Deprecated Versions When we release a new major version, we will continue to support the previous version for a period of at least 6 months before it is deprecated.