Dynamic content via RSS feed (version for system administrator)

Description

Periodically, users find the need to display some additional text information on the device along with the main broadcast. To do this, dynamic content can be launched through the RSS feed in the broadcast.

Workflow

1. First, the system administrator configures the user's application via RSS.
2. Next, it is necessary for the user to create a suitable type of content, as described above, in their personal account.
3. The next step is "Creating a broadcast".
4. The penultimate action will be creating a schedule for the broadcast.
5. Displaying the necessary content on the devices.

Functional logic

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

Подготовка

Расположение 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 - в эту строку необходимо вставить значение устройство. Его можно просмотреть в личном кабинете

Device ID можно найти перейдя в раздел "Устройства" личного кабинета, выбрав нужное устройство и нажав в правом тулбаре строку "Информация". В открывшимся меню необходимо взять и скопировать значение из раздела "Идентификатор устройства".

Расположение идентификатора устройства

• Описание контента/title - тот контент, который будет отображен на устройстве.

Пример с отображением Device ID и описанием контента

Далее подставляем "Идентификатор устройства" в строку "Device ID", а в "Описание контента/title" - меняем значение на нужное.

Создание запроса

После прохождения шагов, описанных выше, системный администратор должен нажать кнопку "Execute". Система выполнит запрос и покажет статус в виде ответа: "Company RSS updated"

Статус "Company RSS updated"

Для проверки правильности произведенного действия возвращаемся к RSS ленте и обновляем страницу.

Завершение подготовки

После всех описанных шагов, можно считать что динамическое подключение через RSS готово и настроено. Дальнейшие шаги должен для подготовки и воспроизведения контента на устройстве должен делать пользователь. Инструкция для дальнейших действий можно просмотреть по ссылке: Динамический контент через RSS ленту (пользовательская версия)

Итоговый результат

Системный администратор настроил подключение по RSS и подготовил "плацдарм" для пользователя. Остальные настройки пользователь должен проводить самостоятельно.