API Versioning

HCSS APIs use URI path versioning.  This means that the API version must be explicitly set for every call.  For example:

https://api.hcssapps.com/heavyjob/api/v1/employees

The above URI references the v1 employee endpoint from HeavyJob API.  Changes to a published endpoint will be backwards compatible.  This means that we might add new data to an API in the future, but we will make every attempt to not remove or rename fields.

If the shape of the API needs to change substantially, we will introduce a new version by changing the version in the URI path.  For example, a version 2 employee endpoint might be:

https://api.hcssapps.com/heavyjob/api/v2/employees

In some rare cases, breaking changes are necessary (e.g., to fix security issues), and we will communicate those changes with you.