Настройка RSS для компаний: различия между версиями
Материал из SmartPlayer
Нет описания правки |
|||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
== '''Описание ситуации''' == | == '''Описание ситуации''' == | ||
Когда пользователю необходима интеграция текстовых данных из удаленного источника, при условии что источник является инициатором. Наши возможность позволяют это реализовать без доработок. | Когда пользователю необходима интеграция текстовых данных из удаленного источника, при условии что источник является инициатором. Наши возможность позволяют это реализовать без доработок. | ||
=== '''Описание функциональности''' === | === '''Описание функциональности''' === | ||
Для каждой компании на серверном приложении создается RSS лента, которую можно изменять удаленно. Все клиентские приложения умеют обновлять RSS источник, что позволит добиться интеграции с внешними данными. | Для каждой компании на серверном приложении создается RSS лента, которую можно изменять удаленно. Все клиентские приложения умеют обновлять RSS источник, что позволит добиться интеграции с внешними данными. | ||
</translate> | |||
<translate> | |||
<!--T:2--> | |||
== '''Настройка и удаленное изменение RSS ленты''' == | == '''Настройка и удаленное изменение RSS ленты''' == | ||
{{Note|в данном случае подразумевается настройка и удаленное изменение сторонними приложениями RSS ленты для компаний.|warn}} | {{Note|в данном случае подразумевается настройка и удаленное изменение сторонними приложениями RSS ленты для компаний.|warn}} | ||
| Строка 13: | Строка 19: | ||
''Пример для компании с определённым ID:''<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> | ||
Если будет | Если будет выглядеть как на скриншоте, то значит на сервере нужно включить RSS ленту. | ||
[[File: Ответ сервера|thumb| | [[File: Ответ сервера.png|thumb|center | Пример ответа от сервера|500px]] | ||
*Для включения RSS ленты на сервере нужно проделать следующие действия:<br> | |||
*Для включения RSS ленты на сервере нужно проделать следующие | - Сделать включение/выключение данного функционала по переменной окружения:<br> | ||
[[File: | <code>COMPANY_RSS_ENABLED</code>.<br> | ||
Если значение переменной = 1 - включено, во всех остальных случаях - выключено.<br> | |||
* Ожидаем | Значение по умолчанию является - выключено. После изменения настройки перезапускаем серверное приложение. | ||
[[File: | [[File:Нужная команда.png|thumb|center | Расположение команды|500px]] | ||
* Для обновления | * Ожидаем запуска серверного приложения и повторяем операцию описанную выше, в пункте 2. Результатом должно стать окно: | ||
[[File: | [[File:Статус по ответу.png|thumb|right | Информация о запуске RSS|300px]] | ||
* После этого настройка на сервере завершена и выполняя удаленный запрос на RSS любое стороннее приложение может изменять данные в своей RSS ленте. | * Для удаленного обновления RSS необходимо выполнить пост-запрос с параметрами, который описан по ссылке:<br> | ||
[http://dev.smartplayer.org/api-page/pages/53 Пост-запрос с параметрами]<br> | |||
В итоге увидим изменения данные на RSS для компании | |||
[[File:Итоговый результат.png|thumb|right | Результат всех манипуляций|300px]] | |||
* После этого настройка на сервере завершена и выполняя удаленный запрос на RSS любое стороннее приложение может изменять данные в своей RSS ленте.<br> | |||
Далее необходимо настроить трансляцию, с контентом который будет брать данные из этого удаленного источника. | |||
</translate> | |||
Текущая версия от 14:53, 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 необходимо выполнить пост-запрос с параметрами, который описан по ссылке:
Пост-запрос с параметрами
В итоге увидим изменения данные на RSS для компании
- После этого настройка на сервере завершена и выполняя удаленный запрос на RSS любое стороннее приложение может изменять данные в своей RSS ленте.
Далее необходимо настроить трансляцию, с контентом который будет брать данные из этого удаленного источника.
