API version control

As part of HCM9, we are implementing versioning of our APIs.  We will be introducing v1 versions of all our APIs.  So from HCM9 onwards you can make a call to our APIs as you do now but in addition you should also call our APIs as a v1 version (specifying “v1” in the URL), which will lock your calls into that discrete version.  This means that the non-version stated API call will always use the very latest released upgrade or amended version.  So, to protect your integration, it is recommended that you specify the version as “v1” in the URL and then should you wish to take advantage of a later version, you can update your URL to that version.  This will protect you from breaking changes going forward.   We will then deprecate older versions of the APIs in due course but will publish details of this separately. 

An example URL that uses version notation would be:

https://apidev.hcm.zellis.com/zy01/external/odata/v1/Workers

as opposed to current calls which would look like this:

https://apidev.hcm.zellis.com/zy01/external/odata/Workers

Deprecation

Should Zellis have a need to deprecate a specific version of an API we will update the release notes for a given release with a stated target date for deprecation.  The intention would be to provide at least six months (one full HCM release cycle) notice of a pending deprecation.