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

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

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

Часть url после номера порта и до знака «?» — непосредственный адрес точки входа в API. В данном случае это /api/app/frompreset

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

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

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

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

ИСТОЧНИКИ

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

POST

http://0.0.0.0:8090/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

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

name — произвольное имя источника 

type — тип выводимого контента

parameter — ссылка на ресурс или путь к файлу

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

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

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

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

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

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

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

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

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

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

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

PUT

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

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

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

PUT

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

ШАБЛОНЫ

Запуск шаблонов

POST

http://0.0.0.0:8090/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

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

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

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

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

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

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

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

Получить текущую громкость

GET

http://0.0.0.0:8090/api/volume?apiKey=<ваш ключ>

Установить громкость 0-100

POST

http://0.0.0.0:8090/api/volume?level=<0-100>&apiKey=<ваш ключ>

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

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

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

СКРИНШОТ

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

GET

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

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

БЭКАП БД

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

POST

http://0.0.0.0:8090/api/dbbackup?apiKey=<ваш ключ>

В данной инструкции приведено описание наиболее часто используемых запросов. Для получения более подробной консультации по вопросам взаимодействия через API создайте заявку в службе поддержки на этой странице.