Подключение к внешнему REST API: различия между версиями

Материал из SmartPlayer
← Предыдущая правкаСледующая правка →
N.Bloshkin (обсуждение | вклад)
Администраторы интерфейса, Администраторы
7668 правок
Нет описания правки
Нет описания правки
Строка 1: Строка 1:
== '''Описание ситуации''' ==
== '''Описание ситуации''' ==
Доработанный функционал событий теперь будет продолжать проигрывание эфирной сетки (при правильной настройке), даже если проигрываемый поток не прекращает свою работу. Данный функционал настраивается в рамках трансляции и позволяет избежать ситуации с проигрыванием трансляции без контента.
Для пользователей, которые хотят подключиться по REST API есть возможность сделать это используя наш отдельный ресурс. На этом ресурсе пользователь ознакомиться с методами и типами запросов, которые позволят ему подключиться и получать данные от платформы SmartPlayer.
{{Note|'''Портал с поддержкой REST API расположен [https://restapi.smartplayer.org/ здесь]. Запросить данные для авторизации (логин и пароль) можно связавшись с нами через [https://smartplayer.ru/ портал] или прикрепленному специалисту компании SmartPlayer. Также можно написать на эту [https://smartplayer.atlassian.net/servicedesk/customer/portal/1 почту]''' |warn}}
== '''Работа портала''' ==
Данный раздел построен на базе Swagger Plugin и позволяет не только ознакомиться с информацией для подключения по REST API, но и опробовать описанные методы, получая реальный результат. Также технически продвинутые пользователи могут протестировать описанные методы используя Postman, если он является более привычным инструментом.
{{Note|'''Некоторые методы описанные на портале могут отрабатывать некорректно. Команда SmartPlayer знает о проблемах и находится в процессе их устранения.'''|warn}}
== '''Сценарий использования''' ==
== '''Сценарий использования''' ==
В данном случае будет рассматриваться ситуация, в которой пользователь имеет трансляцию с двумя страницами для проигрывания. На первой странице играет бесконечно поток, а вторая страница заполнена контентом на случай остановки проигрывания потока.
Предполагается что взаимодействие с порталом будет происходить в определённой последовательности. Сценарий предполагаемого использования:
# Авторизация на портале.
# Выбор нужного сервера для тестирования запросов.
# Получение токена для использования кнопки "Authorize".
# Выбор нужного метода и изучение информации о нём.
# По кнопке "Try it out" отправка запроса.
# Получение и просмотр ответа от сервера.
# Изучение раздела "Schemas".
{{Note|Описанные действия будет подробнее описаны ниже на странице.|warn}}
== '''Информация на портале''' ==
После авторизации на портале пользователю откроется основная страница, на которой ему отобразится следующая информация:
[[File:Стартовая_страница_портала.png|thumb|center| Пример отображения главной страницы портала с REST API |800px]]
На странице портала отображается информация о:
* контактной информации с командой SmartPlayer;
* списке доступных для тестирования серверов;
* кнопка "Atuhorize" (подробнее о работе с кнопкой ниже на странице)
* список методов;
* раздел "Schemas" (нужно пролистать страницу вниз до конца)
[[File:Разделение_страницы в апи.png|thumb|center| Пример отображения наполнения страницы портала|800px]]
[[File:Раздел_schemas.png|thumb|center| Пример отображения раздела "Schemas" в нижней части экрана |800px]]
== '''Выбор сервера''' ==
Для тестирования запросов с методами пользователю необходимо выбрать один из представленных в списке методов. Каждый сервер из списка имеет формат отображения: "название" + "краткое описание" (на английском языке).
[[File:Списко_серверов.png|thumb|center| Пример отображения списка доступных серверов |800px]]
== '''Кнопка "Atuhorize"''' ==
При нажатии на кнопку "Authorize" пользователю откроется модальное окно с описанием и полем, в котором необходимо указана токен (bearer token) для авторизации. Чтобы получить данный токен можно прочитать инструкцию приложенную по ссылке в окне.
[[File:Модальное окно для токенов.png|thumb|center| Пример отображения модального окна для кнопки "Authorize" |800px]]
== '''Информация о методах''' ==
На данный момент на портале представлено два вида методов:
# GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется.
# POST — отправляет данные в теле запроса. Используется для создания ил изменения ресурсов. Безопасен для конфиденциальной информации
[[File:Пример_методов.png|thumb|center| Пример отображения методов GET и POST на странице |800px]]
Все методы представленные в списке имеют свою конечную точку пути (endpoint), который прописан после названия типа метода и выделяется жирным шрифтом.
[[File:Конечная_точка.png|thumb|center| Пример отображения конечной точки метода (endpoint)|800px]]
== '''Области работы методов''' ==
На портале представлены методы работающие с различными частями системы. Ниже приведен список методов и область с которой они взаимодействуют:
* авторизация (Authorization);
* трансляции (Broadcast);
* контент (Content);
* оповещения (Notifications);
* IP-телевидение (IP-TV);
* пользователь (User);
* настройки (Settings);
* расписания (Schedule);
* устройства (Устройства)
[[File:Список_методов.png|thumb|center| Пример отображения списка доступных методов |800px]]
{{Note|Каждый из методов имеет небольшое описание на английском идущие после обозначения.
[[File:Краткое_описание_метода.png|thumb|center| Пример отображения описания метода|800px]]|warn}}
== '''Видеоинструкция''' ==
== '''Видеоинструкция''' ==
[https://vkvideo.ru/video-227547238_456239130 Подключение к внешнему REST API]
[https://vkvideo.ru/video-227547238_456239130 Подключение к внешнему REST API]

Версия от 15:20, 22 апреля 2026

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

Для пользователей, которые хотят подключиться по REST API есть возможность сделать это используя наш отдельный ресурс. На этом ресурсе пользователь ознакомиться с методами и типами запросов, которые позволят ему подключиться и получать данные от платформы SmartPlayer.

Портал с поддержкой REST API расположен здесь. Запросить данные для авторизации (логин и пароль) можно связавшись с нами через портал или прикрепленному специалисту компании SmartPlayer. Также можно написать на эту почту

Работа портала

Данный раздел построен на базе Swagger Plugin и позволяет не только ознакомиться с информацией для подключения по REST API, но и опробовать описанные методы, получая реальный результат. Также технически продвинутые пользователи могут протестировать описанные методы используя Postman, если он является более привычным инструментом.

Некоторые методы описанные на портале могут отрабатывать некорректно. Команда SmartPlayer знает о проблемах и находится в процессе их устранения.

Сценарий использования

Предполагается что взаимодействие с порталом будет происходить в определённой последовательности. Сценарий предполагаемого использования:

  1. Авторизация на портале.
  2. Выбор нужного сервера для тестирования запросов.
  3. Получение токена для использования кнопки "Authorize".
  4. Выбор нужного метода и изучение информации о нём.
  5. По кнопке "Try it out" отправка запроса.
  6. Получение и просмотр ответа от сервера.
  7. Изучение раздела "Schemas".
Описанные действия будет подробнее описаны ниже на странице.

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

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

Пример отображения главной страницы портала с REST API

На странице портала отображается информация о:

  • контактной информации с командой SmartPlayer;
  • списке доступных для тестирования серверов;
  • кнопка "Atuhorize" (подробнее о работе с кнопкой ниже на странице)
  • список методов;
  • раздел "Schemas" (нужно пролистать страницу вниз до конца)
Пример отображения наполнения страницы портала
Пример отображения раздела "Schemas" в нижней части экрана

Выбор сервера

Для тестирования запросов с методами пользователю необходимо выбрать один из представленных в списке методов. Каждый сервер из списка имеет формат отображения: "название" + "краткое описание" (на английском языке).

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

Кнопка "Atuhorize"

При нажатии на кнопку "Authorize" пользователю откроется модальное окно с описанием и полем, в котором необходимо указана токен (bearer token) для авторизации. Чтобы получить данный токен можно прочитать инструкцию приложенную по ссылке в окне.

Пример отображения модального окна для кнопки "Authorize"

Информация о методах

На данный момент на портале представлено два вида методов:

  1. GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется.
  2. POST — отправляет данные в теле запроса. Используется для создания ил изменения ресурсов. Безопасен для конфиденциальной информации
Пример отображения методов GET и POST на странице

Все методы представленные в списке имеют свою конечную точку пути (endpoint), который прописан после названия типа метода и выделяется жирным шрифтом.

Пример отображения конечной точки метода (endpoint)

Области работы методов

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

  • авторизация (Authorization);
  • трансляции (Broadcast);
  • контент (Content);
  • оповещения (Notifications);
  • IP-телевидение (IP-TV);
  • пользователь (User);
  • настройки (Settings);
  • расписания (Schedule);
  • устройства (Устройства)
Пример отображения списка доступных методов
Каждый из методов имеет небольшое описание на английском идущие после обозначения.
Пример отображения описания метода

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

Подключение к внешнему REST API

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

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

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

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

Источник — https://wiki.smartplayer.org/index.php?title=Подключение_к_внешнему_REST_API&oldid=19605