Authentication

OCTO uses Bearer authentication. To authenticate your requests, you will need to send an API key as a Bearer token in the Authorization header of your request:

GET /octo/supplier HTTP/1.1
Host: api.ventrata.com
Authorization: Bearer {your_API_key}

The Supplier will be able to issue you an API key by creating a connection against the Reseller account they have created for you in their Ventrata system, which is also where they will define which Products you have access to, applicable pricing, etc.

The API key will be a UUID value that looks like this: 5bd1629a-323e-4edb-ac9b-327ef51e6136

Note that in Ventrata's implementation of OCTO, the API key provides access to a single supplier. You will have different API keys for each supplier you'd like to connect with.

To obtain the API Key for Ventrata's test supplier account to use during development, see Testing Credentials.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

API requests without authentication will also fail. If the token is invalid or is deactivated by Supplier a 403 Forbidden error will be returned.

API keys must be kept secure. You are responsible for any bookings made using your API key. If your key is disclosed publicly ask the Supplier to delete your connection and re-create it as a new one, or reach out to [e-mail] to have your key rotated.

Every POST, PATCH and DELETE request must use Content-Type: application/json header and the request body must be a JSON-encoded string. Every endpoint will return JSON unless otherwise stated.