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

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

Для пользователей, которые хотят подключиться по 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)

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

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

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

Список методов

Ниже будет представлен список методов с переводом краткого описания в порядке, описанном ранее:

• Авторизация:
  • Вход в серверное приложение.

Пример отображения доступного метода для авторизации

• Трансляции:
  • Импортировать трансляцию.
  • Отправьте событие для изменения страницы трансляции.
  • Получить все трансляции для компании пользователя.
  • Получить трансляцию по ID.
  • Получить трансляцию по заголовку.

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

• Контент:
  • Загрузить файл.
  • Загрузка нескольких файлов.
  • Загрузка файла в видеоредактор.
  • Загрузка файлов.

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

• Оповещения:
  • Загрузка истории действий пользователей.

Пример отображения доступного метода для оповещений

• IP-телевидение:
  • Экспортировать CSV-файлы для IPTV.
  • Импортировать CSV-файлы в IPTV.

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

• Пользователь:
  • Обновление фотографии пользователя.
  • Создать нового пользователя.
  • Отправить ссылку для сброса пароля.

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

• Настройки:
  • Загрузить шрифт.

Пример отображения доступного метода для настроек

• Расписания:
  • Экспортировать расписание в архиве:

Пример отображения доступного метода для расписаний

• Устройства:
  • Получить устройство digital signage по IP-адресу
  • Получить все устройства digital signage компании
  • Обновить таймеры digital signage

Пример отображения доступного метода для устройств

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

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

• краткое описание метода (на английском);
• параметры (Parameters) запроса;
• тело запроса (Request body), с возможностью просмотра примера значений (Example Values) или схемы (Schema);
• ответы (Responses) с кодами ответов.

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

Кнопка "Try it out"

Кнопка "Try it out" (попробуйте это) позволяет пользователю попробовать сделать запрос к любому выбранному ранее серверу.

Пример отображения кнопки "Try it out"

При её нажатии интерфейс немного меняется предлагая пользователю окно для ввода данных для запроса, либо строку для ввода значения параметра. Кнопка "Try it out" меняется на кнопку "Cancel" (удалить), которая возвращает метод в исходное состояние.

Пример отображения изменений интерфейса

Отправить запрос можно кликнув по кнопке "Execute". Ответ приходит моментально, по нажатию на кнопку.

Пример отображения кнопки "Execute"

Ответ будет отображён в разделе "Responses". Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".

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

Схемы (Schemas)

Данный раздел описывает информацию о структуре данных, с которыми работает API.

Пример отображения раздела "Schemas"

Понимание схемы данных даёт пользователю API:

1. Понимание форматов ответа.
2. Понимание форматов запроса.
3. Типы данных.
4. Обязательность полей.
5. Понимание наличия/отсутствия вложенных структур.
6. Возможность повторного использования моделей.
7. Понимание ошибок.

Чтобы развернуть любую вкладку раздела, пользователю нужно нажать на иконку ">". После открытия вкладки пользователь увидит два столбца:

• первый столбец — название параметра;
• второй столбец — тип данных параметра.

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

В некоторых случаях под типом данных (во втором столбце) располагается описание или пример (example).

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

Также присутствует ситуация, когда пользователь вместо типа данных получает ещё одну вкладку (название + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.

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

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

Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.
Установив и запустив Postman, пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).

Пример отображения интерфейса Postman

После необходимо выбрать тип запроса из списка и вставить нужный URL-адрес (название сервера + /название конечной точки). В данном примере URL-адрес будет: https://develop-api.smartplayer.org/login.

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

Настроить параметры в разделе "Headers", по необходимости (параметры указаны на портале в теле метода) и тело запроса "Body" → "Raw" (если необходимо, также в теле описания метода на портале).

Пример отображения "Headers" и "Body" → "Row"

Также в зависимости от запроса может понадобиться настроить авторизацию (раздел "Authorization" в Postman). Она реализована через "bearer token".

Далее нажимаем на кнопку "Send" и моментально получаем ответ, который расположен в нижней части экрана.

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

Сравниваем его с информацией, указанной на портале.

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

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

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

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

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

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