Interface specification

See the interface specification. You can use the Export command to have the client side of the application generated in different programming languages. A mock REST API is also available for development. For easy manual testing of the REST API, import the interface specification in OAS format into Postman.

The specification also applies to the ALVAO Service Desk Enterprise API module.

Versioning

Versions of the REST API are identified by major and minor version numbers, e.g., 1.1, 1.2, etc.

This version of Alvao contains the following versions of the REST API:

ALVAO version	REST API version
25.1	1.3

The URL of a particular version of the REST API contains its major version number, e.g., https://contoso.onalvao.com/AlvaoRestApi/v1/ for major version one. Although only major version one has been released so far, future Alvao releases may host multiple major versions of the REST API, distinguished by the major version number in their URLs.

Each minor version merely adds new functionality to the previous minor version and maintains backward compatibility with all previous minor versions of the same major version. E.g., an application designed for REST API version 1.2 will work on version 1.3 and all subsequent minor versions. To get the current minor version number, call the root endpoint of the REST API using the GET method.

Compatibility between major versions is not guaranteed.