ОПИСАНИЕ ВНЕШНЕГО API.

Создано: Сергей Михайлович Отразов, Изменено Вт, 30 Мар, 2021 на 9:49 AM по Сергей Михайлович Отразов

Все запросы строятся на синтаксисе url пример:

http://192.168.0.3:8090/api/app?presetId=0&x=100&y=300&apiKey=<Ваш ключ api>

часть url после номера порта и до знака “?” - непосредственный адрес точки входа в API. В данном случае это - /api/app

все, что располагается за “?” — это параметры запроса (query variables). все пары состоят из имени параметра, знака “=” и значения Пример пары: presetId=0

Все пары параметров соединяются между собой знаком & presetId=0&x=100&y=300

Порядок пар параметров не важен, главное, чтобы они располагались после знака “?” и соединялись знаком “&

Все запросы к внешнему API MWCC должны содержать параметр apiKey=<Ваш ключ>

 

ИСТОЧНИКИ 

(Запуск источников из пресетов)

 

POST

/api/app?presetId=<id-пресета>&x=<значение-x>&y=<значение-y>&width=<ширина>&height=<высота>&apiKey=<ваш ключ>

presetId 

- id сохраненного пресета в MWCC

x, y, width, height 

значения координат - указываются в пикселях.

 

Пример запроса: 

http://192.168.0.13:8090/api/app?presetId=5&x=0&y=0&width=1920&height=1080&apiKey=<Ваш ключ>

При успешном запросе: сервер возвращает 200 OK и Id - запущенного источника (генерируется динамически). Еесли пресет с заданным id не найден - возвращается ошибка 404 Not Found

 

DELETE (Выключение источника)

/api/app?id=<id-источника>&apiKey=<Ваш ключ>

id 

- id запущенного источника.

 

DELETE (Выключение всех источников (выключает все запущенные источники (равносильно нажатию кнопки “закрыть все” в клиенте)))

/app/app?id=0&apiKey=<Ваш ключ>

При успешном выполнении возвращается 204 No Content

 

(Запуск источников по параметру)

 

POST

/api/app?name=<имя-источника>&command=<тип источника>&parameter=<значение параметра>&x=<значение-x>&y=<значение-y>&width=<ширина>&height=<высота>&apiKey=<Ваш ключ>

 

Возможные значения параметров:

 

Значение command

Тип источника

Значение parameter

mpvStreaming

видео поток

ссылка на поток

mpv

видео-источник

путь к файлу

pdf

Pdf

путь к файлу

web

Web - источник

ссылка на ресурс

inputCapture

захват

номер входа

picture

изображение

путь к файлу

 

Пример запроса: 

http://192.168.0.13:8090/api/app?name=yandex&command=web&parameter=http://ya.ru&x=0&y=0&width=1920&height=1080&apiKey=<Ваш ключ>

 

Важно. При передаче параметров закодируйте значения в формат URL либо убедитесь, что используемый вами клиент производит такое кодирование автоматически

 

 

ШАБЛОНЫ (запуск шаблонов)

 

POST

/api/layout?id=<id-шаблона>&apiKey=<Ваш ключ>

id 

- id сохраненного шаблона в MWCC

 

Пример запроса: 

http://192.168.0.13:8090/api/layout?Id=15&apiKey=<Ваш ключ>

при успешном выполнении возвращает 200 OK если шаблон с заданным Id не найден возвращает 404 Not Found

 

ПАНЕЛИ (только для панелей Samsung, устаревший вариант).

 

PUT

/api/monitors/<тип операции>?apiKey=<Ваш ключ>

 

Доступные типы операций:

o

включение панелей

off 

отключение панелей

hdmi 

переключение на HDMI порт

dvi 

переключение на DVI порт

displayport 

переключение на displayport порт

 

Пример запроса: 

http://192.168.0.13:8090/api/monitors/on?&apiKey=<Ваш ключ>

Если тип операции не задан, возвращает 422 Unprocessable Entity в остальных случаях возвращает 204 No Content

 

УПРАВЛЕНИЕ СЕРВЕРОМ

 

POST

/api/serveroperations/<тип-операции>?apiKey=<Ваш ключ>

Доступные типы операций:

restartmwcc 

- перезапуск ПО MWCC

reboot 

- перезагрузка видеоконтроллера

shutdown 

- выключение видеоконтроллера

 

Пример запроса: 

http://192.168.0.13:8090/api/serveroperations/restartmwcc?apiKey=<Ваш ключ>

если тип операции не задан, возвращает 422 Unprocessable Entity в остальных случаях возвращает 204 No Content

 

УСТАНОВКА ГРОМКОСТИ

 

GET

/api/volume?apiKey=<Ваш ключ> Получить текущую громкость

 

POST

/api/volume?value=<0-100>&apiKey=<Ваш ключ> Установить громкость 0-100

value 

- значение для установки

  •  

Пример запроса: 

http://192.168.0.13:8090/api/volume?value=52&apiKey=<Ваш ключ>

Статья помогла?

Отлично!

Спасибо за ваш отзыв

Извините, что не удалось помочь!

Спасибо за ваш отзыв

Расскажите, как мы можем улучшить эту статью!

Выберите хотя бы одну причину
Требуется проверка CAPTCHA.

Комментарий отправлен

Мы ценим вашу помощь и постараемся исправить статью