API Headers

Accept

❗️

Mandatory Header

API Versioning and Media Types

All requests to the Voysis REST API must specify a valid Accept HTTP header. The media type of the request will identify the version of the API that is in use. If a caller supplies a media type that does not specify an exact version then the latest version of the API is assumed. It is recommended that client applications always use version-specific media types to ensure stability.

Example

HTTP

Accept: application/vnd.voysisquery.v1

Forward and Backward Compatibility

To ensure backward compatibility, Voysis will never modify a specific major version of the API in a way that would break clients that understand that version of the API. We may introduce minor revisions to API implementations without incrementing the version number but such changes will not cause interoperability problems with clients as long as the client conforms to these
compatibility rules.

If breaking changes are made, then the major version of the API will change, resulting in a new media type (for example, "application/vnd.voysisquery.v2"). As long as client devices specify the major API version number in their Accept headers, they will not encounter interoperability problems as the API changes.

To ensure forward compatibility for client devices where minor API revisions are
made, clients must allow for the following scenarios:

• A new property may be introduced into an entity. Where a client device does not recognise a property in an object, it should simply ignore it.

X-Voysis-Audio-Profile-Id

❗️

Mandatory Header

The X-Voysis-Audio-Profile-Id header is a required header value that is used as a way of uniquely identifying the device and user. See the section in general concepts for more information on what this value means.

Example

HTTP

X-Voysis-Audio-Profile-Id: f8338e44-9d48-11e7-abc4-cec278b6b50a