API Versioning

*Note: All urls mentioned in this document are samples and the actual url will be available once the client subscribes to the product.

The API versioning allows adding new functionality while maintaining the existing one intact.

As development continues, our APIs will support old versions. By default, client requests will always be made against the latest versions of our APIs. However, if you wish to make requests against an earlier version, we offer a way of doing that.

Request Header

For making a request against a specific version, add a custom header attribute in your request titled X-Api-Version with the string value of the desired version.

Our developer portal displays the versions we are supporting, but you may also see a list of supported versions for a particular API in the response header of any request made against it.

Example:

Picture