Available APIs

A range of APIs are available for both front-end and backend communications.

Frontend APIs

  • Interaction SDK: the frontend development SDK is provided for developers wishing to embed or build apps. The SDK includes libraries which wrap other APIs such as Identify and Gamify.

  • Public Feeds: these are JSON feeds provided as an alternative way for a client app to access published content and listings by client applications. They are hosted on a CDN and have high-volume capacity. They are used to avoid making more resource-hungry socket connections to the platform.

  • Gamify API: this provides leaderboards and other user scoring data, available on request.

  • Geo-Verify API: this is a low level API used by some Monterosa solutions to allow and disallow access to Events or Projects based on location with configuration of per-region access, languages and error messaging. It uses MaxMind to power geo-detection. The public API is only available to developers where the backend Extension is enabled in App Spec and a support ticket must be raised for customers wanting to use this.

Backend APIs

Backend APIs available include:

  • Control API: This is the most powerful backend API available. It provides a way to dynamically control event, element and all content creation within the platform, and the way to extract data. The Control API is used to connect M/IC to external content management systems, TV graphics and other systems.

  • Fan API (preview): this is a new consolidated API for both client and server, providing authenticated access to user profiles. Like most other APIs the primary route of access is via the SDK.

Last updated

Was this helpful?