REST API

REST API

This section explains the basics of how to use the Cinema8 Rest API.

Before You Begin



API endpoints 

An API endpoint is a path that uniquely identifies a Cinema8 resource: anything from an interactive video to a user account. The exact path of the endpoint differs depending on the type of resource, but you always append it to https://cinema8.com/api/v1/.


Resource
Endpoint*
Interactive Video
https://cinema8.com/api/v1/scene
Folder
https://cinema8.com/api/v1/folder
Media
https://cinema8.com/api/v1/media
User
https://cinema8.com/api/v1/user
Analytics
https://cinema8.com/api/v1/analytics
* Items between braces such as {video_id} represent parameter values.


To access rest endpoint you need to obtain an api key and send this key within Request Headers.

Headers:     Authorization: Bearer <base_64_encoded(API_KEY)>

You can  download the POSTMAN API Collection File from the attachments.


    • Related Articles

    • Generating API key for integrations

      Get an API Key New Users: Before you can start using the Cinema8 Platform APIs and SDKs, you must sign up and create a billing account. To learn more, see Get Started with Cinema8 Platform . Cinema8 supports OAuth specification to authorize API ...

    • Getting started with C8 API

      Cinema8 APIs to build extensive digital experiences within your videos. Cinema8 has an extensive API to support your business and your customers’ needs while developing interactive video-based solutions. Whether you are developing a web application, ...

    • WebSocket API

      WebSocket powered widget development The WebSocket api within Cinema8 widget development environment allows you to create real-time communication and collaboration tools for your interactive videos. By leveraging websockets, you can create ...

    • Javascript API

      We will explain the basics of how to use the Cinema8 Player JavaScript API component of Cinema8 Player. It uses the same interface for HTML5 video player API and extends it with advanced features. Download js from cdn Download Cinema8 Player ...

    • Widget API

      Widgets are key expansion points of any cinema8 interactive video. While You can use any widget from the widget library you can also develop your own customized widgets with the C8 Widget Development environment. This article  walks you through the  ...