Этапы интеграции

Для начала работы с API необходимо зарегистрировать мастер-аккаунт на платформе livedigital и пройти в личный кабинет, затем в личном кабинете создать и сохранить персональный токен - Personal Token. С помощью этого токена происходит авторизация при выполнении запросов к API.

Очень важно использовать только тот персональный токен (personal token), который был сгенерирован владельцем аккаунта! Токены, которые были созданы с помощью других учетных записей - невалидны.

Этап 1: Регистрация мастер-аккаунта: перейдите на сайт livedigital и зарегистрируйте мастер-аккаунт, который будет использоваться для выполнения запросов к API.

Этап 2: Получение персонального токена: создайте токен и сохраните его в безопасном месте. Этот токен будет использоваться для авторизации при выполнении запросов к API.

Этап 3: Создание группы: используя полученный токен, выполните API-запрос для создания группы. Убедитесь, что передаете все необходимые параметры (например, название группы, описание и т.д.).

Этап 4: Создание комнаты для мероприятия: выполните API-запрос для создания комнаты, указывая идентификатор ранее созданной группы. Убедитесь, что указаны все необходимые параметры (например, название комнаты и т.д.).

Этап 5: Авторизация участников: выполните API-запросы для добавления участников в комнату, используя их учетные данные и роли (например, администратор, ведущий).

Этап 6: Проведение мероприятия: мероприятие начнётся после того, как первый участник или администратор подключится к комнате.

Этап 7: Передача аналитики и видеозаписи: после завершения мероприятия выполните запрос для получения аналитики и видеозаписи. Сохраните полученные данные в нужном формате (например, JSON/XLSX для аналитики, MP4 для видеозаписи).

Группы и комнаты для проведения мероприятий

В рамках работы с API livedigital используются понятия группы (space) и комнаты (room). Каждый клиент работает в рамках своей группы, в которой создает комнаты для проведения вебинаров и видеоконференций. Комнаты могут быть публичные и приватные (непубличные).

Доступ пользователей

Доступ к группам имеют создатель группы и все пользователи, которые были туда приглашены. Группа - это родительский компонент для комнаты и всех имеющихся сущностей в конференции.

Доступ к комнате осуществляет через специальные пригласительные ссылки, которые создаются при помощи метода roomGenerateAccess.

Работа с API

API предоставляет набор методов, которые представляют собой HTTP-запросы. Выполняя запрос с определенными параметрами, можно создать новую группу или комнату, сформировать токен пользователя для доступа в группу или комнату при проведении трансляции и т.д. Поддерживается выполнение только авторизованных запросов. Для этого в заголовке запроса передается специальный токен доступа - персональный токен (personal-token). Такой токен является уникальным для каждого клиента или пользователя. При этом для выполнения одних запросов нужно авторизоваться как клиент, а для выполнения других как пользователь.

Примечание! В данном руководстве нет полного описания методов API, которые используются для выполнения операций. Для каждого метода дана ссылка на Swagger, где приведена полная спецификация методов.

Встраивание на сайт

После того, как с помощью API в системе созданы соответствующие объекты данных для группы, комнат, пользователей, необходимо встроить функционал для отображения видеоконференции на страницу сайта. Для этого используется технология iFrame. Объект iFrame добавляется в HTML-код страницы. Такой объект содержит атрибуты, в которых передаются идентификаторы группы, пользователей, которые имеют доступ, параметры внешнего отображения на странице, разрешения - например, для использования камеры, микрофона и т.д.