OVERVIEW¶
The VIDEO INFORMATION SERVICE (VIS) provides numerous APIs and functionalities which allow you to orchestrate a streaming solution by connecting various services together.
Not all services will be used for a deployment, and it instead depends on the client needs.
Global Requirements¶
Authorisation: Every call to the VIS API requires an API-KEY header to authenticate agains the setup. You can provide this as either of the formats below:
API-KEY: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
X-Auth-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
If you fail to provide a valid API key for the client you will recieve a 401 Unauthorised
Transaction IDs: Every call to the VIS API can have an optional Transaction ID to identify the request. This header, if provided, will persist on the API response, alongside any other content.
X-Transaction-ID: my-transaction-id
Route Prefix:
Every API route has the prefix /api/
. This means that a documented as GET /channel/
will required a GET request to http://server.url.com/api/channel/
Failure to account for this will result in a 404 Not Found