Инструкции для разработчиков

Kinescope предоставляет API и SDK для интеграции и автоматизации работы с видео. Вы можете загружать файлы, управлять видео, настраивать доступ, интегрировать плеер и получать уведомления через вебхуки.

Кому подходит этот раздел

• Backend-разработчикам — нужно интегрировать Kinescope в серверные приложения
• Frontend-разработчикам — требуется встроить плеер и управлять им через IFrame Player API
• DevOps-инженерам — нужно автоматизировать загрузку и обработку видео
• Разработчикам платформ — требуется интегрировать Kinescope в LMS, CRM или другие системы

С чего начать

Если вы впервые работаете с Kinescope API

1. Общие правила API — авторизация, формат токенов, пагинация, сортировка и обработка ошибок
2. Загрузка файлов через API — три способа загрузки видео и дополнительных материалов

Если вы интегрируете плеер

1. Kinescope Player SDK — JavaScript SDK для управления плеером
2. IFrame Player API — программное управление плеером через IFrame Player API

Если вам нужна авторизация

1. Авторизационный бэкенд — контроль доступа к видео через внешний бэкенд
2. JWT-аутентификация для чата трансляций — настройка авторизации пользователей в чате

Основные разделы

API и управление контентом

• Общие правила API — базовые правила работы с API: авторизация, формат ответов, пагинация, сортировка, обработка ошибок
• Kinescope API — полная документация по REST API
• Загрузка файлов через API — три способа загрузки: простая загрузка, загрузка через Tus и загрузка по URL

Интеграция плеера

• Kinescope Player SDK — JavaScript SDK для управления плеером
• Kinescope Player Docs&iframe API — документация по IFrame Player API
• IFrame Player API — программное управление плеером через IFrame Player API

Авторизация и безопасность

• Авторизационный бэкенд — контроль доступа к видео через внешний бэкенд
• JWT-аутентификация для чата трансляций — настройка авторизации пользователей в чате через JWT

Вебхуки и события

• Типы вебхуков — получение уведомлений о событиях в Kinescope

Специальные возможности

• Пример реализации протокола Tus — пример реализации протокола Tus для загрузки больших файлов
• Iframe: псевдо-полноэкранный режим на iOS — решение проблемы полноэкранного режима на iOS устройствах

Основные сценарии использования

Автоматизация загрузки видео

Используйте API для автоматической загрузки видео из вашей системы. Поддерживается простая загрузка, загрузка через Tus для больших файлов и загрузка по URL.

Интеграция в платформы

Интегрируйте Kinescope в LMS, CRM или другие платформы. Используйте API для управления видео и IFrame Player API для встраивания плеера.

Контроль доступа

Настройте авторизационный бэкенд для контроля доступа к видео на основе правил вашей системы (курсы, подписки, роли).

Мониторинг событий

Подключите вебхуки для получения уведомлений о событиях: загрузка видео, завершение обработки, просмотры и другие.

Что дальше?

После изучения API рекомендуем:

1. Видеоплеер: настройка и встраивание — базовые способы встраивания и настройки плеера
2. Интеграции — готовые решения для популярных платформ
3. Настроить вебхуки — получайте уведомления о событиях
4. Защита контента — настройка ограничений доступа и DRM
5. Изучить документацию по плееру — полная документация по IFrame Player API

Остались вопросы? Напишите в чат поддержки — специалисты помогут!