Динамический контент через RSS ленту (версия для системного администратора)

Материал из SmartPlayer

Описание

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

Логика работы

  1. Сначала системный администратор настраивает работу приложения пользователя через RSS.
  2. Далее необходимо чтобы пользователь в личном кабинете создал подходящий вид контента, описанного выше.
  3. Следующим этапом будет идти "Создание трансляции"
  4. Предпоследний действием будет создание расписания для трансляции
  5. Вывод нужного контента на устройства
Логика работы функционала

Логика работы

{{Note|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность Системный администратор со стороны клиента настраивает работы приложения с помощью RSS.
Далее пользователь может начинать подготавливать контент для выведения его на устройство.
Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.
Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.

Принцип действия

Подготовка

Расположение ID - Company

Для начала системному администратору нужно настроить работу с помощью RSS - запроса и отправить URL, для подключения по API. Это делается с помощью URL и будет выглядеть примерно так:
https://rc-api.smartplayer.org/v2/company-rss/feed/54
В данном случае заместо последний цифры (54) в запросе идёт - Company ID. Его можно просмотреть в личном кабинете на иконку пользователя. Таким образом мы сможем просмотреть публичную RSS ленту.

Пример публичной RSS-ленты

Настройка

Далее необходимо чтобы системный администратор настроил подключение к нашему Swagger UI.

Swagger/сваггер (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию.
URL для подключения по API:https://restapi.smartplayer.org/

Следующим шагом необходимо, чтобы системный администратор нашёл RSS запрос указанный в Swagger UI

RSS запрос на Swagger UI

Кликнул на строку "RSS" откроется окно с примером параметров и возвращаемых значений

Примеры параметров и возвращаемых значений

После необходимо нажать на клавишу "Try it out" и появится форма с данными:

  • Device ID - в эту строку необходимо вставить значение устройство. Его можно просмотреть в личном кабинете
Примеры параметров и возвращаемых значений
Источник — https://wiki.smartplayer.org/index.php?title=Динамический_контент_через_RSS_ленту_(версия_для_системного_администратора)&oldid=10247