ZOLOZ uses URI-based API versioning. Compatible changes are introduced within an existing version, while incompatible changes require a new version.
The ZOLOZ service includes the version number in the HTTP URI path to version an API. For example, https://zoloz_api_host/api/v1/products.
Compatible changes are introduced into an existing API version, while a new API version is released when incompatible changes are introduced.
When a new version is released, you can continue using the existing version or upgrade to the new one. If you continue to use the existing version, you must properly handle the compatible changes to the API.
The following compatible changes may be introduced to an existing version:
-
A new optional field is added to the request.
-
A new valid value is defined for a request field.
-
The maximum allowed length of a request field increases.
-
A new field is added to the response.
-
The order of the fields of the request or the response changes.