Введение

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

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

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

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

Доступ к публичным группам имеют все пользователи. Доступ к непубличным группам имеют только создатель\модераторы. Для того, чтобы предоставить доступ остальным пользователям используются специальные токены. Токены формируются с помощью метода API. Чтобы пригласить пользователя в группу\комнату ему передается токен пользователя в виде ссылки, перейдя по которой пользователь активирует свой доступ. Токен можно использовать только один раз, после активации токен становится невалидным.

Работа с API

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

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

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

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