Инструкция по работе с виджетом «Цены для АЗС»: различия между версиями

Материал из SmartPlayer
Новая страница: «== '''Описание ситуации''' == Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на SFTP-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появил...»
 
Нет описания правки
Строка 1: Строка 1:
== '''Описание ситуации''' ==
== '''Описание ситуации''' ==
Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на SFTP-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появилась в рамках доработки виджета.
Данный виджет позволит пользователям выводить на устройства информацию о стоимости определенных типов топлива. Приведенная ниже инструкция объясняет как работает виджет и помогает настроить его работу внутри платформы SmartPlayer.
=== '''Работоспособность виджета''' ===
== '''Серверная логика''' ==
== '''Серверная логика''' ==
На сервер SmartPlayer пользователь загружает файл с данными по ценам с помощью SFTP. Сервер получает, хранит и обрабатывает информацию из файла. Через равные промежутки времени происходит переотправка (обновление) данных. Сервер парсит данные в виджет, который выводит их на устройства.
(дописать)
== '''Добавление виджета в личный кабинет''' ==
== '''Добавление виджета в личный кабинет''' ==
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.
[[File:Виджет_курс_валют.png|thumb|center| Пример виджета в формате .zip-архива|800px]]
[[File:Виджет_лукойл.png|thumb|center| Пример виджета в формате .zip-архива|800px]]
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
[[File:Виджет_в_лк.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]]
[[File:Виджет_в_лк.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]]
== '''Кнопка "API"''' ==
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.
[[File:Данные_в_модальном_окне.png|thumb|center| Пример отображения информации в модальном окне |800px]]
Основными параметрами для ресурсов являются:
* имя — указано имя ресурса;
* метод — используемый тип метода (GET);
* требует авторизации — информация об обязательности авторизации;
* адрес сервера — URL-адрес сервера, с которого берутся данные;
* адрес API — отображается название JSON-файла с данными о ценах;
* кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
== '''Настройка виджета''' ==
== '''Настройка виджета''' ==
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.

Версия от 22:12, 11 ноября 2025

Описание ситуации

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

Серверная логика

(дописать)

Добавление виджета в личный кабинет

Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.

Пример виджета в формате .zip-архива

После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».

Пример отображения раздела «Контент» в личном кабинете

В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.

Пример отображения переноса виджета в личном кабинете SmartPlayer

Кнопка "API"

Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.

Пример отображения информации в модальном окне

Основными параметрами для ресурсов являются:

  • имя — указано имя ресурса;
  • метод — используемый тип метода (GET);
  • требует авторизации — информация об обязательности авторизации;
  • адрес сервера — URL-адрес сервера, с которого берутся данные;
  • адрес API — отображается название JSON-файла с данными о ценах;
  • кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.

Закрыть данное окно можно по стандартной иконке в правом верхнем углу.

Настройка виджета

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

Кнопка «Настройки»

После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета:

Завершение настройки виджета

После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.

Пример отображения кнопки «Применить настройки»

Далее виджет растянется на весь экран, и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана.

Пример отображения кнопки «Сохранить»

Загрузка и скачивание настроек

В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.

Пример отображения иконок в настройках виджета

Добавление настроенного виджета в трансляцию

Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:

Видеоинструкция

Инструкция по работе с виджетом «Курс валют»

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.

Пример отображения вкладки «Обсуждения» на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"