Getting started with Cinema8 API

Cinema8 offers a comprehensive API suite to build extensive digital experiences within your videos. Whether you're developing a web application, mobile application, or service, you can integrate Cinema8's interactive videos into your business processes. Cinema8 REST API uses the OAuth 2.0 protocol for authentication and authorization, allowing you to create secure, authenticated user access with SSO support within embedded C8 players.

Cinema8 supports common OAuth 2.0 scenarios, including those for web servers, client-side applications, installed applications, and limited-input device applications. To begin, obtain OAuth 2.0 client credentials from the Cinema8 API Key Console. Your client application then requests an access token from the Cinema8 Authorization Server, extracts the token from the response, and sends it to the Cinema8 API you wish to access or embeds it into the C8 player to authenticate user access.

Cinema8 provides multiple API levels that can be accessed through JavaScript code, the Widget Development environment, or directly within the C8 Creative Studio. You can also integrate your videos with custom business processes using client-side Hooks or server-side Webhooks. This article series will guide you through all these capabilities.

Generating an API Key for Integrations

API keys can be used to access REST services, SSO, and authentication. You can pass this key to authenticate viewers during video playback.

JavaScript API

Learn the basics of using the Cinema8 Player JavaScript API to embed and control any interactive project within your web applications.

REST API

Discover how to use the Cinema8 REST API to implement server-side integrations.

Authentication & SSO

Learn how to use SSO to authorize viewers, enabling personalized analytics data for each user.

Embedding Cinema8 Videos

Cinema8 supports multiple embedding options. Learn about iframe embeds, dynamic URL parameters, native embed with JavaScript, SCORM embedding, Iframely, and more.

Working with Video URL Parameters

Customize interactive videos with URL parameters to enhance viewer experiences.

Cinema8 React Player

Seamlessly integrate the Cinema8 React Player into your React or React Native applications.

Studio Development & Using Variables

With Cinema8 Creative Studio, you can develop video interactions using drag-and-drop tools. Although no coding is needed, you can still create variables, populate them from integrations or widgets, and use them to build logic within the video. Learn how variables function as data holders in Cinema8, enabling you to trigger conditional actions, visualize values, and interact with JavaScript API and widgets.

Widget API

Widgets are essential expansion tools for any Cinema8 interactive video. Use the widget library or create custom widgets within the C8 Widget Development environment, which provides full integration with the video timeline and access to C8's client APIs.

Server-Side WebHooks

Integrate your business processes into interactive videos with server-side, two-way data sharing via WebHooks.

JavaScript WebHooks - Custom Callbacks

Trigger client-based callbacks during video playback, enabling data exchange with client apps using Custom Callbacks.

Private Token API

Create custom video URLs to track specific users or groups, or generate time-limited access URLs.

SCORM API

Share your interactive videos with SCORM-compliant LMS systems and utilize native SCORM actions within interactive videos.

Integrating Cinema8 with Other Platforms

This article provides multiple integration models within the Cinema8 Platform, offering a blueprint for creating custom integrations.

Code Samples

Access sample codes to learn how to use the Cinema8 API effectively.