Translations:Подключение к внешнему REST API/1/ru

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

Для пользователей, которые хотят подключиться по 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;
• списке доступных для тестирования серверов;
• кнопка "Authorize" (подробнее о работе с кнопкой ниже на странице);
• список методов;
• раздел "Schemas" (нужно пролистать страницу вниз до конца).

Пример отображения наполнения страницы портала

Пример отображения раздела "Schemas" в нижней части экрана

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

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

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

Представленный список серверов не окончательный. Пользователь может с помощью Postman вручную подключиться к любому представленному из списка серверу, а также использовать другие сервера SmartPlayer. Например, "rc.smartplayer.org".

Кнопка "Atuhorize"

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

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

После введения токена авторизации необходимо нажать на кнопку "Close". Это вернёт пользователя на главную страницу, а также поменяет отображение иконки авторизации (выглядит как замок). Иконка будет подсвечена, а замок будет закрыт.

Пример отображения изменения иконки авторизации

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

Пример отображения иконки копирования запроса в буфер обмена

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

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

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

Пример отображения методов GET и POST на странице

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

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

Взаимодействие с методами

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

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

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

• авторизация (Authorization);
• трансляции (Broadcast);
• контент (Content);
• оповещения (Notifications);
• IP-телевидение (IP-TV);
• пользователь (User);
• настройки (Settings);
• расписания (Schedule);
• устройства (Devices)

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

Каждый из методов имеет небольшое описание на английском идущее после обозначения.

Пример отображения описания метода