Developer Guides

Kinescope provides API and SDK for integrating and automating video operations. You can upload files, manage video, configure access, integrate the player, and receive notifications via webhooks.

Who this section is for

• Backend developers — need to integrate Kinescope into server applications
• Frontend developers — need to embed the player and control it via IFrame Player API
• DevOps engineers — need to automate video upload and processing
• Platform developers — need to integrate Kinescope into LMS, CRM, or other systems

Where to start

If you’re new to the Kinescope API

1. General API guidelines — authorization, token format, pagination, sorting, and error handling
2. File upload via API — three methods for uploading video and supplementary materials

If you’re integrating the player

1. Kinescope Player SDK — JavaScript SDK for player control
2. IFrame Player API — programmatic player control via IFrame Player API

If you need authorization

1. Authorization backend — video access control via an external backend
2. JWT authentication for stream chat — setting up user authorization in chat

Key sections

API and content management

• General API guidelines — basic API rules: authorization, response format, pagination, sorting, error handling
• Kinescope API — full REST API documentation
• File upload via API — three upload methods: simple upload, Tus upload, and URL upload

Player integration

• Kinescope Player SDK — JavaScript SDK for player control
• Kinescope Player Docs & IFrame API — IFrame Player API documentation
• IFrame Player API — programmatic player control via IFrame Player API

Authorization and security

• Authorization backend — video access control via an external backend
• JWT authentication for stream chat — setting up user authorization in stream chat via JWT

Webhooks and events

• Webhook types — receiving notifications about Kinescope events

Special capabilities

• Tus protocol implementation example — example implementation of the Tus protocol for uploading large files
• IFrame: pseudo-fullscreen on iOS — solving the fullscreen issue on iOS devices

Main use cases

Automated video upload

Use the API to automatically upload video from your system. Simple upload, Tus upload for large files, and URL upload are all supported.

Platform integration

Integrate Kinescope into LMS, CRM, or other platforms. Use the API for video management and IFrame Player API for player embedding.

Access control

Set up an authorization backend to control video access based on your system’s rules (courses, subscriptions, roles).

Event monitoring

Connect webhooks to receive notifications about events: video upload, processing completion, views, and more.

What’s next?

After exploring the API, we recommend:

1. Video player: setup and embedding — basic player embedding and configuration methods
2. Integrations — ready-made solutions for popular platforms
3. Configure webhooks — receive event notifications
4. Content protection — setting up access restrictions and DRM
5. Explore the player documentation — full IFrame Player API documentation

Still have questions? Write to the support chat within the Kinescope interface — our specialists will help!