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

Материал из SmartPlayer

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

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

  • Авторизация:
    • Вход в серверное приложение.
Пример отображения доступного метода для авторизации
  • Трансляции:
    • Импортировать трансляцию.
    • Отправьте событие для изменения страницы трансляции.
    • Получить все трансляции для компании пользователя.
    • Получить трансляцию по 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".

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