Getting started

What are Digital Platform APIs?

The Digital Platform APIs are a Vista cloud-hosted set of APIs which allows your sales channel applications to query data and sell tickets, food and beverages, and more for your cinemas.

The APIs available include:

  • Omni-Channel API (OCAPI): A feature-rich API home to all new and future features.
  • Connect V1/V2 API: Legacy endpoints available for existing on-premises workloads to transition to the Digital Platform and OCAPI.

The API documentation on this website only refers only to the OCAPI endpoints.

The on-premises Connect WSVistaWebClient V1/V2 API documentation can be found in the legacy API docs website.

Access and support

If you'd like to get access for your cinema, or if you have any questions, please talk to your local Vista representative.

Authorisation

All requests to OCAPI endpoints must be accompanied with an authorisation token. Please refer to Authentication for details on how to obtain authorisation tokens.

Intended usage

Secure client access

Unless otherwise specified, OCAPI endpoints are designed to be safely accessed by both back-end and public facing front-end client machines.

Rate limiting

Digital Platform will enforce rate limits on certain endpoints that could return sensitive information. Read more about rate limits.

Development environment

Integration development should only occur in sandbox environments. See Sandbox for further details.