Versioning

ApiXV uses two independent version numbers: the version in the URL path, and the release version of the API.

URL version

Every endpoint path contains the major version of the API:

/[product]/api/[version]/...

For example /hotelxv/api/v2/options. The current version is v2.

Within a URL version we aim to keep the API backward compatible. New endpoints, optional parameters and response fields can be added at any time, so build your integration to ignore response fields it doesn't recognise. If a breaking change is unavoidable, we announce it as early as possible.

A new URL version (for example v3) is introduced for changes that can't be made backward compatible. We announce new URL versions well in advance and keep the previous version available long enough for you to migrate. See 1. FAQ - General for our update policy.

Release version

API releases follow semantic versioning (MAJOR.MINOR.PATCH). The current release version is shown at the top of the API reference, and the changes of each release are listed in the Release Notes. It is independent of the URL version (v2).