Материал из for iRidium developers
Перейти к: навигация, поиск
Эта страница является переводом страницы REST API. Перевод выполнен на 100%.

Other languages:

API iRidium. REST API

REST API описывает взаимодействие с ядром Сервера при помощи HTTPs запросов. REST API позволяет сформировать кастомную web-страницу для обмена данными с сервером


Структура запроса

HTTP://IP:PORT/TYPE/NAME/BIND/COMMAND?PARAM=VALUE

  • IP - адресс веб интерфейса вашего сервера
  • PORT - порт на котором работает веб интерфейс
  • TYPE - способ обращения. Возможны такие как:
    • HTML - обращение как к веб странице
    • JSON - обращение к JSON пакету
    • PLAIN - использование API
  • NAME - Имя страницы, к которой следует обращаться для формирования ответа.
  • BIND - раздел API, содержащий список команд
  • COMMAND - команда, принадлежащая выбранному разделу API
  • PARAM=VALUE - параметры выполнения команды, значения для установки



Команды системного меню

Структура команды: https://127.0.0.1:8443/plain/api/systemmenu/<COMMAND>

  • TYPE: /plain/
  • NAME: /api/
  • BIND: /systemmenu/.../ несколько значений
  • COMMAND: /.../ несколько значений


Список BIND и соответствующих COMMAND:


systemmenu

Общая информация о сервере
https://127.0.0.1:8443/plain/api/systemmenu/...

.../buildversion/get версия сборки
.../buildnumber/get номер сборки
.../builddate/get дата сборки
.../buildtime/get время сборки
.../hwid/get HWID Сервера
.../ip/get IP адрес Сервера

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/hwid/get


systemmenu/server

Имя и модель сервера
https://127.0.0.1:8443/plain/api/systemmenu/server/...

.../name/get имя Сервера
.../os/get операционная система, где запущен Сервер
.../family/get семейство
.../model/get модель

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/server/name/get


systemmenu/update

Обновление серверного проекта
https://127.0.0.1:8443/plain/api/systemmenu/update/...

.../host/get получить IP адрес, с которого обновляется Серверный проект
.../host/set?value=<host> установить IP адрес, с которого должен обновляться Серверный проект
.../port/get получить порт обновления проекта
.../port/set?value=<port> установить порт обновления проекта

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/update/host/set?value=192.168.0.100

systemmenu/log

Логирование web-интерфейса, драйверов, скриптов сервера с помощью Syslog Server
https://127.0.0.1:8443/plain/api/systemmenu/log/...

.../systemmenu/log/host/get получить адрес Syslog Server для удаленной отладки
.../host/set?host=<host> установить адрес Syslog Server для удаленной отладки
.../port/get получить порт Syslog Server
.../port/set?port=<port> установить порт Syslog Server
.../enabled/get режим отладки, если включен - вернет адрес Syslog Server, если выключен - пустое поле. Для выключения удаленной отладки нужно очистить Host

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/log/host/set?host=192.168.0.100


systemmenu/log/level

Глубина логирования web-интерфейса, драйверов, скриптов сервера с помощью Syslog Server
https://127.0.0.1:8443/plain/api/systemmenu/log/level/...

.../wmi/get глубина логирования web-интерфейса
.../wmi/set?value=<0...7> установить глубину логирования web-интерфейса
.../db/get глубина логирования базы данных
.../db/set?value=<0...7> установить глубину логирования базы данных
.../script/get глубина логирования скриптов
.../script/set?value=<0...7> установить глубину логирования скриптов

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/log/level/script/set?value=7


systemmenu/dir

Размещение директорий, где хранятся ресурсы сервера
https://127.0.0.1:8443/plain/api/systemmenu/dir/...

.../doc/get расположение папки с проектом сервера
.../res/get расположение папки с ресурсами сервера
.../db/get расположение папки с базой данных
.../logs/get расположение папки с логами

Пример:
https://127.0.0.1:8443/plain/api/systemmenu/dir/logs/get


Команды драйверов

Структура команды: https://127.0.0.1:8443/html/devices/<BIND>/<COMMAND>

  • TYPE: /html/
  • NAME: /devices/
  • BIND: /.../ несколько значений
  • COMMAND: /.../ несколько значений



Список BIND и соотсветствующих им COMMAND:


devices/device

Настройки драйверов серверного проекта
https://127.0.0.1:8443/html/devices/devices/device/...

.../host/get?name=<driver_name> получить IP адрес подключения драйвера по имени
.../host/set?name=<driver_name>&host=<host> задать IP адрес подключения драйвера по имени
.../port/get?name=<driver_name> получить порт подключения драйвера по имени
.../port/set?name=<driver_name>&port=<port> задать порт подключения драйвера по имени
.../login/get?name=<driver_name> получить логин подключения драйвера по имени
.../pwd/get?name=<driver_name> получить пароль подключения драйвера по имени
.../param/get?name=<driver_name> получить параметры подключения драйвера по имени
.../online/get?name=<driver_name> получить статус подключения драйвера по имени
.../bg/get?name=<driver_name> получить состояние BackGround Mode драйвера по имени
.../logtag/get?name=<driver_name> получить статус логирования драйвера по имени
.../loglevel/get?name=<driver_name> получить уровень логирования драйвера по имени
.../loglevel/set?name=<driver_name>&value=<0...7> установить уровень логирования драйвера по имени
.../channels/get?name=<driver_name> получить список команд драйвера по имени
.../tags/get?name=<driver_name> получить список каналов обратной связи драйвера по имени

Пример:
https://127.0.0.1:8443/html/devices/devices/device/loglevel/set?name=KNX_BAOS_Server&value=0


license

Получить информацию о лицензии
https://127.0.0.1:8443/html/devices/license/...

.../get получить информацию о лицензии

Пример:
https://127.0.0.1:8443/html/devices/license/get


panels

Управлять подключенными панелями управления
https://127.0.0.1:8443/html/devices/kick/...

.../set?name=<name> отключить панель от сервера по имени
.../set?hwid=<HWID> отключить панель от сервера по HWID

Пример:
https://127.0.0.1:8443/html/devices/kick/set?hwid=0f2c522a2879c0fe1d586911d431951


logs

Управлять подключенными панелями управления
https://127.0.0.1:8443/html/devices/logs/...

.../filesizelimit/get получить максимальный размер файла лога
.../filesizelimit/set?log_filesize_limit=<size> задать максимальный размер файла лога, Mb
.../dirs/get получить директорию сохранения файла лога
.../files/get получить список файлов лога
.../lines/get
.../load/get
.../clear/set?ClearLog очистить лог

Пример:
https://127.0.0.1:8443/html/devices/filesizelimit/get