Настройка RSS для компаний/en: различия между версиями

Материал из SmartPlayer
(Новая страница: «== '''Description of the Situation''' == When a user needs to integrate text data from a remote source, provided that the source initiates the process, our capabilities allow this to be implemented without further adjustments. === '''Functionality Description''' === For each company, an RSS feed is created on the server application, which can be modified remotely. All client applications can update the RSS source, facilitating integration with external data.»)
 
(Обновление для соответствия новой версии исходной страницы.)
 
Строка 3: Строка 3:
=== '''Functionality Description''' ===
=== '''Functionality Description''' ===
For each company, an RSS feed is created on the server application, which can be modified remotely. All client applications can update the RSS source, facilitating integration with external data.  
For each company, an RSS feed is created on the server application, which can be modified remotely. All client applications can update the RSS source, facilitating integration with external data.  
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Setting Up and Remotely Modifying the RSS Feed''' ==
== '''Настройка и удаленное изменение RSS ленты''' ==
{{Note|in this case, it refers to the setting up and remote modification of the RSS feed for companies by third-party applications.|warn}}
{{Note|в данном случае подразумевается настройка и удаленное изменение сторонними приложениями RSS ленты для компаний.|warn}}
To configure this functionality, a series of actions need to be performed:
Для того чтобы настроить данный функционал, необходимо выполнить ряд действий:
* Log in to the personal account and view the user company's ID.
* Зайти в личный кабинет и просмотреть ID у компании пользователя.
[[File:IP adress.png|thumb|right | Company IP address location|300px]]
[[File:IP adress.png|thumb|right | Расположение IP адреса компании|300px]]
* Check whether the RSS feed is enabled on the server or not; to do this, enter the path in the browser<br>
* Проверить включена rss лента на сервер или нет, для этого вбить в браузере путь.<br>
This can be done using a special command:<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>
''Пример для компании с определённым ID:''<br>
''Example for a company with a specific 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 ленту.
If it looks like the screenshot, it means that the RSS feed needs to be enabled on the server.
[[File: Ответ сервера.png|thumb|center | Пример ответа от сервера|500px]]
[[File: Ответ сервера.png|thumb|center | Example of server response|500px]]
*Для включения RSS ленты на сервере нужно проделать следующие действия:<br>
*To enable the RSS feed on the server, the following actions need to be undertaken:<br>
- Сделать включение/выключение данного функционала по переменной окружения:<br>
- Enable/disable this feature via the environment variable:<br>
<code>COMPANY_RSS_ENABLED</code>.<br>
<code>COMPANY_RSS_ENABLED</code>.<br>
Если значение переменной = 1 - включено, во всех остальных случаях - выключено.<br>
If the variable value = 1 - enabled, in all other cases - disabled.<br>
Значение по умолчанию является - выключено. После изменения настройки перезапускаем серверное приложение.
The default value is - disabled. After changing the settings, restart the server application.
[[File:Нужная команда.png|thumb|center | Расположение команды|500px]]  
[[File:Нужная команда.png|thumb|center | Command location|500px]]  
* Ожидаем запуска серверного приложения и повторяем операцию описанную выше, в пункте 2. Результатом должно стать окно:
* Wait for the server application to launch and repeat the operation described above, in item 2. The result should be a window:
[[File:Статус по ответу.png|thumb|right | Информация о запуске RSS|300px]]
[[File:Статус по ответу.png|thumb|right | Information on RSS launch|300px]]
* Для удаленного обновления RSS необходимо выполнить пост-запрос с параметрами, который описан по ссылке:<br>
* For remote RSS updates, a POST request with parameters described at the following link needs to be executed:<br>
[http://dev.smartplayer.org/api-page/pages/53 Пост-запрос с параметрами]<br>
[http://dev.smartplayer.org/api-page/pages/53  
В итоге увидим изменения данные на RSS для компании
Post request with parameters]<br>
[[File:Итоговый результат.png|thumb|right | Результат всех манипуляций|300px]]
As a result, we will see data changes on the RSS for the company.
* После этого настройка на сервере завершена и выполняя удаленный запрос на RSS любое стороннее приложение может изменять данные в своей RSS ленте.<br>
[[File:Итоговый результат.png|thumb|right | РResult of all manipulations|300px]]
Далее необходимо настроить трансляцию, с контентом который будет брать данные из этого удаленного источника.
* After this, the server setup is completed and by executing a remote request for RSS, any third-party application can modify data in its RSS feed.<br>
</div>
Next, it is necessary to set up the broadcast, with content that will retrieve data from this remote source.

Текущая версия от 14:53, 8 сентября 2023

Description of the Situation

When a user needs to integrate text data from a remote source, provided that the source initiates the process, our capabilities allow this to be implemented without further adjustments.

Functionality Description

For each company, an RSS feed is created on the server application, which can be modified remotely. All client applications can update the RSS source, facilitating integration with external data.

Setting Up and Remotely Modifying the RSS Feed

in this case, it refers to the setting up and remote modification of the RSS feed for companies by third-party applications.

To configure this functionality, a series of actions need to be performed:

  • Log in to the personal account and view the user company's ID.
Company IP address location
  • Check whether the RSS feed is enabled on the server or not; to do this, enter the path in the browser

This can be done using a special command:
https://rc-api.smartplayer.org/v2/company-rss/feed/${company_id}
Example for a company with a specific ID:
https://rc-api.smartplayer.org/v2/company-rss/feed/8
If it looks like the screenshot, it means that the RSS feed needs to be enabled on the server.

Example of server response
  • To enable the RSS feed on the server, the following actions need to be undertaken:

- Enable/disable this feature via the environment variable:
COMPANY_RSS_ENABLED.
If the variable value = 1 - enabled, in all other cases - disabled.
The default value is - disabled. After changing the settings, restart the server application.

Command location
  • Wait for the server application to launch and repeat the operation described above, in item 2. The result should be a window:
Information on RSS launch
  • For remote RSS updates, a POST request with parameters described at the following link needs to be executed:

[http://dev.smartplayer.org/api-page/pages/53 Post request with parameters]
As a result, we will see data changes on the RSS for the company.

РResult of all manipulations
  • After this, the server setup is completed and by executing a remote request for RSS, any third-party application can modify data in its RSS feed.

Next, it is necessary to set up the broadcast, with content that will retrieve data from this remote source.

Источник — https://wiki.smartplayer.org/index.php?title=Настройка_RSS_для_компаний/en&oldid=10183