Описание внешнего API

Все запросы строятся на синтаксисе 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=<ваш ключ>

Postman

Коллекция для Postman

в Postman нужно добавить environment

Переменные:

apiKey

url

port

ИСТОЧНИКИ

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

POST

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

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

x

y

width

height

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

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

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

при успешном запросе: сервер возвращает 200 OK и Id - запущенного источника (генерируется динамически)

если пресет с заданным id не найден - возвращается ошибка 404 Not Found

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

POST

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

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

значение type

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

значение parameter

streaming

видео поток

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

mpv

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

путь к файлу

pdf

Pdf

путь к файлу

web

Web - источник

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

inputCapture

захват

номер входа

picture

изображение

путь к файлу

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

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

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

Выключение источников

DELETE

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

закрыть все источники внутри области по x, y, width, height

/api/app/name?name=<имя источника>&apiKey=<ваш ключ>

закрыть один источник по имени

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

закрыть один источник по положению x, y, width, height

/api/app/all?apiKey=<ваш ключ>

закрыть все источники

Свернуть/Развернуть источник

PUT

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

свернуть/развернуть источник по исходным координатам и имени

один и тот же запрос работает для сворачивания и разворачивания источника

Изменить размер/положение источника

PUT

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

Переместить источник по имени, исходным и новым координатам

ШАБЛОНЫ

запуск шаблонов:

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

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

POST

/api/serveroperation?operation=<тип-операции>&apiKey=<ваш ключ>

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

restart - перезапуск MWCC

reboot - перезагрузка контроллера

пример:

http://192.168.0.13:8090/api/serveroperations?operation=restart?apiKey=<ваш ключ>

УПРАВЛЕНИЕ ГРОМКОСТЬЮ

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=<ваш ключ>

СКРИНШОТ

GET

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

Получить изображение с видеостены по координатам

при пустых значениях x,y,width,height - возвращает скриншот стены целиком

Бэкап БД

POST

/api/dbbackup?apiKey=<ваш ключ>

Сохранить резервную копию БД