REST API
This section provides an overview of using the Cinema8 REST API and how to authenticate, access endpoints, and begin development.
Before You Begin
→ Access the Cinema8 REST API documentation and Postman collection
To begin, you’ll need an API key. You can generate one from your admin panel to authenticate requests to the Cinema8 API.
Cinema8’s REST API allows you to access video scenes, folders, users, media assets, and analytics programmatically.
Getting Started
Step 1: Understand the Endpoint Structure
All API endpoints start with:
https://cinema8.com/api/v1/Step 2: Use Authorization Headers
To authenticate requests, include your API key in the request headers:
Authorization: Bearer <base_64_encoded(API_KEY)>Step 3: Replace Path Parameters
Some endpoints require dynamic parameters like {video_id}. Replace them with actual values when making requests.
Available Resources
| 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 like
{video_id}in paths are placeholders for actual values.
Example Request
get-user.sh
curl https://cinema8.com/api/v1/user \
-H "Authorization: Bearer YOUR_ENCODED_API_KEY"