The Immersive platform provides APIs out of the box. The latest API is written in RESTful architecture, making it easy to integrate with other systems and applications. This guide will help you get set up to use our external APIs.

External APIs

Our APIs act as a portal that allows you to adapt the platform to meet your unique business requirements and processes. As a customer, you can interact with our APIs by submitting requests to distinct endpoints, which are designed to fetch particular sets of data.

This data retrieval allows you to harness the platform's capabilities, revealing insights, driving your decision-making process, and integrating this information into other aspects of your operations.

The focus is on providing you robust and precise access to data, thereby enriching your understanding and usage of the platform.

Our REST and GraphQL endpoints require authentication with an API key so before you can gain access you’ll need to generate an API key.

API V2 (REST)

Our REST API is continually being developed with more features added regularly. Our goal is to modify and extend the API so that it fulfils the needs of our customers, so we encourage you to share any specific scenarios that require enhancement to its capabilities.

Our interactive API documentation displays the various endpoints and operations available via the API.

The API documentation also illustrates the authentication process and gives examples of making requests. Plus, its user-friendly interface coupled with descriptions of requests and response payloads simplifies the process of integrating and working with our platform.

This document also facilitates real-time interactions with the API’s endpoints by letting you authenticate completely from within the page.

See our Rest API documentation to get started.

API V1 (GraphQL)

Note: This version of the API is no longer being actively maintained.

While the GraphQL API is no longer actively developed or maintained it provides a robust foundation for interacting with the platform.

Our API documentation serves as an extensive resource that includes a comprehensive set of GraphQL types, queries, mutations, and their respective parameters available via the API.

The API documentation features an intuitive interface and descriptions of various operations, simplifying the process of integrating and working with our platform.

Although this version of the API may not be under active development, it retains its utility as a self-contained toolset that allows you to explore and construct your desired solutions around the platform.

See our GraphQL API documentation to get started.

API Keys

An Organization Admin can generate an API key in the platform from the Platform Settings > API page.

Simply select the Generate API key button in the API Access section of the page and follow the prompts to receive your Access key and Secret token.

Please make sure you save the Secret token somewhere safe as it can’t be accessed again and you’ll need it when authenticating with our APIs.