https://wiki.smartplayer.org/index.php?action=history&feed=atom&title=Translations%3A%D0%9F%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BA_%D0%B2%D0%BD%D0%B5%D1%88%D0%BD%D0%B5%D0%BC%D1%83_REST_API%2F1%2FruTranslations:Подключение к внешнему REST API/1/ru - История изменений2026-04-29T03:35:44ZИстория изменений этой страницы в викиMediaWiki 1.45.1https://wiki.smartplayer.org/index.php?title=Translations:%D0%9F%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BA_%D0%B2%D0%BD%D0%B5%D1%88%D0%BD%D0%B5%D0%BC%D1%83_REST_API/1/ru&diff=19640&oldid=prevFuzzyBot: Импортирована новая версия из внешнего источника2026-04-26T19:49:02Z<p>Импортирована новая версия из внешнего источника</p>
<p><b>Новая страница</b></p><div>== '''Описание ситуации''' ==<br />
Для пользователей, которые хотят подключиться по REST API рекомендуется использовать наш отдельный ресурс. На этом ресурсе пользователь опробует методы и запросы, которые позволят ему подключиться и получать данные от платформы SmartPlayer.<br />
{{Note|'''Портал с поддержкой REST API расположен [https://restapi.smartplayer.org/ здесь]. Запросить данные для авторизации (логин и пароль) можно связавшись с нами через [https://smartplayer.ru/ портал] или прикрепленным специалистом компании SmartPlayer. Также можно написать на эту [https://smartplayer.atlassian.net/servicedesk/customer/portal/1 почту]''' |warn}}<br />
== '''Работа портала''' ==<br />
Данный раздел построен на базе Swagger Plugin и позволяет не только ознакомиться с информацией для подключения по REST API, но и опробовать описанные методы, получая реальный результат. Также технически продвинутые пользователи могут протестировать описанные методы, используя Postman.<br />
{{Note|'''Некоторые методы, описанные на портале, могут отрабатывать некорректно. Команда SmartPlayer знает о проблемах и находится в процессе их устранения.'''|warn}}<br />
== '''Сценарий использования''' ==<br />
Предполагается, что взаимодействие с порталом будет происходить в определённой последовательности. Сценарий использования:<br />
# Авторизация на портале.<br />
# Выбор нужного сервера для тестирования запросов.<br />
# Получение токена для использования кнопки "Authorize".<br />
# Выбор нужного метода и изучение информации о нём. <br />
# По кнопке "Try it out" отправлять запрос.<br />
# Получение и просмотр ответа от сервера.<br />
# Изучение раздела "Schemas".<br />
{{Note|Подробности будут изложены ниже на странице.|warn}}<br />
== '''Информация на портале''' ==<br />
После авторизации на портале пользователю откроется основная страница, на которой отобразится следующая информация:<br />
[[File:Стартовая_страница_портала.png|thumb|center| Пример отображения главной страницы портала с REST API |800px]]<br />
На странице портала отображается информация о:<br />
* контактной информации о взаимодействии с командой SmartPlayer;<br />
* списке доступных для тестирования серверов;<br />
* кнопка "Authorize" (подробнее о работе с кнопкой ниже на странице);<br />
* список методов;<br />
* раздел "Schemas" (нужно пролистать страницу вниз до конца).<br />
[[File:Разделение_страницы в апи.png|thumb|center| Пример отображения наполнения страницы портала|800px]]<br />
[[File:Раздел_schemas.png|thumb|center| Пример отображения раздела "Schemas" в нижней части экрана |800px]]<br />
== '''Выбор сервера''' ==<br />
Для тестирования запросов с методами пользователю необходимо выбрать один из представленных в списке серверов. Каждый сервер из списка имеет формат отображения: "название" + "краткое описание" (на английском языке).<br />
[[File:Списко_серверов.png|thumb|center| Пример отображения списка доступных серверов |800px]]<br />
{{Note|Представленный список серверов не окончательный. Пользователь может с помощью Postman вручную подключиться к любому представленному из списка серверу, а также использовать другие сервера SmartPlayer. Например, "rc.smartplayer.org".|warn}}<br />
== '''Кнопка "Atuhorize"''' ==<br />
При нажатии на кнопку "Authorize" пользователю откроется модальное окно с описанием и полем, в котором необходимо указать токен (bearer token) для авторизации. Чтобы получить данный токен можно прочитать инструкцию, приложенную по ссылке в окне.<br />
[[File:Модальное окно для токенов.png|thumb|center| Пример отображения модального окна для кнопки "Authorize" |800px]]<br />
После введения токена авторизации необходимо нажать на кнопку "Close". Это вернёт пользователя на главную страницу, а также поменяет отображение иконки авторизации (выглядит как замок). Иконка будет подсвечена, а замок будет закрыт.<br />
[[File:Иконка_авторизации.png|thumb|center| Пример отображения изменения иконки авторизации |800px]]<br />
{{Note|При наведении на иконку авторизации интерфейс добавит ещё одну иконку, которая позволит скопировать запрос в буфер обмена.<br />
[[File:Копировать_в_буфер_обмена.png|thumb|center| Пример отображения иконки копирования запроса в буфер обмена |800px]] |warn}}<br />
== '''Информация о методах''' ==<br />
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;"><br />
На данный момент на портале представлено два вида методов:<br />
# GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется. <br />
# POST — отправляет данные в теле запроса. Используется для создания или изменения ресурсов. Безопасен для конфиденциальной информации <br />
[[File:Пример_методов.png|thumb|center| Пример отображения методов GET и POST на странице |800px]]<br />
Все методы представленные в списке имеют свою конечную точку пути (endpoint), который указывается после названия типа метода и выделяется жирным шрифтом.<br />
[[File:Конечная_точка.png|thumb|center| Пример отображения конечной точки метода (endpoint)|800px]]<br />
== '''Взаимодействие с методами''' ==<br />
Список методов представленных на портале позволит пользователю провести тестовые подключения к серверам и получать с них примеры информации и данных передаваемых через запросы. Успешный запрос отдаст информацию по выбранному методу и пользователь сможет просмотреть полученные результаты, а также понять как реагирует платформа SmartPlayer.<br />
=== '''Области работы методов''' ===<br />
На портале представлены методы, работающие с различными частями системы. Ниже приведен список методов и область, с которой они взаимодействуют:<br />
* авторизация (Authorization);<br />
* трансляции (Broadcast);<br />
* контент (Content);<br />
* оповещения (Notifications);<br />
* IP-телевидение (IP-TV);<br />
* пользователь (User);<br />
* настройки (Settings);<br />
* расписания (Schedule);<br />
* устройства (Devices)<br />
[[File:Список_методов.png|thumb|center| Пример отображения списка доступных методов |800px]]<br />
{{Note|Каждый из методов имеет небольшое описание на английском идущее после обозначения.<br />
[[File:Краткое_описание_метода.png|thumb|center| Пример отображения описания метода|800px]]|warn}}<br />
</div></div>FuzzyBot