Настройка RSS для компаний: различия между версиями
Материал из SmartPlayer
(Новая страница: «== '''Описание ситуации''' == Когда пользователю необходима интеграция текстовых данных из удаленного источника, при условии что источник является инициатором. Наши возможность позволяют это реализовать без доработок. === '''Описание функциональности''' ===...») |
|||
| Строка 7: | Строка 7: | ||
Для того чтобы настроить данный функционал, необходимо выполнить ряд действий: | Для того чтобы настроить данный функционал, необходимо выполнить ряд действий: | ||
* Зайти в личный кабинет и просмотреть ID у компании пользователя. | * Зайти в личный кабинет и просмотреть ID у компании пользователя. | ||
[[File: | [[File:IP adress.png|thumb|right | Расположение IP адреса компании|300px]] | ||
* Проверить включена rss лента на сервер или нет, для этого вбить в браузере путь:<br> | * Проверить включена rss лента на сервер или нет, для этого вбить в браузере путь.<br> | ||
Это можно сделать с помощью специальной команды:<br> | |||
<code>https://rc-api.smartplayer.org/v2/company-rss/feed/${company_id}</code><br> | <code>https://rc-api.smartplayer.org/v2/company-rss/feed/${company_id}</code><br> | ||
Пример для компании:<br> | ''Пример для компании с определённым ID:''<br> | ||
<code>https://rc-api.smartplayer.org/v2/company-rss/feed/8</code><br> | <code>https://rc-api.smartplayer.org/v2/company-rss/feed/8</code><br> | ||
Если будет получен ответ | Если будет получен ответ | ||
[[File: | [[File: Ответ сервера|thumb|right | Пример ответа от сервера|300px]] | ||
Значит на сервере нужно включить RSS ленту | Значит на сервере нужно включить RSS ленту | ||
*Для включения RSS ленты на сервере нужно проделать следующие манипуляции. Сделал включение/выключение данного функционала по переменной окружения COMPANY_RSS_ENABLED. 1 - включено, иначе - выключено. По умолчанию: выключено. | *Для включения RSS ленты на сервере нужно проделать следующие манипуляции. Сделал включение/выключение данного функционала по переменной окружения COMPANY_RSS_ENABLED. 1 - включено, иначе - выключено. По умолчанию: выключено. | ||
Версия от 14:11, 8 сентября 2023
Описание ситуации
Когда пользователю необходима интеграция текстовых данных из удаленного источника, при условии что источник является инициатором. Наши возможность позволяют это реализовать без доработок.
Описание функциональности
Для каждой компании на серверном приложении создается RSS лента, которую можно изменять удаленно. Все клиентские приложения умеют обновлять RSS источник, что позволит добиться интеграции с внешними данными.
Настройка и удаленное изменение RSS ленты
в данном случае подразумевается настройка и удаленное изменение сторонними приложениями RSS ленты для компаний.
Для того чтобы настроить данный функционал, необходимо выполнить ряд действий:
- Зайти в личный кабинет и просмотреть ID у компании пользователя.
- Проверить включена rss лента на сервер или нет, для этого вбить в браузере путь.
Это можно сделать с помощью специальной команды:
https://rc-api.smartplayer.org/v2/company-rss/feed/${company_id}
Пример для компании с определённым ID:
https://rc-api.smartplayer.org/v2/company-rss/feed/8
Если будет получен ответ
Значит на сервере нужно включить RSS ленту
- Для включения RSS ленты на сервере нужно проделать следующие манипуляции. Сделал включение/выключение данного функционала по переменной окружения COMPANY_RSS_ENABLED. 1 - включено, иначе - выключено. По умолчанию: выключено.
После изменения настройки перезапускаем серверное приложение.
- Ожидаем поднятия серверного приложения и повторяем операцию описанную в пункте 2. Результат должен быть уже такой
- Для обновления удаленно RSS необходимо выполнить пост запрос с параметрами, который описан тут https://dev.smartplayer.org/api-page/pages/53 в итоге увидим изменения данные на RSS для компании
- После этого настройка на сервере завершена и выполняя удаленный запрос на RSS любое стороннее приложение может изменять данные в своей RSS ленте. Вторым этапом необходимо настроить трансляцию, с контентом который будет брать данные из этого удаленного источника.
