Перейти к основному контенту

API Документация

Описание

В данном документе описаны методы для взаимодействия с домофонной панелью через HTTP-запросы.

На устройстве по умолчанию 2 виртуальных сетевых интерфейса:
- Динамический;
- Статический (192.168.0.100).

Метод для настройки сетевых интерфейсов: /v1/network

Данные для авторизации по умолчанию:
- логин: root
- пароль: 123456

Метод для смены пароля: /user/change_password

Обязательные заголовки

Некоторые методы могут иметь другое значение для указанных заголовков или новые заголовки.

Запрос

Наименование Значение Описание
Authorization Basic cm9vdDoxMjM0NTY= Заголовок базовой авторизации
Content-Type application/json Тип передаваемых данных
Content-Length 0 Размер передаваемых данных

Ответ

Заголовки
Наименование Значение Описание
Content-Type application/json Тип возвращаемых данных
X-Device-Mac 08:13:00:00:00:00 MAC адрес устройства
X-Max-Content-Length 512000 Максимальный размер принимаемых данных
Коды
Наименование Значение
Успешные 200 OK
201 Created
204 No Content
Ошибки клиента 400 Bad Request
401 Unauthorized
404 Not Found
405 Method Not Allowed
413 Payload Too Large
422 Unprocessable Entity
423 Locked
429 Too Many Requests
Ошибки сервера 500 Internal Server Error

Авторизация

/auth/check

Метод проверки данных используемых для авторизации.

GET - Проверка авторизации
Ответы
200 OK

Заголовки:

Название Значение Описание
Content-Type text/html; charset=ISO-8859-1 Тип возвращаемых данных
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/auth/check'

Пользователь

/user

Методы получения / изменения настроек пользователя.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение параметров.
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
username string Наименование пользователя.
setup object Настройки первого запуска.
master boolean Флаг состояния прохождения мастера заведения устройства.
  • по умолчанию: False
logout object Данные для завершения сессии web интерфейса.
auto boolean Флаг включения / выключения режима.
  • по умолчанию: False
timeout integer Время автоматического завершения сессии при бездействии.
  • по умолчанию: 900
  • ограничения: от 60 до 1800
 
{
  "username": "root",
  "setup": {
    "master": false
  },
  "logout": {
    "auto": false,
    "timeout": 900
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/user'
PUT - Изменение параметров.
Запрос

Тело:

{
  "username": "root",
  "setup": {
    "master": false
  },
  "logout": {
    "auto": false,
    "timeout": 900
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
username string Наименование пользователя.
setup object Настройки первого запуска.
master boolean Флаг состояния прохождения мастера заведения устройства.
  • по умолчанию: False
logout object Данные для завершения сессии web интерфейса.
auto boolean Флаг включения / выключения режима.
  • по умолчанию: False
timeout integer Время автоматического завершения сессии при бездействии.
  • по умолчанию: 900
  • ограничения: от 60 до 1800
 
{
  "username": "root",
  "setup": {
    "master": false
  },
  "logout": {
    "auto": false,
    "timeout": 900
  }
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": "master",
      "message": "Тип параметра должен быть boolean"
    },
    {
      "field": "auto",
      "message": "Тип параметра должен быть boolean"
    },
    {
      "field": "timeout",
      "message": "Тип параметра должен быть integer"
    },
    {
      "field": "timeout",
      "message": "Значение параметра должно быть в диапазоне [60 - 1800]"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/user' \
--data-raw '{"username": "root", "setup": {"master": false, "auto": true}, "logout": {"auto": false, "timeout": 900}}'

/user/change_password

Метод изменения текущего пароля пользователя.

PUT - Изменение пароля пользователя.
Ответы
200 OK

Заголовки:

Название Значение Описание
Content-Type text/html; charset=ISO-8859-1 Тип возвращаемых данных
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": "newPassword",
      "message": "Ошибка получения параметра"
    },
    {
      "field": "newPassword",
      "message": "Параметр не должен содержать символы кириллицы"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка обновления параметра"
    }
  ]
}

Параметры API

/v1/api

Методы получения и настройки параметров HTTP-сервера.

GET - Получение параметров.
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port integer Номер TCP-порта HTTP-сервера. Обязательный параметр.
  • обязательный
  • по умолчанию: 80
  • ограничения: от 1 до 65535
 
{
  "port": 80
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/api'
PUT - Изменение параметров.
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port integer Номер TCP-порта HTTP-сервера. Обязательный параметр.
  • обязательный
  • по умолчанию: 80
  • ограничения: от 1 до 65535
 
{
  "port": 80
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": "port",
      "message": "Тип параметра должен быть integer"
    },
    {
      "field": "port",
      "message": "Порт \"8080\" недоступен"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/api' \
--data-raw '{"port": 80}'

/certs/https/key.pem

Методы получения / изменения ключа шифрования SSL.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение ключа шифрования SSL.
Ответы
200 OK 
-----BEGIN PRIVATE KEY-----
   *** PRIVATE KEY ***     
------END PRIVATE KEY------
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/certs/https/key.pem'
PUT - Изменение ключа шифрования SSL.
Запрос

Тело:

-----BEGIN PRIVATE KEY-----
   *** PRIVATE KEY ***     
------END PRIVATE KEY------
Ответы
200 OK 
-----BEGIN PRIVATE KEY-----
   *** PRIVATE KEY ***     
------END PRIVATE KEY------
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/certs/https/key.pem'

/certs/https/cert.pem

Методы получения / изменения сертификата шифрования SSL.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение сертификата шифрования SSL.
Ответы
200 OK 
-----BEGIN CERTIFICATE-----
   *** CERTIFICATE ***     
------END CERTIFICATE------
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/certs/https/cert.pem'
PUT - Изменение сертификата шифрования SSL.
Запрос

Тело:

-----BEGIN CERTIFICATE-----
   *** CERTIFICATE ***     
------END CERTIFICATE------
Ответы
200 OK 
-----BEGIN CERTIFICATE-----
   *** CERTIFICATE ***     
------END CERTIFICATE------
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/certs/https/cert.pem'

Параметры DDNS

/v1/ddns

Методы получения / изменения No-IP клиента.

GET - Получение параметров.
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения/выключения
  • по умолчанию: True
interval integer Интервал обновления в секундах
  • по умолчанию: 300
  • ограничения: от 60 до 1800
method string Метод HTTP-запроса
Info:

Доступен начиная с версии 2.5.0.12.x

  • по умолчанию: POST
server object Параметры сервера
port integer Порт сервера
  • по умолчанию: 8081
address string Адрес сервера
  • по умолчанию: 10.199.63.7
username string Имя пользователя для авторизации
  • по умолчанию: default
password string Пароль пользователя для авторизации
  • по умолчанию: default
data object  
hostname string Наименование хоста.
  • по умолчанию: ddns.ISCom
 
{
  "enabled": true,
  "interval": 300,
  "method": "POST",
  "server": {
    "port": 8081,
    "address": "10.199.63.7",
    "username": "default",
    "password": "default"
  },
  "data": {
    "hostname": "ddns.ISCom"
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/ddns'
PUT - Изменение параметров.
Запрос

Тело:

{
  "enabled": true,
  "interval": 300,
  "method": "POST",
  "server": {
    "port": 8081,
    "address": "10.199.63.7",
    "username": "default",
    "password": "default"
  },
  "data": {
    "hostname": "ddns.ISCom"
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения/выключения
  • по умолчанию: True
interval integer Интервал обновления в секундах
  • по умолчанию: 300
  • ограничения: от 60 до 1800
method string Метод HTTP-запроса
Info:

Доступен начиная с версии 2.5.0.12.x

  • по умолчанию: POST
server object Параметры сервера
port integer Порт сервера
  • по умолчанию: 8081
address string Адрес сервера
  • по умолчанию: 10.199.63.7
username string Имя пользователя для авторизации
  • по умолчанию: default
password string Пароль пользователя для авторизации
  • по умолчанию: default
data object  
hostname string Наименование хоста.
  • по умолчанию: ddns.ISCom
 
{
  "enabled": true,
  "interval": 300,
  "method": "POST",
  "server": {
    "port": 8081,
    "address": "10.199.63.7",
    "username": "default",
    "password": "default"
  },
  "data": {
    "hostname": "ddns.ISCom"
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/ddns'
--data-raw '{"enabled": true, "interval": 300, "method": "POST", "server": {"port": 8081, "address": "10.199.63.7", "username": "default", "password": "default"}, "data": {"hostname": "ddns.ISCom"}}'
DELETE - Cброс параметров.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/ddns'

Видеопоток

получение

Для получения видеопотоком необходимо использовать rtsp ссылки:
- rtsp://{login}:{password}@{address}:{port}/ch0 - основной видеопоток
- rtsp://{login}:{password}@{address}:{port}/ch1 - альтернативный видеопоток 1
- rtsp://{login}:{password}@{address}:{port}/ch2 - альтернативный видеопоток 2

Для управления видеопотоками используйте метод: /camera/codec


/camera/md

Методы получения / изменения детектора движения.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
md_enable boolean Флаг включения / выключения детектора движения.
  • по умолчанию: False
md_area_thr integer Минимальный размер детектируемой области.
Для людей на близком расстоянии примерно 100000 пикселей.
  • по умолчанию: 30000
md_send_snapshot_enable boolean Флаг включения / отключения отправки картинок.
  • по умолчанию: False
md_send_snapshot_interval integer Интервал в секундах между отправкой картинок на сервер.
ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений.
  • по умолчанию: 1
  • ограничения: от 1 до 20
md_logs_enable boolean Флаг включения / отключения отображения рамок детектора.
  • по умолчанию: False
md_rect_color string Цвет отображающихся рамок детектора.
md_frame_int integer Интервал между кадрами, отправляемыми на поиск движения.
  • по умолчанию: 30
md_frame_shift integer Смещение второго кадра, участвующего в определении детекции.
  • по умолчанию: 1
md_max_rect_ratio double Максимальное соотношение длина / ширина прямоугольника для отображения.
  • по умолчанию: 8.0
snap_send_url string HTTP ссылка на которую будут отправляться картинки.
Данные формата "application/json" отправляются на HTTP-сервер с помощью POST метода.
md_active_time integer добавлено после версий от 01.08
Время охлаждения после отправки сообщения в логи о конце движения
  • по умолчанию: 1
  • ограничения: от 1 до 5
md_event_ext_data object Дополнительные JSON параметры отправляемые вместе с картинкой на сервер.
  • ограничения:
    • null
    • object
 
{
  "md_enable": false,
  "md_area_thr": 30000,
  "md_send_snapshot_enable": false,
  "md_send_snapshot_interval": 1,
  "md_logs_enable": false,
  "md_rect_color": "",
  "md_frame_int": 30,
  "md_frame_shift": 1,
  "md_max_rect_ratio": 8.0,
  "snap_send_url": "",
  "md_active_time": 1,
  "md_event_ext_data": {}
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/md'
PUT - Изменение параметров
Запрос

Тело:

{
  "md_enable": false,
  "md_area_thr": 30000,
  "md_send_snapshot_enable": false,
  "md_send_snapshot_interval": 1,
  "md_logs_enable": false,
  "md_rect_color": "",
  "md_frame_int": 30,
  "md_frame_shift": 1,
  "md_max_rect_ratio": 8.0,
  "snap_send_url": "",
  "md_active_time": 1,
  "md_event_ext_data": {}
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
md_enable boolean Флаг включения / выключения детектора движения.
  • по умолчанию: False
md_area_thr integer Минимальный размер детектируемой области.
Для людей на близком расстоянии примерно 100000 пикселей.
  • по умолчанию: 30000
md_send_snapshot_enable boolean Флаг включения / отключения отправки картинок.
  • по умолчанию: False
md_send_snapshot_interval integer Интервал в секундах между отправкой картинок на сервер.
ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений.
  • по умолчанию: 1
  • ограничения: от 1 до 20
md_logs_enable boolean Флаг включения / отключения отображения рамок детектора.
  • по умолчанию: False
md_rect_color string Цвет отображающихся рамок детектора.
md_frame_int integer Интервал между кадрами, отправляемыми на поиск движения.
  • по умолчанию: 30
md_frame_shift integer Смещение второго кадра, участвующего в определении детекции.
  • по умолчанию: 1
md_max_rect_ratio double Максимальное соотношение длина / ширина прямоугольника для отображения.
  • по умолчанию: 8.0
snap_send_url string HTTP ссылка на которую будут отправляться картинки.
Данные формата "application/json" отправляются на HTTP-сервер с помощью POST метода.
md_active_time integer добавлено после версий от 01.08
Время охлаждения после отправки сообщения в логи о конце движения
  • по умолчанию: 1
  • ограничения: от 1 до 5
md_event_ext_data object Дополнительные JSON параметры отправляемые вместе с картинкой на сервер.
  • ограничения:
    • null
    • object
 
{
  "md_enable": false,
  "md_area_thr": 30000,
  "md_send_snapshot_enable": false,
  "md_send_snapshot_interval": 1,
  "md_logs_enable": false,
  "md_rect_color": "",
  "md_frame_int": 30,
  "md_frame_shift": 1,
  "md_max_rect_ratio": 8.0,
  "snap_send_url": "",
  "md_active_time": 1,
  "md_event_ext_data": {}
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/md'

/camera/rtsp

Методы получения / изменения RTSP сервера.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port boolean Порт получения RTSP видеопотока.
  • по умолчанию: 554
  • ограничения: от 1 до 65535
 
{
  "port": 554
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/rtsp'
PUT - Изменение параметров
Запрос

Тело:

{
  "port": 554
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port boolean Порт получения RTSP видеопотока.
  • по умолчанию: 554
  • ограничения: от 1 до 65535
 
{
  "port": 554
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/rtsp'

/camera/audio

Методы получения / изменения аудио видеопотока.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
aac_enable boolean Рекомендуется к использованию параметр "format"
Флаг включение / выключения аудио кодека ААС в RTSP видеопотоке.
  • по умолчанию: True
format string Выбор аудио кодека в RTSP видеопотоке.
  • по умолчанию: AAC
  • ограничения:
    • AAC
    • PCM
    • PCMA
    • PCMU
mic_gain integer Усиление микрофона..
  • по умолчанию: -30
  • ограничения: от -79 до 70
spk_gain integer Громкость динамика..
  • по умолчанию: 6
  • ограничения: от 0 до 6
micGain integer Программное усиление микрофона.
  • по умолчанию: 20
  • ограничения: от 1 до 50
 
{
  "aac_enable": true,
  "format": "AAC",
  "mic_gain": -30,
  "spk_gain": 6,
  "micGain": 20
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/audio'
PUT - Изменение параметров
Запрос

Тело:

{
  "aac_enable": true,
  "format": "AAC",
  "mic_gain": -30,
  "spk_gain": 6,
  "micGain": 20
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
aac_enable boolean Рекомендуется к использованию параметр "format"
Флаг включение / выключения аудио кодека ААС в RTSP видеопотоке.
  • по умолчанию: True
format string Выбор аудио кодека в RTSP видеопотоке.
  • по умолчанию: AAC
  • ограничения:
    • AAC
    • PCM
    • PCMA
    • PCMU
mic_gain integer Усиление микрофона..
  • по умолчанию: -30
  • ограничения: от -79 до 70
spk_gain integer Громкость динамика..
  • по умолчанию: 6
  • ограничения: от 0 до 6
micGain integer Программное усиление микрофона.
  • по умолчанию: 20
  • ограничения: от 1 до 50
 
{
  "aac_enable": true,
  "format": "AAC",
  "mic_gain": -30,
  "spk_gain": 6,
  "micGain": 20
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/audio'

/camera/codec

Методы получения / изменения видеопотоков.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
Channels array Массив настроек видеопотоков.
Channel integer Номер канала. Обязательный параметр.
  • обязательный
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный 1)
    • 2 (альтернативный 2)
Enabled boolean Флаг включения / выключения видео потока.
ВАЖНО! параметр используется только для видеопотока "альтернативный 2".
Type string Тип кодека.
  • по умолчанию: H264
  • ограничения: H264
Profile integer Профиль кодека.
  • по умолчанию: 1
  • ограничения:
    • 0 (main)
    • 1 (baseline)
    • 2 (high)
ByFrame boolean Флаг переключения формата получения видеопотока.
  • по умолчанию: True
  • ограничения:
    • true (по кадрово)
    • false (по пакетно)
Width integer Ширина кадра в пикселях.
  • по умолчанию: 1920
  • ограничения:
    • 1920x1080
    • 1280x720
    • 720x576
    • 704x576
    • 640x480
    • 640x360
Height integer Высота кадра в пикселях.
  • по умолчанию: 1080
  • ограничения:
    • 1920x1080
    • 1280x720
    • 720x576
    • 704x576
    • 640x480
    • 640x360
GopMode string Режим определяющий использование P (в том числе SP, VI) и B кадров и их чередование.
  • по умолчанию: NormalP
  • ограничения:
    • NormalP
    • SmartP
    • DualP
  • зависимые параметры:
    • при GopMode равном NormalP появляются:
      • IPQpDelta
    • при GopMode равном SmartP появляются:
      • BgQpDelta
      • ViQpDelta
      • BgInterval
    • при GopMode равном DualP появляются:
      • IPQpDelta
      • SPQpDelta
      • SPInterval
IPQpDelta integer Разница QP между I и P кадрами.
При GopMode = NormalP или DualP.
  • по умолчанию: 2
  • ограничения: от -10 до 30
BgQpDelta integer (SmartP) QP для фоновых кадров.
  • ограничения: от -10 до 30
ViQpDelta integer (SmartP) QP для кадров с движением.
  • ограничения: от -10 до 30
BgInterval integer (SmartP) Интервал фоновых кадров; кратен GOP.
SPQpDelta integer (DualP) QP для SP-кадра.
  • ограничения: от -10 до 30
SPInterval integer (DualP) Интервал SP-кадра, от 0 до GOP.
RcMode string Режим кодирования потока.
  • по умолчанию: AVBR
  • ограничения:
    • CBR
    • VBR
    • AVBR
    • CVBR
    • QVBR
    • FIXQP
    • QPMAP
  • зависимые параметры:
    • при RcMode равном CBR появляются:
      • Bitrate
    • при RcMode равном VBR появляются:
      • MaxBitrate
    • при RcMode равном AVBR появляются:
      • MaxBitrate
    • при RcMode равном CVBR появляются:
      • MaxBitrate
      • LongTermMaxBitrate
      • LongTermMinBitrate
      • ShortTermStatTime
      • LongTermStatTime
    • при RcMode равном QVBR появляются:
      • TargetBitrate
    • при RcMode равном FIXQP появляются:
      • IQp
      • PQp
      • BQp
IFrameInterval integer Интервал I-кадра (GOP), в кадрах.
  • по умолчанию: 30
  • ограничения: от 1 до 65536
Bitrate integer (CBR) Целевой битрейт (кбит/с).
MaxBitrate integer (VBR, AVBR, CVBR) Максимальный битрейт (кбит/с).
TargetBitrate integer (QVBR) Целевой битрейт (кбит/с).
LongTermMaxBitrate integer (CVBR) Долгосрочный максимальный битрейт (кбит/с).
LongTermMinBitrate integer (CVBR) Долгосрочный минимальный битрейт (кбит/с).
ShortTermStatTime integer (CVBR) Время краткосрочной статистики, с.
LongTermStatTime integer (CVBR) Время долгосрочной статистики.
IQp integer (FIXQP) QP для I-кадра.
PQp integer (FIXQP) QP для P-кадра.
BQp integer (FIXQP) QP для B-кадра.
Framerate integer Целевой FPS (кадров/с).
  • по умолчанию: 30
  • ограничения: от 5 до 30
 
{
  "Channels": [
    {
      "Channel": 0,
      "Enabled": false,
      "Type": "H264",
      "Profile": 1,
      "ByFrame": true,
      "Width": 1920,
      "Height": 1080,
      "GopMode": "NormalP",
      "RcMode": "AVBR",
      "IFrameInterval": 30,
      "Framerate": 30,
      "IPQpDelta": 2,
      "MaxBitrate": 0
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/codec'
PUT - Изменение параметров
Запрос

Тело:

{
  "Channels": [
    {
      "Channel": 0,
      "Enabled": false,
      "Type": "H264",
      "Profile": 1,
      "ByFrame": true,
      "Width": 1920,
      "Height": 1080,
      "GopMode": "NormalP",
      "RcMode": "AVBR",
      "IFrameInterval": 30,
      "Framerate": 30,
      "IPQpDelta": 2,
      "MaxBitrate": 0
    }
  ]
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
Channels array Массив настроек видеопотоков.
Channel integer Номер канала. Обязательный параметр.
  • обязательный
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный 1)
    • 2 (альтернативный 2)
Enabled boolean Флаг включения / выключения видео потока.
ВАЖНО! параметр используется только для видеопотока "альтернативный 2".
Type string Тип кодека.
  • по умолчанию: H264
  • ограничения: H264
Profile integer Профиль кодека.
  • по умолчанию: 1
  • ограничения:
    • 0 (main)
    • 1 (baseline)
    • 2 (high)
ByFrame boolean Флаг переключения формата получения видеопотока.
  • по умолчанию: True
  • ограничения:
    • true (по кадрово)
    • false (по пакетно)
Width integer Ширина кадра в пикселях.
  • по умолчанию: 1920
  • ограничения:
    • 1920x1080
    • 1280x720
    • 720x576
    • 704x576
    • 640x480
    • 640x360
Height integer Высота кадра в пикселях.
  • по умолчанию: 1080
  • ограничения:
    • 1920x1080
    • 1280x720
    • 720x576
    • 704x576
    • 640x480
    • 640x360
GopMode string Режим определяющий использование P (в том числе SP, VI) и B кадров и их чередование.
  • по умолчанию: NormalP
  • ограничения:
    • NormalP
    • SmartP
    • DualP
  • зависимые параметры:
    • при GopMode равном NormalP появляются:
      • IPQpDelta
    • при GopMode равном SmartP появляются:
      • BgQpDelta
      • ViQpDelta
      • BgInterval
    • при GopMode равном DualP появляются:
      • IPQpDelta
      • SPQpDelta
      • SPInterval
IPQpDelta integer Разница QP между I и P кадрами.
При GopMode = NormalP или DualP.
  • по умолчанию: 2
  • ограничения: от -10 до 30
BgQpDelta integer (SmartP) QP для фоновых кадров.
  • ограничения: от -10 до 30
ViQpDelta integer (SmartP) QP для кадров с движением.
  • ограничения: от -10 до 30
BgInterval integer (SmartP) Интервал фоновых кадров; кратен GOP.
SPQpDelta integer (DualP) QP для SP-кадра.
  • ограничения: от -10 до 30
SPInterval integer (DualP) Интервал SP-кадра, от 0 до GOP.
RcMode string Режим кодирования потока.
  • по умолчанию: AVBR
  • ограничения:
    • CBR
    • VBR
    • AVBR
    • CVBR
    • QVBR
    • FIXQP
    • QPMAP
  • зависимые параметры:
    • при RcMode равном CBR появляются:
      • Bitrate
    • при RcMode равном VBR появляются:
      • MaxBitrate
    • при RcMode равном AVBR появляются:
      • MaxBitrate
    • при RcMode равном CVBR появляются:
      • MaxBitrate
      • LongTermMaxBitrate
      • LongTermMinBitrate
      • ShortTermStatTime
      • LongTermStatTime
    • при RcMode равном QVBR появляются:
      • TargetBitrate
    • при RcMode равном FIXQP появляются:
      • IQp
      • PQp
      • BQp
IFrameInterval integer Интервал I-кадра (GOP), в кадрах.
  • по умолчанию: 30
  • ограничения: от 1 до 65536
Bitrate integer (CBR) Целевой битрейт (кбит/с).
MaxBitrate integer (VBR, AVBR, CVBR) Максимальный битрейт (кбит/с).
TargetBitrate integer (QVBR) Целевой битрейт (кбит/с).
LongTermMaxBitrate integer (CVBR) Долгосрочный максимальный битрейт (кбит/с).
LongTermMinBitrate integer (CVBR) Долгосрочный минимальный битрейт (кбит/с).
ShortTermStatTime integer (CVBR) Время краткосрочной статистики, с.
LongTermStatTime integer (CVBR) Время долгосрочной статистики.
IQp integer (FIXQP) QP для I-кадра.
PQp integer (FIXQP) QP для P-кадра.
BQp integer (FIXQP) QP для B-кадра.
Framerate integer Целевой FPS (кадров/с).
  • по умолчанию: 30
  • ограничения: от 5 до 30
 
{
  "Channels": [
    {
      "Channel": 0,
      "Enabled": false,
      "Type": "H264",
      "Profile": 1,
      "ByFrame": true,
      "Width": 1920,
      "Height": 1080,
      "GopMode": "NormalP",
      "RcMode": "AVBR",
      "IFrameInterval": 30,
      "Framerate": 30,
      "IPQpDelta": 2,
      "MaxBitrate": 0
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/codec'

/camera/picture

Методы получения / изменения отражения картинки.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
Image object Параметры отражения картинки.
Flip boolean Отражение изображения по вертикали.
  • по умолчанию: False
Mirror boolean Отражение изображения по горизонтали.
  • по умолчанию: False
 
{
  "Image": {
    "Flip": false,
    "Mirror": false
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/picture'
PUT - Изменение параметров
Запрос

Тело:

{
  "Image": {
    "Flip": false,
    "Mirror": false
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
Image object Параметры отражения картинки.
Flip boolean Отражение изображения по вертикали.
  • по умолчанию: False
Mirror boolean Отражение изображения по горизонтали.
  • по умолчанию: False
 
{
  "Image": {
    "Flip": false,
    "Mirror": false
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/picture'

/camera/snapshot

Метод получения картинки из видеопотока.

GET - Получение картинки
Ответы
200 OK 
*****************
Бинарная картинка
*****************
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/snapshot'

/camera/whiteBlack

Методы получения / изменения перехода в черно-белый режим.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
state boolean Состояние черно-белого режима.
  • по умолчанию: False
threshold object Параметры порогового значения.
exposureCurrent integer Текущее значение порогового значения.
  • ограничения: от 0 до 4294967295
exposureLight integer Порог включения цветного режима.
  • по умолчанию: 22000
  • ограничения: от 0 до 4294967295
exposureNight integer Порог включения черно-белого режима.
  • по умолчанию: 250000
  • ограничения: от 0 до 4294967295
 
{
  "state": false,
  "threshold": {
    "exposureCurrent": 0,
    "exposureLight": 22000,
    "exposureNight": 250000
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/whiteBlack'
PUT - Изменение параметров
Запрос

Тело:

{
  "state": false,
  "threshold": {
    "exposureCurrent": 0,
    "exposureLight": 22000,
    "exposureNight": 250000
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
state boolean Состояние черно-белого режима.
  • по умолчанию: False
threshold object Параметры порогового значения.
exposureCurrent integer Текущее значение порогового значения.
  • ограничения: от 0 до 4294967295
exposureLight integer Порог включения цветного режима.
  • по умолчанию: 22000
  • ограничения: от 0 до 4294967295
exposureNight integer Порог включения черно-белого режима.
  • по умолчанию: 250000
  • ограничения: от 0 до 4294967295
 
{
  "state": false,
  "threshold": {
    "exposureCurrent": 0,
    "exposureLight": 22000,
    "exposureNight": 250000
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/whiteBlack'

/v2/camera/osd

Методы получения / изменения наложения текста в видеопотоке.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
size integer Размер шрифта.
text string Текст строки.
color string Цвет строки.
date object Параметры даты.
enable boolean Флаг включения / выключения даты.
format string Формат даты (варианты).
time object Параметры времени.
enable boolean Флаг включения / выключения времени.
format string Формат времени (варианты).
position object Параметры расположения.
x integer Расположение по оси X (в пикселях относительно размера картинки основного видеопотока).
y integer Расположение по оси Y (в пикселях относительно размера картинки основного видеопотока).
background object Параметры фона.
enable boolean Флаг включения / выключения фона.
color string Цвет фона. 
{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/osd'
PUT - Изменение параметров
Запрос

Тело:

{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
size integer Размер шрифта.
text string Текст строки.
color string Цвет строки.
date object Параметры даты.
enable boolean Флаг включения / выключения даты.
format string Формат даты (варианты).
time object Параметры времени.
enable boolean Флаг включения / выключения времени.
format string Формат времени (варианты).
position object Параметры расположения.
x integer Расположение по оси X (в пикселях относительно размера картинки основного видеопотока).
y integer Расположение по оси Y (в пикселях относительно размера картинки основного видеопотока).
background object Параметры фона.
enable boolean Флаг включения / выключения фона.
color string Цвет фона. 
{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/osd'

/v2/camera/picture

Методы получения / изменения картинки видеопотока.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
u8Contr integer Контрастность изображения.
  • по умолчанию: 50
u8Luma integer Яркость изображения.
  • по умолчанию: 50
u8Satu integer Насыщенность изображения.
  • по умолчанию: 50
u8Hue integer Регулировка оттенка изображения.
  • по умолчанию: 50
wb object Параметры баланса белого.
u8RGStrength integer Усиление канала R в автоматическом балансе белого (AWB).
  • ограничения: от 0 до 255
u8BGStrength integer Усиление канала B в автоматическом балансе белого (AWB).
  • ограничения: от 0 до 255
dehaze object Параметры устранения дымки.
u8strength integer Интенсивность устранения дымки.
drc object Параметры регулирования динамического диапазона.
u16Strength integer Основная интенсивность DRC.
  • ограничения: от 0 до 1023
u16StrengthMin integer Граница тёмной области (нижняя граница усиления). Должно быть не больше u16StrengthMax.
  • ограничения: от 0 до 1023
u16StrengthMax integer Граница светлой области (верхняя граница усиления). Должно быть не меньше u16StrengthMin.
  • ограничения: от 0 до 1023
iso object Параметры резкости по уровням ISO. index — текущий уровень (только чтение); params — настройки резкости для уровней 0–15.
index integer Текущий уровень ISO (0–15), только для чтения; соответствует активной экспозиции.
  • ограничения: от 0 до 15
params object Настройки резкости по уровням ISO; ключи "0"–"15".
0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15 object Параметры резкости для уровня ISO N.
sharpness object Параметры резкости (частота текстуры/границ, усиления по зонам).
au16TextureFreq integer Частота текстуры; с ростом значения детали и текстура становятся тоньше.
  • ограничения: от 0 до 4095
au16EdgeFreq integer Частота границ; с ростом значения границы уже и тоньше.
  • ограничения: от 0 до 4095
au8OverShoot integer Величина перерегулирования (overshoot).
  • ограничения: от 0 до 127
au8UnderShoot integer Величина недорегулирования (undershoot).
  • ограничения: от 0 до 127
au8DetailCtrl integer Соотношение резкости деталей и границ; больше 128 — сильнее детали.
  • ограничения: от 0 до 255
au8RGain integer Усиление резкости для красной области.
  • ограничения: от 0 до 31
au8GGain integer Усиление резкости для зелёной области.
  • ограничения: от 0 до 255
au8BGain integer Усиление резкости для синей области.
  • ограничения: от 0 до 31
au8SkinGain integer Усиление резкости для области кожи.
  • ограничения: от 0 до 31
au16MaxSharpGain integer Максимальное усиление резкости.
  • ограничения: от 0 до 2047
 
{
  "u8Contr": 50,
  "u8Luma": 50,
  "u8Satu": 50,
  "u8Hue": 50,
  "wb": {
    "u8RGStrength": 0,
    "u8BGStrength": 0
  },
  "dehaze": {
    "u8strength": 0
  },
  "drc": {
    "u16Strength": 0,
    "u16StrengthMin": 0,
    "u16StrengthMax": 0
  },
  "iso": {
    "index": 0,
    "params": {
      "0": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "1": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "2": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "3": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "4": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "5": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "6": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "7": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "9": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "10": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "11": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "12": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "13": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "14": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "15": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      }
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/picture'
PUT - Изменение параметров
Запрос

Тело:

{
  "u8Contr": 50,
  "u8Luma": 50,
  "u8Satu": 50,
  "u8Hue": 50,
  "wb": {
    "u8RGStrength": 0,
    "u8BGStrength": 0
  },
  "dehaze": {
    "u8strength": 0
  },
  "drc": {
    "u16Strength": 0,
    "u16StrengthMin": 0,
    "u16StrengthMax": 0
  },
  "iso": {
    "index": 0,
    "params": {
      "0": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "1": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "2": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "3": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "4": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "5": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "6": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "7": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "9": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "10": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "11": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "12": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "13": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "14": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "15": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      }
    }
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
u8Contr integer Контрастность изображения.
  • по умолчанию: 50
u8Luma integer Яркость изображения.
  • по умолчанию: 50
u8Satu integer Насыщенность изображения.
  • по умолчанию: 50
u8Hue integer Регулировка оттенка изображения.
  • по умолчанию: 50
wb object Параметры баланса белого.
u8RGStrength integer Усиление канала R в автоматическом балансе белого (AWB).
  • ограничения: от 0 до 255
u8BGStrength integer Усиление канала B в автоматическом балансе белого (AWB).
  • ограничения: от 0 до 255
dehaze object Параметры устранения дымки.
u8strength integer Интенсивность устранения дымки.
drc object Параметры регулирования динамического диапазона.
u16Strength integer Основная интенсивность DRC.
  • ограничения: от 0 до 1023
u16StrengthMin integer Граница тёмной области (нижняя граница усиления). Должно быть не больше u16StrengthMax.
  • ограничения: от 0 до 1023
u16StrengthMax integer Граница светлой области (верхняя граница усиления). Должно быть не меньше u16StrengthMin.
  • ограничения: от 0 до 1023
iso object Параметры резкости по уровням ISO. index — текущий уровень (только чтение); params — настройки резкости для уровней 0–15.
index integer Текущий уровень ISO (0–15), только для чтения; соответствует активной экспозиции.
  • ограничения: от 0 до 15
params object Настройки резкости по уровням ISO; ключи "0"–"15".
0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15 object Параметры резкости для уровня ISO N.
sharpness object Параметры резкости (частота текстуры/границ, усиления по зонам).
au16TextureFreq integer Частота текстуры; с ростом значения детали и текстура становятся тоньше.
  • ограничения: от 0 до 4095
au16EdgeFreq integer Частота границ; с ростом значения границы уже и тоньше.
  • ограничения: от 0 до 4095
au8OverShoot integer Величина перерегулирования (overshoot).
  • ограничения: от 0 до 127
au8UnderShoot integer Величина недорегулирования (undershoot).
  • ограничения: от 0 до 127
au8DetailCtrl integer Соотношение резкости деталей и границ; больше 128 — сильнее детали.
  • ограничения: от 0 до 255
au8RGain integer Усиление резкости для красной области.
  • ограничения: от 0 до 31
au8GGain integer Усиление резкости для зелёной области.
  • ограничения: от 0 до 255
au8BGain integer Усиление резкости для синей области.
  • ограничения: от 0 до 31
au8SkinGain integer Усиление резкости для области кожи.
  • ограничения: от 0 до 31
au16MaxSharpGain integer Максимальное усиление резкости.
  • ограничения: от 0 до 2047
 
{
  "u8Contr": 50,
  "u8Luma": 50,
  "u8Satu": 50,
  "u8Hue": 50,
  "wb": {
    "u8RGStrength": 0,
    "u8BGStrength": 0
  },
  "dehaze": {
    "u8strength": 0
  },
  "drc": {
    "u16Strength": 0,
    "u16StrengthMin": 0,
    "u16StrengthMax": 0
  },
  "iso": {
    "index": 0,
    "params": {
      "0": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "1": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "2": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "3": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "4": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "5": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "6": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "7": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "9": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "10": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "11": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "12": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "13": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "14": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      },
      "15": {
        "sharpness": {
          "au16TextureFreq": 0,
          "au16EdgeFreq": 0,
          "au8OverShoot": 0,
          "au8UnderShoot": 0,
          "au8DetailCtrl": 0,
          "au8RGain": 0,
          "au8GGain": 0,
          "au8BGain": 0,
          "au8SkinGain": 0,
          "au16MaxSharpGain": 0
        }
      }
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/picture'

/v3/camera/osd

Методы получения / изменения наложения текста в видеопотоке.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
size integer Размер шрифта.
text string Текст строки.
color string Цвет строки.
date object Параметры даты.
enable boolean Флаг включения / выключения даты.
format string Формат даты.
time object Параметры времени.
enable boolean Флаг включения / выключения времени.
format string Формат времени.
position object Параметры расположения.
x integer Расположение по оси X (процент от размера картинки видеотока).
y integer Расположение по оси Y (процент от размера картинки видеотока).
background object Параметры фона.
enable boolean Флаг включения / выключения фона.
color string Цвет фона. 
{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v3/camera/osd'
PUT - Изменение параметров
Запрос

Тело:

{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
size integer Размер шрифта.
text string Текст строки.
color string Цвет строки.
date object Параметры даты.
enable boolean Флаг включения / выключения даты.
format string Формат даты.
time object Параметры времени.
enable boolean Флаг включения / выключения времени.
format string Формат времени.
position object Параметры расположения.
x integer Расположение по оси X (процент от размера картинки видеотока).
y integer Расположение по оси Y (процент от размера картинки видеотока).
background object Параметры фона.
enable boolean Флаг включения / выключения фона.
color string Цвет фона. 
{
  "size": 0,
  "text": "",
  "color": "",
  "date": {
    "enable": false,
    "format": ""
  },
  "time": {
    "enable": false,
    "format": ""
  },
  "position": {
    "x": 0,
    "y": 0
  },
  "background": {
    "enable": false,
    "color": ""
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v3/camera/osd'

Коды

/openCode

Методы получения / добавления кодов.

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
[
  {
    "code": 12345,
    "panelCode": 1
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
405 Method Not Allowed

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Метод не разрешён для данного ресурса"
    }
  ]
}
429 Too Many Requests

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Превышен лимит запросов"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode'
POST - Добавление кода
Запрос

Тело:

{
  "code": 12345,
  "panelCode": 1
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
{
  "code": 12345,
  "panelCode": 1
}
201 Created

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
{
  "code": 12345,
  "panelCode": 1
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/openCode'

/openCode/clear

Метод очистки кодов на устройстве.

DELETE - Получение списка
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/clear'

/openCode/{квартира}

Метод удаления кодов.

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
[
  {
    "code": 12345,
    "panelCode": 1
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode/1'
DELETE - Удаление кодов
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/1'

/openCode/{квартира}/{код}

Метод удаления кода из квартиры.

DELETE - Удаление кода
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/1/12345'

/v1/openCode

Методы получения / добавления кодов.

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
[
  {
    "code": 12345,
    "panelCode": 1
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/openCode'
POST - Добавление кода
Запрос

Тело:

[
  {
    "code": 12345,
    "panelCode": 1
  }
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code string Идентификатор кода открытия. Обязательный параметр.
  • обязательный
  • ограничения: от 10000 до 99999
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 9999
 
[
  {
    "code": 12345,
    "panelCode": 1
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/v1/openCode'

/openCode/settings

Метод очистки кодов на устройстве.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
commonCode object Параметры общего кода открытия.
enable boolean Флаг включения / выключения.
  • по умолчанию: False
value string Значение общего кода.
  • по умолчанию: 0
  • ограничения: от 10000 до 99999
 
{
  "commonCode": {
    "enable": false,
    "value": 0
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "commonCode": {
    "enable": false,
    "value": 0
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
commonCode object Параметры общего кода открытия.
enable boolean Флаг включения / выключения.
  • по умолчанию: False
value string Значение общего кода.
  • по умолчанию: 0
  • ограничения: от 10000 до 99999
 
{
  "commonCode": {
    "enable": false,
    "value": 0
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/openCode/settings'
DELETE - Удаление параметров
Ответы
200 OK

 

Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/settings'

Ключи

/key/store

Методы получения / добавления ключей.

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
uuid string Идентификатор ключа. Обязательный параметр.
  • обязательный
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
encryption boolean Флаг включения / выключения персональной проверки шифрования.
ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
  • по умолчанию: False
access object Флаги доступа ко входам
main boolean Флаг открытия основного входа.
  • по умолчанию: True
second boolean Флаг открытия дополнительного входа.
  • по умолчанию: True
0, 1, 2, 3 boolean Флаг открытия внешнего входа.
  • по умолчанию: True
profileNum integer Номер профиля.
secretValue string Секретное значение.
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
virtual boolean Флаг виртуального ключа.
  • по умолчанию: True
 
[
  {
    "uuid": "AABBCCDDEEFF",
    "panelCode": 1,
    "encryption": false,
    "access": {
      "main": true,
      "second": true,
      "0": true,
      "1": true,
      "2": true,
      "3": true
    },
    "profileNum": 0,
    "secretValue": "",
    "securityLevel": 0,
    "virtual": true
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/store'
POST - Добавление ключа
Запрос

Тело:

{
  "uuid": "AABBCCDDEEFF",
  "panelCode": 1,
  "encryption": false,
  "access": {
    "main": true,
    "second": true,
    "0": true,
    "1": true,
    "2": true,
    "3": true
  },
  "profileNum": 0,
  "secretValue": "",
  "securityLevel": 0,
  "virtual": true
}
Ответы
204 OK

Тело:

Описание параметров
Название Тип Описание
uuid string Идентификатор ключа. Обязательный параметр.
  • обязательный
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
encryption boolean Флаг включения / выключения персональной проверки шифрования.
ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
  • по умолчанию: False
access object Флаги доступа ко входам
main boolean Флаг открытия основного входа.
  • по умолчанию: True
second boolean Флаг открытия дополнительного входа.
  • по умолчанию: True
0, 1, 2, 3 boolean Флаг открытия внешнего входа.
  • по умолчанию: True
profileNum integer Номер профиля.
secretValue string Секретное значение.
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
virtual boolean Флаг виртуального ключа.
  • по умолчанию: True
 
{
  "uuid": "AABBCCDDEEFF",
  "panelCode": 1,
  "encryption": false,
  "access": {
    "main": true,
    "second": true,
    "0": true,
    "1": true,
    "2": true,
    "3": true
  },
  "profileNum": 0,
  "secretValue": "",
  "securityLevel": 0,
  "virtual": true
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/key/store'

/key/store/merge

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

PUT - Изменение ключей
Запрос

Тело:

[
  {
    "uuid": "AABBCCDDEEFF",
    "panelCode": 1,
    "encryption": false,
    "access": {
      "main": true,
      "second": true,
      "0": true,
      "1": true,
      "2": true,
      "3": true
    },
    "profileNum": 0,
    "secretValue": "",
    "securityLevel": 0,
    "virtual": true
  }
]
Ответы
204 OK

Тело:

Описание параметров
Название Тип Описание
uuid string Идентификатор ключа. Обязательный параметр.
  • обязательный
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
encryption boolean Флаг включения / выключения персональной проверки шифрования.
ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
  • по умолчанию: False
access object Флаги доступа ко входам
main boolean Флаг открытия основного входа.
  • по умолчанию: True
second boolean Флаг открытия дополнительного входа.
  • по умолчанию: True
0, 1, 2, 3 boolean Флаг открытия внешнего входа.
  • по умолчанию: True
profileNum integer Номер профиля.
secretValue string Секретное значение.
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
virtual boolean Флаг виртуального ключа.
  • по умолчанию: True
 
[
  {
    "uuid": "AABBCCDDEEFF",
    "panelCode": 1,
    "encryption": false,
    "access": {
      "main": true,
      "second": true,
      "0": true,
      "1": true,
      "2": true,
      "3": true
    },
    "profileNum": 0,
    "secretValue": "",
    "securityLevel": 0,
    "virtual": true
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/merge'

/key/store/clear

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

DELETE - Удаление ключа
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/clear'

/key/store/{ключ}

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

GET - Получение параметров
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'
PUT - Изменение параметров
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'
DELETE - Удаление ключа
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
404 Not Found

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ключ не найден"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'

/key/settings

Методы получения / изменения параметров взаимодействия с ключами.

GET - Получение параметров
Ответы
204 OK

Тело:

Описание параметров
Название Тип Описание
any_key_open boolean Режим открытия двери любым ключом.
ВАЖНО: При включенном режиме ключи приложенные к считывателю не записываются в базу данных.
ВАЖНО: Включенный режим автосбора ключей игнорируется
  • по умолчанию: False
inverse_uid_open boolean Режим проверки обратного идентификатора ключа.
ВАЖНО: Панель приложенный ключ проверит прямой и обратный идентификатор (AABBCCDD и DDCCBBAA).
  • по умолчанию: False
autocollect object Параметры режима автосбора ключей.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
room integer Номер квартиры привязывающиеся приложенные ключи.
  • по умолчанию: 0
  • ограничения: от 0 до 9999
keyMask string Маска идентификатора ключа
ВАЖНО: На панель будет добавлены только те ключи, которые пройдут маску.
  • по умолчанию: xxxxxxxxxxxxxx
access object Параметры назначаемых доступов добавленных через режим автосбора ключей.
main boolean Доступ на открытие основной двери.
  • по умолчанию: False
second boolean Доступ на открытие дополнительной двери.
  • по умолчанию: False
gates object Параметры доступов на открытие внешних модулей NCS-102.
0, 1, 2, 3 boolean Доступ на открытие внешних модулей NCS-102 с адресами 0-3.
  • по умолчанию: False
encryption object Параметры проверки шифрованных ключей.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
key_type string Тип ключа для авторизации в сектор ключа.
  • ограничения:
    • A
    • B
key_auth string Значение ключа для авторизации в сектор ключа.
  • по умолчанию: FFFFFFFFFFFF
sector integer Сектор, который будет проверяться на шифрование.
  • ограничения: от 0 до 15
increment object Параметры инкрементирования значения в указанном блоке сектора.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
block integer Блок, в котором будет производиться инкремент.
  • ограничения: от 0 до 2
openByError boolean Флаг открытия двери при ошибке инкремента.
  • по умолчанию: False
 
{
  "any_key_open": false,
  "inverse_uid_open": false,
  "autocollect": {
    "enabled": false,
    "room": 0,
    "keyMask": "xxxxxxxxxxxxxx",
    "access": {
      "main": false,
      "second": false,
      "gates": {
        "0": false,
        "1": false,
        "2": false,
        "3": false
      }
    }
  },
  "encryption": {
    "enabled": false,
    "key_type": "",
    "key_auth": "FFFFFFFFFFFF",
    "sector": 0,
    "increment": {
      "enabled": false,
      "block": 0,
      "openByError": false
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "any_key_open": false,
  "inverse_uid_open": false,
  "autocollect": {
    "enabled": false,
    "room": 0,
    "keyMask": "xxxxxxxxxxxxxx",
    "access": {
      "main": false,
      "second": false,
      "gates": {
        "0": false,
        "1": false,
        "2": false,
        "3": false
      }
    }
  },
  "encryption": {
    "enabled": false,
    "key_type": "",
    "key_auth": "FFFFFFFFFFFF",
    "sector": 0,
    "increment": {
      "enabled": false,
      "block": 0,
      "openByError": false
    }
  }
}
Ответы
204 OK

Тело:

Описание параметров
Название Тип Описание
any_key_open boolean Режим открытия двери любым ключом.
ВАЖНО: При включенном режиме ключи приложенные к считывателю не записываются в базу данных.
ВАЖНО: Включенный режим автосбора ключей игнорируется
  • по умолчанию: False
inverse_uid_open boolean Режим проверки обратного идентификатора ключа.
ВАЖНО: Панель приложенный ключ проверит прямой и обратный идентификатор (AABBCCDD и DDCCBBAA).
  • по умолчанию: False
autocollect object Параметры режима автосбора ключей.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
room integer Номер квартиры привязывающиеся приложенные ключи.
  • по умолчанию: 0
  • ограничения: от 0 до 9999
keyMask string Маска идентификатора ключа
ВАЖНО: На панель будет добавлены только те ключи, которые пройдут маску.
  • по умолчанию: xxxxxxxxxxxxxx
access object Параметры назначаемых доступов добавленных через режим автосбора ключей.
main boolean Доступ на открытие основной двери.
  • по умолчанию: False
second boolean Доступ на открытие дополнительной двери.
  • по умолчанию: False
gates object Параметры доступов на открытие внешних модулей NCS-102.
0, 1, 2, 3 boolean Доступ на открытие внешних модулей NCS-102 с адресами 0-3.
  • по умолчанию: False
encryption object Параметры проверки шифрованных ключей.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
key_type string Тип ключа для авторизации в сектор ключа.
  • ограничения:
    • A
    • B
key_auth string Значение ключа для авторизации в сектор ключа.
  • по умолчанию: FFFFFFFFFFFF
sector integer Сектор, который будет проверяться на шифрование.
  • ограничения: от 0 до 15
increment object Параметры инкрементирования значения в указанном блоке сектора.
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
block integer Блок, в котором будет производиться инкремент.
  • ограничения: от 0 до 2
openByError boolean Флаг открытия двери при ошибке инкремента.
  • по умолчанию: False
 
{
  "any_key_open": false,
  "inverse_uid_open": false,
  "autocollect": {
    "enabled": false,
    "room": 0,
    "keyMask": "xxxxxxxxxxxxxx",
    "access": {
      "main": false,
      "second": false,
      "gates": {
        "0": false,
        "1": false,
        "2": false,
        "3": false
      }
    }
  },
  "encryption": {
    "enabled": false,
    "key_type": "",
    "key_auth": "FFFFFFFFFFFF",
    "sector": 0,
    "increment": {
      "enabled": false,
      "block": 0,
      "openByError": false
    }
  }
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Текст ошибки"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/settings'

/key/{квартира}

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

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x

DELETE - Удаление ключей
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/1'

/v1/key/markup/mifare

Методы получения / добавления квартир.

GET - Получение квартир
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
numSectors   Количество секторов записывающихся за раз.
markup    
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 object Поддерживаемые сектора для прошивки в ключах.
skip string Параметры пропуска указанного сектора.
  • ограничения: 12 символов (16-ой системе счисления)
err boolean Пропуск сектора при ошибке во время прошивки.
  • по умолчанию: False
always boolean Пропуск сектора при любых действиях.
  • по умолчанию: False
key object Параметры авторизации в сектор ключа.
type string Тип ключа для авторизации в сектор ключа.
  • ограничения:
    • A
    • B
value string Значение ключа для авторизации в сектор ключа.
  • ограничения: 12 символов (16-ой системе счисления)
0, 1, 2, 3 string Блоки c информацией.
ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок.		 
{
  "enabled": false,
  "numSectors": null,
  "markup": {
    "0": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "1": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "2": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "3": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "4": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "5": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "6": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "7": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "8": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "9": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "10": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "11": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "12": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "13": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "14": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "15": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/key/markup/mifare'
PUT - Изменения квартир
Запрос

Тело:

{
  "enabled": false,
  "numSectors": null,
  "markup": {
    "0": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "1": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "2": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "3": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "4": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "5": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "6": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "7": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "8": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "9": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "10": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "11": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "12": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "13": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "14": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "15": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    }
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения / выключения режима.
  • по умолчанию: False
numSectors   Количество секторов записывающихся за раз.
markup    
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 object Поддерживаемые сектора для прошивки в ключах.
skip string Параметры пропуска указанного сектора.
  • ограничения: 12 символов (16-ой системе счисления)
err boolean Пропуск сектора при ошибке во время прошивки.
  • по умолчанию: False
always boolean Пропуск сектора при любых действиях.
  • по умолчанию: False
key object Параметры авторизации в сектор ключа.
type string Тип ключа для авторизации в сектор ключа.
  • ограничения:
    • A
    • B
value string Значение ключа для авторизации в сектор ключа.
  • ограничения: 12 символов (16-ой системе счисления)
0, 1, 2, 3 string Блоки c информацией.
ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок.		 
{
  "enabled": false,
  "numSectors": null,
  "markup": {
    "0": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "1": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "2": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "3": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "4": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "5": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "6": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "7": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "8": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "9": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "10": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "11": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "12": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "13": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "14": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    },
    "15": {
      "skip": {
        "err": false,
        "always": false
      },
      "key": {
        "type": "",
        "value": ""
      },
      "0": "",
      "1": "",
      "2": "",
      "3": ""
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/key/markup/mifare'

/crypto/profiles

Метод получения / изменения профилей шифрования.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id integer Идентификатор профиля
Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 6
block integer Номер блока в ключе.
  • ограничения: от 0 до 2
sector integer Номер сектора в ключе.
  • ограничения: от 0 до 31
key_type string Типа ключа.
  • ограничения:
    • A
    • B
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
valueLen integer Длина секретного значения, по которому будет проверяться валидность записанных в блок данных.
Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD).
Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
  • ограничения: от 0 до 16
key integer Строка с ключом авторизации
  • ограничения: 1 - 16 (HEX строка)
 
[
  {
    "id": 0,
    "block": 0,
    "sector": 0,
    "key_type": "",
    "securityLevel": 0,
    "valueLen": 0,
    "key": 0
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/crypto/profiles'
PUT - Изменение параметров
Запрос

Тело:

[
  {
    "id": 0,
    "block": 0,
    "sector": 0,
    "key_type": "",
    "securityLevel": 0,
    "valueLen": 0,
    "key": 0
  }
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id integer Идентификатор профиля
Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 6
block integer Номер блока в ключе.
  • ограничения: от 0 до 2
sector integer Номер сектора в ключе.
  • ограничения: от 0 до 31
key_type string Типа ключа.
  • ограничения:
    • A
    • B
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
valueLen integer Длина секретного значения, по которому будет проверяться валидность записанных в блок данных.
Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD).
Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
  • ограничения: от 0 до 16
key integer Строка с ключом авторизации
  • ограничения: 1 - 16 (HEX строка)
 
[
  {
    "id": 0,
    "block": 0,
    "sector": 0,
    "key_type": "",
    "securityLevel": 0,
    "valueLen": 0,
    "key": 0
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/crypto/profiles'
DELETE - Удаление профилей
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/crypto/profiles'

/crypto/profile/{профиль}

Метод получения / изменения профиля шифрования.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id integer Идентификатор профиля
Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 6
block integer Номер блока в ключе.
  • ограничения: от 0 до 2
sector integer Номер сектора в ключе.
  • ограничения: от 0 до 31
key_type string Типа ключа.
  • ограничения:
    • A
    • B
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
valueLen integer Длина секретного значения, по которому будет проверяться валидность записанных в блок данных.
Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD).
Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
  • ограничения: от 0 до 16
key integer Строка с ключом авторизации
  • ограничения: 1 - 16 (HEX строка)
 
{
  "id": 0,
  "block": 0,
  "sector": 0,
  "key_type": "",
  "securityLevel": 0,
  "valueLen": 0,
  "key": 0
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/crypto/profile/1'
PUT - Изменение параметров
Запрос

Тело:

{
  "id": 0,
  "block": 0,
  "sector": 0,
  "key_type": "",
  "securityLevel": 0,
  "valueLen": 0,
  "key": 0
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id integer Идентификатор профиля
Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
  • обязательный
  • ограничения: от 0 до 6
block integer Номер блока в ключе.
  • ограничения: от 0 до 2
sector integer Номер сектора в ключе.
  • ограничения: от 0 до 31
key_type string Типа ключа.
  • ограничения:
    • A
    • B
securityLevel integer Уровень шифрования ключа.
  • ограничения:
    • 0 (проверка UID)
    • 1 (SL1 авторизация в сектор)
    • 11 (SL1 с инкремент)
    • 3 (SL3 авторизация в сектор)
valueLen integer Длина секретного значения, по которому будет проверяться валидность записанных в блок данных.
Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD).
Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
  • ограничения: от 0 до 16
key integer Строка с ключом авторизации
  • ограничения: 1 - 16 (HEX строка)
 
{
  "id": 0,
  "block": 0,
  "sector": 0,
  "key_type": "",
  "securityLevel": 0,
  "valueLen": 0,
  "key": 0
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/crypto/profile/1'
DELETE - Удаление профиля
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/crypto/profile/1'

Квартиры

/panelCode

Методы получения / добавления квартир.

GET - Получение квартир
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode'
POST - Изменения квартир
Запрос

Тело:

[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
423 Locked

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Линия занята"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode'

/panelCode/diag

Метод массового замера уровня сопротивления абонентских трубок для указанных квартир.

POST - Получение уровней сопротивлений
Запрос

Тело:

[
  1,
  2,
  3,
  4,
  5
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
1, ..., 9999 object Номер квартиры.
resist integer Напряжение в линии до абонентской трубки.
  • ограничения: от 0 до 255
status string Положение абонентской полученное
  • ограничения:
    • down (положенна)
    • up (поднята)
    • error (ошибка)
error string Сообщение ошибки 
{
  "1": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "...": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "9999": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/clear'

/panelCode/clear

Метод удаления всех квартир с устройства.

DELETE - Получение парамеров
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/clear'

/panelCode/settings

Методы получения / изменения параметров "SOS" / "Консьерж".

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
sosRoom string SIP номер для вызова при нажатии на кнопку "SOS".
  • по умолчанию: SOS
sosDelay boolean Флаг включения / выключения задержки при нажатии кнопку "SOS".
  • по умолчанию: True
sosDelayTime integer Время удерживания кнопки "SOS".
  • по умолчанию: 3
  • ограничения: от 1 до 10
consiergeRoom string SIP номер для вызова при нажатии на кнопку "Консьерж".
  • по умолчанию: 999
soundOpenTh boolean Флаг включения / выключения звука открытия в абонентской трубке при открытии с ключа.
  • по умолчанию: False
soundOpenPanel boolean Флаг включения / выключения звуков открытия / ошибок на динамике панели при прикладывании ключа.
  • по умолчанию: True
 
{
  "sosRoom": "SOS",
  "sosDelay": true,
  "sosDelayTime": 3,
  "consiergeRoom": "999",
  "soundOpenTh": false,
  "soundOpenPanel": true
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/settings'
PUT - Получение параметров
Запрос

Тело:

{
  "sosRoom": "SOS",
  "sosDelay": true,
  "sosDelayTime": 3,
  "consiergeRoom": "999",
  "soundOpenTh": false,
  "soundOpenPanel": true
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
sosRoom string SIP номер для вызова при нажатии на кнопку "SOS".
  • по умолчанию: SOS
sosDelay boolean Флаг включения / выключения задержки при нажатии кнопку "SOS".
  • по умолчанию: True
sosDelayTime integer Время удерживания кнопки "SOS".
  • по умолчанию: 3
  • ограничения: от 1 до 10
consiergeRoom string SIP номер для вызова при нажатии на кнопку "Консьерж".
  • по умолчанию: 999
soundOpenTh boolean Флаг включения / выключения звука открытия в абонентской трубке при открытии с ключа.
  • по умолчанию: False
soundOpenPanel boolean Флаг включения / выключения звуков открытия / ошибок на динамике панели при прикладывании ключа.
  • по умолчанию: True
 
{
  "sosRoom": "SOS",
  "sosDelay": true,
  "sosDelayTime": 3,
  "consiergeRoom": "999",
  "soundOpenTh": false,
  "soundOpenPanel": true
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/settings'

/panelCode/rooms_update

Методы получения / добавления квартир.

PUT - Обновление параметров
Запрос

Тело:

[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/rooms_update'

/panelCode/{квартира}

Методы получения / изменения параметров квартиры.

GET - Получение квартир
Запрос

Тело:

{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1'
PUT - Изменения квартир
Запрос

Тело:

{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1'
DELETE - Удаления квартир
Ответы
204 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/1'

/panelCode/{квартира}/levels

Методы получения / изменения параметров квартиры.

GET - Получение квартир
Запрос

Тело:

{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/levels'
PUT - Изменения квартир
Запрос

Тело:

{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
thGate integer
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null (общие настройки)
 
{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1/levels'

/panelCode/{квартира}/resist

Метод получения уровня сопротивления абонентской трубки .

GET - Получение сопротивления
Запрос

Тело:

{
  "resist": 3.5,
  "status": "down",
  "error": ""
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resist integer Напряжение в линии до абонентской трубки.
  • ограничения: от 0 до 255
status string Положение абонентской полученное
  • ограничения:
    • down (положенна)
    • up (поднята)
    • error (ошибка)
error string Сообщение ошибки 
{
  "resist": 3.5,
  "status": "down",
  "error": ""
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/resist'

/panelCode/adjustLevels

Метод авто регулировки уровней указанных абонентских трубок.

POST - Изменение параметров
Запрос

Тело:

[
  1,
  2,
  3,
  4,
  5
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
1, 2, 3, 4, 5 object Номер квартиры.
resist integer Напряжение в линии до абонентской трубки.
  • ограничения: от 0 до 255
status string Положение абонентской полученное
  • ограничения:
    • down (положенна)
    • up (поднята)
    • error (ошибка)
error string Сообщение ошибки 
{
  "1": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "2": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "3": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "4": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "5": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/adjustLevels'

/panelCode/adjustLevels/all

Метод авто регулировки уровней всех абонентских трубок.

POST - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
1, 2, 3, 4, 5 object Номер квартиры.
resist integer Напряжение в линии до абонентской трубки.
  • ограничения: от 0 до 255
status string Положение абонентской полученное
  • ограничения:
    • down (положенна)
    • up (поднята)
    • error (ошибка)
error string Сообщение ошибки 
{
  "1": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "2": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "3": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "4": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  },
  "5": {
    "resist": 3.5,
    "status": "down",
    "error": ""
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/adjustLevels/all'

/v1/panelCode

Методы получения / добавления квартир.

GET - Получение квартир
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode'
POST - Изменения квартир
Запрос

Тело:

[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
[
  {
    "panelCode": 1,
    "debtor": false,
    "inform": false,
    "soundOpenTh": false,
    "sipAccounts": [
      "1"
    ],
    "callsEnabled": {
      "sip": true,
      "handset": true
    },
    "resistances": {
      "answer": null,
      "quiescent": null
    },
    "volumes": {
      "thCall": null,
      "thTalk": null,
      "thGate": null,
      "uartTo": null,
      "uartFrom": null,
      "panelTalk": null
    }
  }
]
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/v1/panelCode'

/v1/panelCode/{квартира}

Методы получения / изменения параметров квартиры.

GET - Получение квартир
Запрос

Тело:

{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1'
PUT - Изменения квартир
Запрос

Тело:

{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
panelCode integer Номер квартиры. Обязательный параметр.
  • обязательный
  • ограничения: от 1 до 9999
debtor boolean Доступен начиная с версии 2.5.0.x.x

Флаг включения / выключения режима должника при прикладывании ключа.
  • по умолчанию: False
inform boolean Доступен начиная с версии 2.5.0.12.x

Флаг включения / выключения режима информирования при прикладывании ключа.
  • по умолчанию: False
soundOpenTh boolean Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
  • по умолчанию: False
  • ограничения:
    • true
    • false
    • null (общие настройки)
sipAccounts array Список SIP номеров.
callsEnabled object Параметры разрешения вызовов в абонентскую трубку и SIP.
sip boolean Флаг включения / выключения вызовов в SIP.
  • по умолчанию: True
handset boolean Флаг включения / выключения вызовов в абонентскую трубку.
  • по умолчанию: True
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
{
  "panelCode": 1,
  "debtor": false,
  "inform": false,
  "soundOpenTh": false,
  "sipAccounts": [
    "1"
  ],
  "callsEnabled": {
    "sip": true,
    "handset": true
  },
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/panelCode/1'
DELETE - Изменения квартир
Ответы
204 OK

 

Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/panelCode/1'

/v1/panelCode/{квартира}/levels

Методы получения / изменения параметров квартиры.

GET - Получение квартир
Запрос

Тело:

{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1/levels'
PUT - Изменения квартир
Запрос

Тело:

{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки.
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 256
    • null (общие настройки)
volumes object Персональные громкости при вызове в квартиру.
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thTalk integer Громкость в трубке во время разговора.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
thGate integer Громкость в трубке при вызове с калитки
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null (общие настройки)
 
{
  "resistances": {
    "answer": null,
    "quiescent": null
  },
  "volumes": {
    "thCall": null,
    "thTalk": null,
    "thGate": null,
    "uartTo": null,
    "uartFrom": null,
    "panelTalk": null
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/panelCode/1/levels'

/v1/panelCode/{квартира}/resist

Метод получения уровня сопротивления абонентской трубки .

GET - Получение сопротивления
Запрос

Тело:

{
  "resist": 3.5,
  "status": "down",
  "error": ""
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resist integer Напряжение в линии до абонентской трубки.
  • ограничения: от 0 до 255
status string Положение абонентской полученное
  • ограничения:
    • down (положенна)
    • up (поднята)
    • error (ошибка)
error string Сообщение ошибки 
{
  "resist": 3.5,
  "status": "down",
  "error": ""
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1/resist'

Калитка

/gate/settings

Методы получения / изменения параметров панели в режиме "Калитка".

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
gateMode boolean Флаг включения / выключения режима калитки.
  • по умолчанию: False
prefixHouse boolean Флаг включения / выключения вызовы с префиксом.
  • по умолчанию: False
direct object Параметры прямых вызовов с устройства на устройство (peer to peer).
mode boolean Флаг включения / выключения прямых вызовов.
  • по умолчанию: False
rules object Правила для прямых вызовов.
0 object Префикс дома при вызове.
  • по умолчанию: 0
  • ограничения: от 0 до 9999
1-10 string Ключ: диапазон квартир
Значение: IP адрес устройства на подъезде		 
{
  "gateMode": false,
  "prefixHouse": false,
  "direct": {
    "mode": false,
    "rules": {
      "0": {
        "1-10": "192.168.0.1"
      }
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/gate/settings'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
gateMode boolean Флаг включения / выключения режима калитки.
  • по умолчанию: False
prefixHouse boolean Флаг включения / выключения вызовы с префиксом.
  • по умолчанию: False
direct object Параметры прямых вызовов с устройства на устройство (peer to peer).
mode boolean Флаг включения / выключения прямых вызовов.
  • по умолчанию: False
rules object Правила для прямых вызовов.
0 object Префикс дома при вызове.
  • по умолчанию: 0
  • ограничения: от 0 до 9999
1-10 string Ключ: диапазон квартир
Значение: IP адрес устройства на подъезде		 
{
  "gateMode": false,
  "prefixHouse": false,
  "direct": {
    "mode": false,
    "rules": {
      "0": {
        "1-10": "192.168.0.1"
      }
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/gate/settings'

Уровни звука

/levels

Методы получения / изменения общих уровней громкости и сопротивлений абонентских трубок.

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки для смены состояний.
break integer Уровень при неисправности трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
error integer Уровень при обрыве.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
volumes object Персональные громкости при вызове в квартиру.
panelCall integer Системные звуки панели.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
thTalk integer Громкость в трубке во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
 
{
  "resistances": {
    "break": null,
    "error": null,
    "quiescent": null,
    "answer": null
  },
  "volumes": {
    "panelCall": null,
    "panelTalk": null,
    "thTalk": null,
    "thCall": null,
    "uartFrom": null,
    "uartTo": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки для смены состояний.
break integer Уровень при неисправности трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
error integer Уровень при обрыве.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
volumes object Персональные громкости при вызове в квартиру.
panelCall integer Системные звуки панели.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
thTalk integer Громкость в трубке во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 255
    • null
 
{
  "resistances": {
    "break": null,
    "error": null,
    "quiescent": null,
    "answer": null
  },
  "volumes": {
    "panelCall": null,
    "panelTalk": null,
    "thTalk": null,
    "thCall": null,
    "uartFrom": null,
    "uartTo": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels'

/v1/levels

Методы получения / изменения общих уровней громкости и сопротивлений абонентских трубок.

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки для смены состояний.
break integer Уровень при неисправности трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
error integer Уровень при обрыве.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
volumes object Персональные громкости при вызове в квартиру.
panelCall integer Системные звуки панели.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
thTalk integer Громкость в трубке во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
 
{
  "resistances": {
    "break": null,
    "error": null,
    "quiescent": null,
    "answer": null
  },
  "volumes": {
    "panelCall": null,
    "panelTalk": null,
    "thTalk": null,
    "thCall": null,
    "uartFrom": null,
    "uartTo": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/levels'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
resistances object Параметры сопротивления трубки для смены состояний.
break integer Уровень при неисправности трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
error integer Уровень при обрыве.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
quiescent integer Уровень поднятия трубки.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
answer integer Уровень открытия двери.
  • по умолчанию: null
  • ограничения:
    • 0 - 40
    • null
volumes object Персональные громкости при вызове в квартиру.
panelCall integer Системные звуки панели.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
panelTalk integer Громкость на панели во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
thTalk integer Громкость в трубке во время разговора по АТ.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
thCall integer Громкость мелодии трубки во время вызова.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
uartFrom integer Громкость на панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
uartTo integer Усиление микрофона панели во время разговора по SIP.
  • по умолчанию: null
  • ограничения:
    • 0 - 16
    • null
 
{
  "resistances": {
    "break": null,
    "error": null,
    "quiescent": null,
    "answer": null
  },
  "volumes": {
    "panelCall": null,
    "panelTalk": null,
    "thTalk": null,
    "thCall": null,
    "uartFrom": null,
    "uartTo": null
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/levels'

Логи

/log/last

Метод получения последних 100 строк логов.

GET - Получение логов.
Ответы
200 OK 
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/log/last'

/v2/logs/{сервис}

Метод получения логов указанного сервиса.

Список поддерживаемых параметров "{сервис}":
- all - все сообщения устройства;
- api - сообщения HTTP сервера;
- ddns - сообщения No-IP клиента;
- uart - сообщения UART клиента;
- ircut - сообщения переключатора ИК шторки;
- camofon - сообщения SIP клиента;
- upgrade - сообщения обновлятора.
- streamer - сообщения RTSP сервера;
- proguard - сообщения системного монитора;

GET - Получение логов.
Ответы
200 OK 
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/logs/all'

Настройки сети

/v1/network

Методы получения / изменения сетевых интерфейсов.

Устройство поддерживает до 3-х сетевых интерфейсов.

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
inet string Тип виртуального сетевого интерфейса.
  • ограничения:
    • dhcp
    • static
  • зависимые параметры:
    • при inet равном dhcp появляются:
      • inetDhcp
    • при inet равном static появляются:
      • inetStatic
inetStatic, inetDhcp object inetDhcp - Доступен начиная с версии 2.5.0.13.x

Параметры виртуального сетевого интерфейса.
netmask string Сетевая маска при подключении к сети.
  • ограничения: IPv4 адреc
gateway string Сетевой шлюз при подключении к сети.
  • ограничения: IPv4 адреc
ipAddress string Адрес устройства при подключении к сети.
  • ограничения: IPv4 адреc
dnsServer string Адрес DNS сервера.
  • ограничения: IPv4 адреc
dnsServer1 string Доступен начиная с версии 2.5.0.13.x

Адрес DNS сервера.
  • ограничения: IPv4 адреc
 
[
  {
    "inet": "dhcp",
    "inetDhcp": {
      "netmask": "255.255.255.0",
      "gateway": "192.168.0.1",
      "ipAddress": "192.168.0.100",
      "dnsServer": "192.168.0.1",
      "dnsServer1": "192.168.0.2"
    }
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
inet string Тип виртуального сетевого интерфейса.
  • ограничения:
    • dhcp
    • static
  • зависимые параметры:
    • при inet равном dhcp появляются:
      • inetDhcp
    • при inet равном static появляются:
      • inetStatic
inetStatic, inetDhcp object inetDhcp - Доступен начиная с версии 2.5.0.13.x

Параметры виртуального сетевого интерфейса.
netmask string Сетевая маска при подключении к сети.
  • ограничения: IPv4 адреc
gateway string Сетевой шлюз при подключении к сети.
  • ограничения: IPv4 адреc
ipAddress string Адрес устройства при подключении к сети.
  • ограничения: IPv4 адреc
dnsServer string Адрес DNS сервера.
  • ограничения: IPv4 адреc
dnsServer1 string Доступен начиная с версии 2.5.0.13.x

Адрес DNS сервера.
  • ограничения: IPv4 адреc
 
[
  {
    "inet": "dhcp",
    "inetDhcp": {
      "netmask": "255.255.255.0",
      "gateway": "192.168.0.1",
      "ipAddress": "192.168.0.100",
      "dnsServer": "192.168.0.1",
      "dnsServer1": "192.168.0.2"
    }
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network'

/v1/network/ping

Метод для проверки доступности хоста..

PUT - Выполнение команды ping
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
addr string IPv4 / DNS адреc сервера.
numberPack integer Число пакетов отправляемых.
  • ограничения: от 1 до 100
interval integer Интервал между пакетами в мсек.
  • по умолчанию: 1000
  • ограничения: от 1 до 10000
sizePack integer Размер отправляемых пакетов в байтах.
  • по умолчанию: 56
  • ограничения: от 1 до 65535
timeout integer Таймаут для ожидания ответа от сервера в секундах.
  • по умолчанию: 5
  • ограничения: от 1 до 10
 
{
  "addr": "192.168.1.100",
  "numberPack": 0,
  "interval": 1000,
  "sizePack": 56,
  "timeout": 5
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/ping'

/v1/network/syslog

Методы получения / изменения настроек syslog.

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port integer Порт сервера для отправки событий.
  • по умолчанию: 514
  • ограничения: от 1 до 65535
addr string IPv4 / DNS адреc сервера.
  • по умолчанию: loserv.sokol
severity integer Доступен начиная с версии 2.5.0.13.x

Уровень логирования устройства
  • по умолчанию: 6
  • ограничения:
    • 0 (Emergency)
    • 1 (Alert)
    • 2 (Critical)
    • 3 (Error)
    • 4 (Warning)
    • 5 (Notice)
    • 6 (Info)
    • 7 (Debug)
transport integer Доступен начиная с версии 2.5.0.13.x

Транспорт отправки событий
  • по умолчанию: 2
  • ограничения:
    • 1 (UDP)
    • 2 (TCP)
 
{
  "port": 514,
  "addr": "loserv.sokol",
  "severity": 6,
  "transport": 2
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/syslog'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
port integer Порт сервера для отправки событий.
  • по умолчанию: 514
  • ограничения: от 1 до 65535
addr string IPv4 / DNS адреc сервера.
  • по умолчанию: loserv.sokol
severity integer Доступен начиная с версии 2.5.0.13.x

Уровень логирования устройства
  • по умолчанию: 6
  • ограничения:
    • 0 (Emergency)
    • 1 (Alert)
    • 2 (Critical)
    • 3 (Error)
    • 4 (Warning)
    • 5 (Notice)
    • 6 (Info)
    • 7 (Debug)
transport integer Доступен начиная с версии 2.5.0.13.x

Транспорт отправки событий
  • по умолчанию: 2
  • ограничения:
    • 1 (UDP)
    • 2 (TCP)
 
{
  "port": 514,
  "addr": "loserv.sokol",
  "severity": 6,
  "transport": 2
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/syslog'

/v1/network/traceroute

Метод для отслеживания маршрута данных, которые следуют к указанному хосту

PUT - Выполнение команды traceroute
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
addr string IPv4 / DNS адреc сервера.
udpPort integer Порт назначения для запроса.
  • по умолчанию: 33434
  • ограничения: от 1 до 65535
numberHops integer Максимальное количество преходов.
  • ограничения: от 1 до 100
timeout integer Максимальное время ожидания для каждого ответа.
  • по умолчанию: 2
  • ограничения: от 1 до 10
 
{
  "addr": "192.168.0.100",
  "udpPort": 33434,
  "numberHops": 1,
  "timeout": 2
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/network/traceroute'

/v1/network/available

Метод получения/установки адреса для проверки доступности сети.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение парамеров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Доступен начиная с версии 2.5.0.13.x

Флаг включения / выключения проверки доступности сервера.
  • по умолчанию: True
server string IPv4 / DNS адреc сервера. 
{
  "enable": true,
  "server": "192.168.0.100"
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/available'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Доступен начиная с версии 2.5.0.13.x

Флаг включения / выключения проверки доступности сервера.
  • по умолчанию: True
server string IPv4 / DNS адреc сервера. 
{
  "enable": true,
  "server": "192.168.0.100"
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/available'

Оповещение

/v1/notification/alarm

Методы управления аудиофайлами для оповещения при ГО/ЧС.

Метод не доступен для устройств на прошивке ниже 2.5.0.x.x

GET - Получение списка аудиофайлов
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/notification/alarm'
PUT - Добавление нового аудиофайла
Ответы

 

Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm'
DELETE - Удаление указанного аудиофайла
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/notification/alarm'

/v1/notification/alarm/play

Метод запуска оповещения при ГО/ЧС.

Воспроизведение происходит непрерывно
Остановка производиться отдельным методом: /v1/notification/alarm/stop

Метод не доступен для устройств на прошивке ниже 2.5.0.x.x

PUT - Запуск системы оповещения при ГО/ЧС
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm/play'

/v1/notification/alarm/stop

Метод остановки оповещения при ГО/ЧС.

Метод не доступен для устройств на прошивке ниже 2.5.0.x.x

PUT - Остановка системы оповещения при ГО/ЧС
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm/stop'

Ассистент

/assistant/settings

Метод получения и изменения параметров ассистента.

GET - Получение параметров
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/assistant/settings'
PUT - Изменение параметров
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/assistant/settings'
DELETE - Сброс параметров
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/assistant/settings'

Информирование

/v1/notification/forced/play

Метод запуска информирования.

PUT - Запуск информирования
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/play'

/v1/notification/forced/stop

Метод остановки информирования.

PUT - Запуск информирования
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/stop'

Ассистент / Оповещение / Информирование

события

Список событий для взаимодействия с аудиофайлами.
- /assistant/button/neutral - Кнопка открытия двери;
- /assistant/key/inform - Информирование при прикладывании ключа;
- Ранее информирование при задолженности;
- /assistant/key/open/neutral - Открытие панели ключом или цифровым кодом;
- /assistant/key/error/neutral - Ошибка открытия панели ключом или цифровым кодом;
- /assistant/tamper/alarm - Информирование при сработке тампера;
- /notification/alarm - Речевое оповещение;
- Временно не доступно;
- /notification/forced - Принудительно воспроизвести файл на панели.


/v1/{событие}

Методы управления аудиофайлами.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение списка аудиофайлов.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/'
DELETE - Удаление аудиофайла.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'

/v1/{событие}/list

Методы управления аудиофайлами.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

GET - Получение списка аудиофайлов.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/'
DELETE - Удаление аудиофайла.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'

/v1/{событие}/file

Методы управления аудиофайлом.

Метод не доступен для устройств на прошивке ниже 2.5.0.12.x

PUT - Добавление нового аудиофайлов.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/'
DELETE - Удаление аудиофайла.
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'

Дисплей

/panelDisplay/settings

Методы получения и изменения параметров бегущей строки на дисплее.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
speed integer Скорость бегущей строки в мсек.
  • по умолчанию: 500
  • ограничения: от 50 до 1000
strDisplay boolean Флаг включения / выключения бегущей строки.
  • по умолчанию: False
imgStr string Текст отображения на дисплее.
Поддерживается только латинский алфавит и цифры ASCII.'
  • ограничения: от 0 до 99
 
{
  "speed": 500,
  "strDisplay": false,
  "imgStr": ""
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelDisplay/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "speed": 500,
  "strDisplay": false,
  "imgStr": ""
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
speed integer Скорость бегущей строки в мсек.
  • по умолчанию: 500
  • ограничения: от 50 до 1000
strDisplay boolean Флаг включения / выключения бегущей строки.
  • по умолчанию: False
imgStr string Текст отображения на дисплее.
Поддерживается только латинский алфавит и цифры ASCII.'
  • ограничения: от 0 до 99
 
{
  "speed": 500,
  "strDisplay": false,
  "imgStr": ""
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelDisplay/settings'

/v1/display

Методы получения и изменения параметров бегущей строки на дисплее.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Флаг включения / выключения дисплея.
  • по умолчанию: False
text string Текст отображения на дисплее.
Поддерживается только латинский алфавит и цифры ASCII.
  • ограничения: от 0 до 99
speed integer Скорость бегущей строки в мсек.
  • по умолчанию: 500
  • ограничения: от 50 до 1000
 
{
  "enable": false,
  "text": "",
  "speed": 500
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/display'
PUT - Изменение параметров
Запрос

Тело:

{
  "enable": false,
  "text": "",
  "speed": 500
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Флаг включения / выключения дисплея.
  • по умолчанию: False
text string Текст отображения на дисплее.
Поддерживается только латинский алфавит и цифры ASCII.
  • ограничения: от 0 до 99
speed integer Скорость бегущей строки в мсек.
  • по умолчанию: 500
  • ограничения: от 50 до 1000
 
{
  "enable": false,
  "text": "",
  "speed": 500
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/display'

Реле

/relay/info

Метод получения поддерживаемых номеров реле.

GET - Получение параметров
Ответы
200 OK 
[
  1,
  2
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/info'

/relay/settings

Методы получения и изменения общих параметров реле.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
alwaysOpen boolean Флаг включения / выключения режима открытых дверей.
  • по умолчанию: False
alwaysOpenNetMode boolean Флаг включения / выключения режима открытых дверей при недоступности сети.
  • по умолчанию: False
 
{
  "alwaysOpen": false,
  "alwaysOpenNetMode": false
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/settings'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
alwaysOpen boolean Флаг включения / выключения режима открытых дверей.
  • по умолчанию: False
alwaysOpenNetMode boolean Флаг включения / выключения режима открытых дверей при недоступности сети.
  • по умолчанию: False
 
{
  "alwaysOpen": false,
  "alwaysOpenNetMode": false
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/settings'

/relay/{реле}/open

Метод открытия указанного номера реле.

PUT - Открытие реле
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/open'

/relay/{реле}/settings

Методы получения и изменения параметров указанного номера реле.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
switchTime integer Время удержания двери в открытом состоянии.
  • по умолчанию: 5
  • ограничения: от 4 до 10
alwaysOpen boolean Флаг включения / выключения режима открытых дверей.
  • по умолчанию: False
 
{
  "switchTime": 5,
  "alwaysOpen": false
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/1/settings'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
switchTime integer Время удержания двери в открытом состоянии.
  • по умолчанию: 5
  • ограничения: от 4 до 10
alwaysOpen boolean Флаг включения / выключения режима открытых дверей.
  • по умолчанию: False
 
{
  "switchTime": 5,
  "alwaysOpen": false
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/settings'

/relay/doors/mapping

Методы получения / изменения управления матрицей входов / считывателей.

Метод не доступен для устройств на прошивке ниже 2.5.0.6.x.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
mmainReader, secondReader, extReader0, extReader1, extReader2, extReader3 object mainReader - основной считыватель;
secondReader - дополнительный считыватель;
extReader0,1,2,3 - считыватели на внешних модулях входов (Beward NCS-102).
main boolean Флаг включения / выключения открытия основного входа.
second boolean Флаг включения / выключения открытия дополнительного входа.
gates object Внешние модули входов (Beward NCS-102).
1, 2, 3, 4 boolean Флаг включения / выключения открытия внешнего входа. 
{
  "mmainReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "secondReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader0": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader1": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader2": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader3": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/doors/mapping'
PUT - Изменение параметров
Запрос

Тело:

{
  "mmainReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "secondReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader0": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader1": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader2": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader3": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
mmainReader, secondReader, extReader0, extReader1, extReader2, extReader3 object mainReader - основной считыватель;
secondReader - дополнительный считыватель;
extReader0,1,2,3 - считыватели на внешних модулях входов (Beward NCS-102).
main boolean Флаг включения / выключения открытия основного входа.
second boolean Флаг включения / выключения открытия дополнительного входа.
gates object Внешние модули входов (Beward NCS-102).
1, 2, 3, 4 boolean Флаг включения / выключения открытия внешнего входа. 
{
  "mmainReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "secondReader": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader0": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader1": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader2": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  },
  "extReader3": {
    "main": false,
    "second": false,
    "gates": {
      "1": false,
      "2": false,
      "3": false,
      "4": false
    }
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/doors/mapping' \

/relay/door_controller

Методы получения / изменения параметров внешних модулей.

Метод не доступен для устройств на прошивке ниже 2.5.0.9.x.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
timeout integer Время между командами на шине в мсек.
  • по умолчанию: 170
  • ограничения: от 170 до 1000
busErrors integer Количество ошибок в шине.
Ошибками считаются команды не известные для потокола.
  • по умолчанию: 0
modules object Массив внешних модулей.
type string Тип модуля.
  • ограничения: NCS-102 (Beward)
enabled boolean Флаг включения / выключения модуля.
  • по умолчанию: False
address integer Адрес модуля на шине RS-485.
  • ограничения: от 0 до 3
version string Версия прошивки модуля.
openTime integer Время открытия двери в секундах.
  • ограничения: от 1 до 9
button boolean Состояние кнопки.
  • по умолчанию: False
tamper boolean Состояние тампера
  • по умолчанию: False
alwaysOpen boolean Режим открытых дверей.
  • по умолчанию: False
errors integer Количество ошибок устройства.
Ошибками считаются команды не корректно отправленные модулем.
  • по умолчанию: 0
connection boolean Состояние взаимодействия с модулем.
  • по умолчанию: False
 
{
  "timeout": 170,
  "busErrors": 0,
  "modules": {
    "type": "",
    "enabled": false,
    "address": 0,
    "version": "",
    "openTime": 0,
    "button": false,
    "tamper": false,
    "alwaysOpen": false,
    "errors": 0,
    "connection": false
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/door_controller'
PUT - Изменение параметров
Запрос

Тело:

{
  "timeout": 170,
  "busErrors": 0,
  "modules": {
    "type": "",
    "enabled": false,
    "address": 0,
    "version": "",
    "openTime": 0,
    "button": false,
    "tamper": false,
    "alwaysOpen": false,
    "errors": 0,
    "connection": false
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
timeout integer Время между командами на шине в мсек.
  • по умолчанию: 170
  • ограничения: от 170 до 1000
busErrors integer Количество ошибок в шине.
Ошибками считаются команды не известные для потокола.
  • по умолчанию: 0
modules object Массив внешних модулей.
type string Тип модуля.
  • ограничения: NCS-102 (Beward)
enabled boolean Флаг включения / выключения модуля.
  • по умолчанию: False
address integer Адрес модуля на шине RS-485.
  • ограничения: от 0 до 3
version string Версия прошивки модуля.
openTime integer Время открытия двери в секундах.
  • ограничения: от 1 до 9
button boolean Состояние кнопки.
  • по умолчанию: False
tamper boolean Состояние тампера
  • по умолчанию: False
alwaysOpen boolean Режим открытых дверей.
  • по умолчанию: False
errors integer Количество ошибок устройства.
Ошибками считаются команды не корректно отправленные модулем.
  • по умолчанию: 0
connection boolean Состояние взаимодействия с модулем.
  • по умолчанию: False
 
{
  "timeout": 170,
  "busErrors": 0,
  "modules": {
    "type": "",
    "enabled": false,
    "address": 0,
    "version": "",
    "openTime": 0,
    "button": false,
    "tamper": false,
    "alwaysOpen": false,
    "errors": 0,
    "connection": false
  }
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/door_controller' \

/relay/external/{реле}/open

Метод открытия дверей, управляемых внешними контроллерами.

Метод не доступен для устройств на прошивке ниже 2.5.0.6.x

PUT - Открытие внешнего реле
Ответы
204 OK

 

Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/external/1/open'

SIP

/sip/options

Методы получения и изменения sip-параметров для управления вызовом;

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
dtmf object Настройки DTMF.
1 string DTMF символ для открытия основного выхода.
2 string DTMF символ для открытия дополнительного выхода.
callHangup object Настройки автозавершения вызова.
timeout integer Задержка автозавершения вызова после открытия.
  • по умолчанию: 0
  • ограничения: от 0 до 255
sip boolean Флаг включения / выключения автозавершения при открытии с SIP.
  • по умолчанию: False
callDelay integer Задержка вызова в АТ.
  • по умолчанию: 0
  • ограничения: от 0 до 255
sipCallDelay integer Задержка вызова в SIP.
  • по умолчанию: 0
  • ограничения: от 0 до 255
talkDuration integer Время разговора с момента поднятия трубки в АТ или в SIP.
  • по умолчанию: 180
  • ограничения: ['1 255']
ringDuration integer Время совершения вызова до поднятия трубки в АТ или в SIP.
  • по умолчанию: 60
  • ограничения: от 1 до 255
 
{
  "dtmf": {
    "1": "1",
    "2": "2"
  },
  "callHangup": {
    "timeout": 0,
    "sip": false
  },
  "callDelay": 0,
  "sipCallDelay": 0,
  "talkDuration": 180,
  "ringDuration": 60
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/options'
PUT - Изменение параметров
Запрос

Тело:

{
  "dtmf": {
    "1": "1",
    "2": "2"
  },
  "callHangup": {
    "timeout": 0,
    "sip": false
  },
  "callDelay": 0,
  "sipCallDelay": 0,
  "talkDuration": 180,
  "ringDuration": 60
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
dtmf object Настройки DTMF.
1 string DTMF символ для открытия основного выхода.
2 string DTMF символ для открытия дополнительного выхода.
callHangup object Настройки автозавершения вызова.
timeout integer Задержка автозавершения вызова после открытия.
  • по умолчанию: 0
  • ограничения: от 0 до 255
sip boolean Флаг включения / выключения автозавершения при открытии с SIP.
  • по умолчанию: False
callDelay integer Задержка вызова в АТ.
  • по умолчанию: 0
  • ограничения: от 0 до 255
sipCallDelay integer Задержка вызова в SIP.
  • по умолчанию: 0
  • ограничения: от 0 до 255
talkDuration integer Время разговора с момента поднятия трубки в АТ или в SIP.
  • по умолчанию: 180
  • ограничения: ['1 255']
ringDuration integer Время совершения вызова до поднятия трубки в АТ или в SIP.
  • по умолчанию: 60
  • ограничения: от 1 до 255
 
{
  "dtmf": {
    "1": "1",
    "2": "2"
  },
  "callHangup": {
    "timeout": 0,
    "sip": false
  },
  "callDelay": 0,
  "sipCallDelay": 0,
  "talkDuration": 180,
  "ringDuration": 60
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/options'

/sip/settings

Методы получения и изменения sip-параметров для управления вызовом;

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
remote object Параметры авторизации на SIP сервере.
port integer Порт сервера на который отправляются вызовы.
domain string Адрес сервера на который отправляются вызов.
portRegister integer Порт сервера на который отправляются запросы регистрации.
domainRegister string Адрес сервера на который отправляются запросы регистрации.
username string Логин для авторизации на сервере.
password string Пароль для авторизации на сервере.
proxy object  
enable boolean Флаг использования прокси сервера.
port integer Порт прокси сервера.
domain string Адрес прокси сервера.
transport object Протоколы для работы с серверами.
udp boolean Флаг использования UDP.
  • по умолчанию: True
tcp boolean Флаг использования TCP.
  • по умолчанию: False
registerStatus boolean Флаг текущего состояния авторизации на сервере.
videoEnable boolean Флаг включения / выключения видеопотока.
  • по умолчанию: True
videoStreamId integer Номер видеопотока в видео вызове.
  • по умолчанию: 1
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный)
 
{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
remote object Параметры авторизации на SIP сервере.
port integer Порт сервера на который отправляются вызовы.
domain string Адрес сервера на который отправляются вызов.
portRegister integer Порт сервера на который отправляются запросы регистрации.
domainRegister string Адрес сервера на который отправляются запросы регистрации.
username string Логин для авторизации на сервере.
password string Пароль для авторизации на сервере.
proxy object  
enable boolean Флаг использования прокси сервера.
port integer Порт прокси сервера.
domain string Адрес прокси сервера.
transport object Протоколы для работы с серверами.
udp boolean Флаг использования UDP.
  • по умолчанию: True
tcp boolean Флаг использования TCP.
  • по умолчанию: False
registerStatus boolean Флаг текущего состояния авторизации на сервере.
videoEnable boolean Флаг включения / выключения видеопотока.
  • по умолчанию: True
videoStreamId integer Номер видеопотока в видео вызове.
  • по умолчанию: 1
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный)
 
{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Текст ошибки"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка обновления параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/settings'

/sip/test/{квартира}

Метод создания тестового вызова в абонентскую трубку и SIP для указанного номера квартиры.

PUT - Отправка тестового вызова
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/1'

/sip/test/sip/{квартира}

Метод создания тестового вызова в SIP для указанного номера квартиры.

PUT - Отправка тестового вызова
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/sip/1'

/sip/test/analog/{квартира}

Метод создания тестового вызова в абонентскую трубку для указанного номера квартиры.

PUT - Отправка тестового вызова
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/analog/1'

/v1/sip/settings

Методы получения и изменения SIP-параметров для управления вызовом;

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
remote object Параметры авторизации на SIP сервере.
port integer Порт сервера на который отправляются вызовы.
domain string Адрес сервера на который отправляются вызов.
portRegister integer Порт сервера на который отправляются запросы регистрации.
domainRegister string Адрес сервера на который отправляются запросы регистрации.
username string Логин для авторизации на сервере.
password string Пароль для авторизации на сервере.
proxy object  
enable boolean Флаг использования прокси сервера.
port integer Порт прокси сервера.
domain string Адрес прокси сервера.
transport object Протоколы для работы с серверами.
udp boolean Флаг использования UDP.
  • по умолчанию: True
tcp boolean Флаг использования TCP.
  • по умолчанию: False
registerStatus boolean Флаг текущего состояния авторизации на сервере.
videoEnable boolean Флаг включения / выключения видеопотока.
  • по умолчанию: True
videoStreamId integer Номер видеопотока в видео вызове.
  • по умолчанию: 1
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный)
 
{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/sip/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
remote object Параметры авторизации на SIP сервере.
port integer Порт сервера на который отправляются вызовы.
domain string Адрес сервера на который отправляются вызов.
portRegister integer Порт сервера на который отправляются запросы регистрации.
domainRegister string Адрес сервера на который отправляются запросы регистрации.
username string Логин для авторизации на сервере.
password string Пароль для авторизации на сервере.
proxy object  
enable boolean Флаг использования прокси сервера.
port integer Порт прокси сервера.
domain string Адрес прокси сервера.
transport object Протоколы для работы с серверами.
udp boolean Флаг использования UDP.
  • по умолчанию: True
tcp boolean Флаг использования TCP.
  • по умолчанию: False
registerStatus boolean Флаг текущего состояния авторизации на сервере.
videoEnable boolean Флаг включения / выключения видеопотока.
  • по умолчанию: True
videoStreamId integer Номер видеопотока в видео вызове.
  • по умолчанию: 1
  • ограничения:
    • 0 (основной)
    • 1 (альтернативный)
 
{
  "remote": {
    "port": 5060,
    "domain": "domain.com",
    "portRegister": 5060,
    "domainRegister": "domain.com",
    "username": "",
    "password": "",
    "proxy": {
      "enable": false,
      "port": 5061,
      "domain": "domain.com"
    },
    "transport": {
      "udp": true,
      "tcp": false
    },
    "registerStatus": true
  },
  "videoEnable": true,
  "videoStreamId": 1
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Текст ошибки"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка обновления параметров"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Текст ошибки"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/sip/settings'

Вызовы

/v1/call

Метод получения / изменения настроек вызова.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
talkDuration integer Время разговора в секундах.
  • ограничения: от 0 до 255
ringDuration integer Время вызова в секундах.
  • ограничения: от 0 до 255
 
{
  "talkDuration": 180,
  "ringDuration": 60
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/call'
PUT - Получение параметров
Запрос

Тело:

{
  "talkDuration": 180,
  "ringDuration": 60
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
talkDuration integer Время разговора в секундах.
  • ограничения: от 0 до 255
ringDuration integer Время вызова в секундах.
  • ограничения: от 0 до 255
 
{
  "talkDuration": 180,
  "ringDuration": 60
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/call'
--data-raw '{
    "talkDuration": 180,
    "ringDuration": 60
}'

/v1/call/stop

Метод завершения текущего вызова.

PUT - Завершение вызова
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/call/stop'

Матрицы

/switch/info/models

Метод получения списка поддерживаемых коммутаторов устройством.

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id string Модель поддерживаемового коммутатора.
name string Наименование поддерживаемового коммутатора.
eCount integer Количество единиц используемых для коммутации. 
[
  {
    "id": "CYFRAL",
    "name": "Цифрал",
    "eCount": 10
  }
]
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/info/models'

/switch/settings

Методы получения и изменения общих параметров для коммутаторов.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
modelId string Модель используемого коммутатора.
Список поддерживаемых коммутаторов /switch/info/models		 
{
  "modelId": "CYFRAL"
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/settings'

/switch/matrix/{матрица}

Методы получения и изменения указанной матрицы коммутации.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
summator integer Доступен начиная с версии 2.5.0.13.x

Поддержка указанного сумматора.
  • по умолчанию: 0
  • ограничения:
    • 0 (не выбрано)
    • 1 (Цифрал С-01)
capacity integer Количество квартир в матрице.
  • ограничения:
    • 0
    • 10
    • 20
    • 40
    • 64
    • 80
    • 100
    • 160
    • 220
matrix array Массив массивов со списками квартир. 
{
  "summator": 0,
  "capacity": 10,
  "matrix": [
    [
      10,
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9
    ]
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/matrix/1'
PUT - Изменение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
summator integer Доступен начиная с версии 2.5.0.13.x

Поддержка указанного сумматора.
  • по умолчанию: 0
  • ограничения:
    • 0 (не выбрано)
    • 1 (Цифрал С-01)
capacity integer Количество квартир в матрице.
  • ограничения:
    • 0
    • 10
    • 20
    • 40
    • 64
    • 80
    • 100
    • 160
    • 220
matrix array Массив массивов со списками квартир. 
{
  "summator": 0,
  "capacity": 10,
  "matrix": [
    [
      10,
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9
    ]
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка обновления параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/switch/matrix/1'
--data-raw '{
  "summator": 0,
  "capacity": 10,
  "matrix": [
    [
      10,
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9
    ]
  ]
}'

/v1/switch/models

Метод получения списка поддерживаемых коммутаторов устройством.

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x

GET - Получение списка
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
id   Модель поддерживаемового коммутатора.
name   Наименование поддерживаемового коммутатора.
eCount   Количество единиц используемых для коммутации.
dCount   Количество десятков используемых для коммутации.
switchCount   Количество возможных коммутаторов подключаемых друг в друга. 
[
  {
    "id": 12,
    "name": "Бевард ККМ-108",
    "eCount": 10,
    "dCount": 10,
    "switchCount": 8
  }
]
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/switch/models'

/v1/switch/{матрица}

Методы получения и изменения указанной матрицы коммутации.

Панель поддерживает подключение до 3-х коммутаторов:
- Визит.

Панель поддерживает подключение до 4-х коммутаторов:
- Элтис;
- Сокол;
- Бевард;
- Цифрал;
- Метаком;
- Факториал.

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
type integer Тип используемого коммутатора.
Список поддерживаемых коммутаторов /v1/switch/models.
  • по умолчанию: null
summator integer Поддержка указанного сумматора.
- 0 - не выбрано;
- 1 - Цифрал С-01;
Warning:

Доступен начиная с версии 2.5.0.13.x

  • по умолчанию: 0
  • ограничения: от 0 до 1
matrices array Массив подматриц выхода ККМ.
id integer Номер матрицы.
capacity integer Количество квартир в матрице.
matrix array Массив массивов со списками квартир. 
{
  "type": 10,
  "summator": 0,
  "matrices": [
    {
      "id": 1,
      "capacity": 10,
      "matrix": [
        [
          10,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9
        ]
      ]
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/switch/1'
PUT - Изменение параметров
Запрос

Тело:

{
  "type": 10,
  "summator": 0,
  "matrices": [
    {
      "id": 1,
      "capacity": 10,
      "matrix": [
        [
          10,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9
        ]
      ]
    }
  ]
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
type integer Тип используемого коммутатора.
Список поддерживаемых коммутаторов /v1/switch/models.
  • по умолчанию: null
summator integer Поддержка указанного сумматора.
- 0 - не выбрано;
- 1 - Цифрал С-01;
Warning:

Доступен начиная с версии 2.5.0.13.x

  • по умолчанию: 0
  • ограничения: от 0 до 1
matrices array Массив подматриц выхода ККМ.
id integer Номер матрицы.
capacity integer Количество квартир в матрице.
matrix array Массив массивов со списками квартир. 
{
  "type": 10,
  "summator": 0,
  "matrices": [
    {
      "id": 1,
      "capacity": 10,
      "matrix": [
        [
          10,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9
        ]
      ]
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/switch/1'
--data-raw '{
  "type": 10,
  "summator": 0,
  "matrices": [
    {
      "id": 1,
      "capacity": 10
      "matrix": [
        [
          10,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9
        ]
      ]
    }
  ]
}'

Микроконтроллер

/v1/mcu/info

Метод получения информации о микроконтроллере.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
power object Параметры питания панели.
dc double Входное напряжение устройства.
chipId integer Уникальный идентификатор микроконтроллера. 
{
  "power": {
    "dc": 12.21
  },
  "chipId": 1000000000000000001
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/mcu/info'

/v1/mcu/tamper

Методы для работы с обновлением устройства с помощью HTTP сервера.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Флаг включения / выключения оптического тампера.
  • по умолчанию: False
alarm boolean Флаг включения / выключения звука при сработке оптического тампера.
  • по умолчанию: True
voltage double Напряжение оптического тампера.
threshold double Порог для сработки оптического тампера.
isTriggered boolean Флаг состояния сработки оптического тампера. 
{
  "enable": false,
  "alarm": true,
  "voltage": 0.0,
  "threshold": 0.0,
  "isTriggered": false
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/mcu/tamper'
PUT - Изменение параметров
Запрос

Тело:

{
  "enable": false,
  "alarm": true,
  "voltage": 0.0,
  "threshold": 0.0,
  "isTriggered": false
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enable boolean Флаг включения / выключения оптического тампера.
  • по умолчанию: False
alarm boolean Флаг включения / выключения звука при сработке оптического тампера.
  • по умолчанию: True
voltage double Напряжение оптического тампера.
threshold double Порог для сработки оптического тампера.
isTriggered boolean Флаг состояния сработки оптического тампера. 
{
  "enable": false,
  "alarm": true,
  "voltage": 0.0,
  "threshold": 0.0,
  "isTriggered": false
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/mcu/tamper' \

Системные

/system/tz

Метод получения поддерживаемых временных зон.

GET - Получение списка
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/tz'

/system/info

Метод получения системной информации устройства.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
model string Наименование модели камеры.
  • по умолчанию: GK7205V300
temperature double Значение температуры процессора камеры.
chipId string Уникальный идентификатор процессора камеры.
mac string Мак адрес устройства.
deviceId string Серийный номер устройства.
deviceModel string Наименование устройства.
uptime integer Время работы устройства с момента последнего включения.
registerStatus boolean Флаг состояния SIP регистрации.
  • по умолчанию: False
 
{
  "model": "GK7205V300",
  "temperature": 80.0,
  "chipId": "100000000000000000000000000000000000000000000001",
  "mac": "08:13:00:00:00:00",
  "deviceId": "0000000000",
  "deviceModel": "ISCom X1 (rev.5)",
  "uptime": 1001,
  "registerStatus": false
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/info'

/system/load

Метод получения количества свободной и задействованной памяти системой устройства.

Метод не доступен для устройств на прошивке ниже 2.5.0.9.x

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
memory object Параметры использованной и задействованной памяти.
system object Параметры памяти системы.
used integer Количество используемой памяти.
free integer Количество свободной памяти.
services    
api, uart, ddns, streamer, camofon, upgrade, proguard, ircut object Наименование приложения.
pid integer PID процесса.
used integer Используемое количество памяти.
processor object Параметры загруженности процессора.
1 double Загруженность процессора за 1-у минуту.
5 double Загруженность процессора за 5-ть минут.
15 double Загруженность процессора за 15-ть минут. 
{
  "memory": {
    "system": {
      "used": 0,
      "free": 0
    },
    "services": {
      "api": {
        "pid": 0,
        "used": 0
      },
      "uart": {
        "pid": 0,
        "used": 0
      },
      "ddns": {
        "pid": 0,
        "used": 0
      },
      "streamer": {
        "pid": 0,
        "used": 0
      },
      "camofon": {
        "pid": 0,
        "used": 0
      },
      "upgrade": {
        "pid": 0,
        "used": 0
      },
      "proguard": {
        "pid": 0,
        "used": 0
      },
      "ircut": {
        "pid": 0,
        "used": 0
      }
    }
  },
  "processor": {
    "1": 0.0,
    "5": 0.0,
    "15": 0.0
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/load'

/system/settings

Методы получения и изменения системных настроек.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
log_level object Уровни логирования приложений.
api, uart, camofon, streamer, proguard, store, baresip, libre integer Уровень логирования приложения:
- 1 - Trace;
- 2 - Debug;
- 3 - Info;
- 4 - Warning;
- 5 - Error;
- 6 - Fatal.
  • по умолчанию: 3
  • ограничения: от 0 до 6
tz string Текущая временная зона (поддерживаемые зоны).
  • по умолчанию: Asia/Yekaterinburg
dateTime string Текущая дата и время.
  • по умолчанию: 1970-01-01T00:00:00+0000
dns object Параметры DNS серверов
Info:

ВАЖНО! Является устаревшим, советуем использовать метод (/v1/network) для получения и изменения сетевых настроек включая сервера dns.
auto boolean Флаг работы с dns серверами.
- true - автоматически
- false - в ручную.
  • по умолчанию: True
  • ограничения: от 0 до 1
nameservers array Массив строк с dns серверами.
ntp array Массив строк с ntp серверами.
  • по умолчанию: ["0.pool.ntp.org", "1.pool.ntp.org", "time.is74.ru"]
assist   Параметры для работы ассистента.
enable boolean Флаг включения / выключения ассистента.
  • по умолчанию: True
online boolean Флаг переключения онлайн / оффлайн ассистента.
Info:

ВАЖНО! Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах.

  • по умолчанию: True
 
{
  "log_level": {
    "api": 3,
    "uart": 3,
    "camofon": 3,
    "streamer": 3,
    "proguard": 3,
    "store": 3,
    "baresip": 3,
    "libre": 3
  },
  "tz": "Asia/Yekaterinburg",
  "dateTime": "1970-01-01T00:00:00+0000",
  "dns": {
    "auto": true,
    "nameservers": []
  },
  "ntp": [
    "0.pool.ntp.org",
    "1.pool.ntp.org",
    "time.is74.ru"
  ],
  "assist": {
    "enable": true,
    "online": true
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/settings'
PUT - Изменение параметров
Запрос

Тело:

{
  "log_level": {
    "api": 3,
    "uart": 3,
    "camofon": 3,
    "streamer": 3,
    "proguard": 3,
    "store": 3,
    "baresip": 3,
    "libre": 3
  },
  "tz": "Asia/Yekaterinburg",
  "dateTime": "1970-01-01T00:00:00+0000",
  "dns": {
    "auto": true,
    "nameservers": []
  },
  "ntp": [
    "0.pool.ntp.org",
    "1.pool.ntp.org",
    "time.is74.ru"
  ],
  "assist": {
    "enable": true,
    "online": true
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
log_level object Уровни логирования приложений.
api, uart, camofon, streamer, proguard, store, baresip, libre integer Уровень логирования приложения:
- 1 - Trace;
- 2 - Debug;
- 3 - Info;
- 4 - Warning;
- 5 - Error;
- 6 - Fatal.
  • по умолчанию: 3
  • ограничения: от 0 до 6
tz string Текущая временная зона (поддерживаемые зоны).
  • по умолчанию: Asia/Yekaterinburg
dateTime string Текущая дата и время.
  • по умолчанию: 1970-01-01T00:00:00+0000
dns object Параметры DNS серверов
Info:

ВАЖНО! Является устаревшим, советуем использовать метод (/v1/network) для получения и изменения сетевых настроек включая сервера dns.
auto boolean Флаг работы с dns серверами.
- true - автоматически
- false - в ручную.
  • по умолчанию: True
  • ограничения: от 0 до 1
nameservers array Массив строк с dns серверами.
ntp array Массив строк с ntp серверами.
  • по умолчанию: ["0.pool.ntp.org", "1.pool.ntp.org", "time.is74.ru"]
assist   Параметры для работы ассистента.
enable boolean Флаг включения / выключения ассистента.
  • по умолчанию: True
online boolean Флаг переключения онлайн / оффлайн ассистента.
Info:

ВАЖНО! Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах.

  • по умолчанию: True
 
{
  "log_level": {
    "api": 3,
    "uart": 3,
    "camofon": 3,
    "streamer": 3,
    "proguard": 3,
    "store": 3,
    "baresip": 3,
    "libre": 3
  },
  "tz": "Asia/Yekaterinburg",
  "dateTime": "1970-01-01T00:00:00+0000",
  "dns": {
    "auto": true,
    "nameservers": []
  },
  "ntp": [
    "0.pool.ntp.org",
    "1.pool.ntp.org",
    "time.is74.ru"
  ],
  "assist": {
    "enable": true,
    "online": true
  }
}
400 Bad Request

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Текст ошибки"
    }
  ]
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    },
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/settings'
--data-raw '{
  "log_level": {
    "api": 3,
    "uart": 3,
    "camofon": 3,
    "streamer": 3,
    "proguard": 3,
    "store": 3,
    "baresip": 3,
    "libre": 3
  },
  "tz": "Asia/Yekaterinburg",
  "dateTime": "1970-01-01T00:00:00+0000",
  "dns": {
    "auto": true,
    "nameservers": []
  },
  "ntp": [
    "0.pool.ntp.org",
    "1.pool.ntp.org",
    "time.is74.ru"
  ],
  "assist": {
    "enable": true,
    "online": true
  }
}'

/system/fw_env

Метод получения MAC-адреса устройства.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
ethaddr string MAC адрес устройства. 
{
  "ethaddr": "08:13:00:00:00:00"
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/fw_env'

/system/backup

Метод создания резервной копии устройства.

Для восстановление резервной копии используется метод:
/system/restore или /system/restore/ftp

GET - Получение резервной копии
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка чтения страниц микроконтроллера"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/backup'

/system/backup/ftp

Метод создания резервной копии устройства с отправкой файла на FTP сервер.

Для восстановление резервной копии используется метод:
/system/restore или /system/restore/ftp

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x

PUT - Получение резервной копии
Запрос

Тело:

{
  "server": {
    "auth": {
      "username": "username",
      "password": "password"
    },
    "path": "",
    "name": "backup.bin"
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
server object Сервер и порт для скачивания файла резервной копии.
auth string Авторизационные данные на сервере.
username string Логин для авторизации.
password string Пароль для авторизации.
path string Путь к папке на сервере.
name string Наименование файла обновления в папке. 
{
  "server": {
    "auth": {
      "username": "username",
      "password": "password"
    },
    "path": "",
    "name": "backup.bin"
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/backup/ftp' \
--data-raw '{ 
    "server": "192.168.0.100:21",
    "auth": {
        "username": "username",
        "password": "password"
    },
    "path": "",
    "name": "backup.bin"
}'

/system/restore

Метод восстановления резервной копии устройства.

Для создания резервной копии используется метод:
/system/backup или /system/backup/ftp

PUT - Восстановление резервной копии
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restore'

/system/restore/ftp

Метод восстановления резервной копии устройства.

Для создания резервной копии используется метод:
/system/backup или /system/backup/ftp

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x

PUT - Восстановление резервной копии
Запрос

Тело:

{
  "server": {
    "auth": {
      "username": "username",
      "password": "password"
    },
    "path": "",
    "name": "backup.bin"
  }
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
server object Сервер и порт для скачивания файла резервной копии.
auth string Авторизационные данные на сервере.
username string Логин для авторизации.
password string Пароль для авторизации.
path string Путь к папке на сервере.
name string Наименование файла обновления в папке. 
{
  "server": {
    "auth": {
      "username": "username",
      "password": "password"
    },
    "path": "",
    "name": "backup.bin"
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restore/ftp'
--data-raw '{ 
    "server": "192.168.0.100:21",
    "auth": {
        "username": "username",
        "password": "password"
    },
    "path": "",
    "name": "backup.bin"
}'

/system/reboot

Метод перезагрузки устройства.

PUT - Перезагрузка устройства
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/reboot'

/system/restart/{сервис}

Метод перезапуска указанного сервиса.

Список поддерживаемых параметров "{сервис}":
- api;
- uart;
- upgrade;
- camofon;
- streamer.

PUT - Перезапуск сервиса
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка получения параметров"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restart/api'

/system/factory-reset

Метод сброса устройства к заводским настройкам.

PUT - Сброс к заводским настройкам
Ответы
200 OK

 

401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/factory-reset' \
--data-raw '{
    "netReset": false
}'

/v2/system/versions

Метод получения текущих версий прошивки устройства.

GET - Получение версий прошивки.
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
opt object Версии устройства для раздела с приложениями.
date string Дата создания прошивки.
name string Версия прошивки для раздела.
versions object Версии по конкретным приложения.
api, proguard, camofon, ddns, streamer, uart, upgrade, overlay object Наименование приложения.
name string Номер версии.
hash string Hash версии.
hw object Аппаратная версия устройства.
name string Номер версии.
mcu object Программная версия микроконтроллера.
name string Номер версии.
media object  
date string Дата создания прошивки.
name string Версия прошивки для раздела.
versions object  
overlay object Наименование приложения.
name string Номер версии.
hash string Hash версии.
rootfs object  
date string Дата создания прошивки.
name string Версия прошивки для раздела.
versions object  
libre, libiscom, baresip, ircut, rootfs, overlay object Наименование приложения.
name string Номер версии.
hash string Hash версии. 
{
  "opt": {
    "date": "2024-01-01",
    "name": "2.5.0.14.7",
    "versions": {
      "api": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "proguard": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "camofon": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "ddns": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "streamer": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "uart": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "upgrade": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "overlay": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "hw": {
        "name": "5.1"
      },
      "mcu": {
        "name": "7.1"
      }
    }
  },
  "media": {
    "date": "2024-01-01",
    "name": "2.5.0.14.7",
    "versions": {
      "overlay": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      }
    }
  },
  "rootfs": {
    "date": "2024-01-01",
    "name": "2.5.0.14.7",
    "versions": {
      "libre": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "libiscom": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "baresip": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "ircut": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "rootfs": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      },
      "overlay": {
        "name": "1.0.0",
        "hash": "1000000000000000000000000000000000000001"
      }
    }
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/system/versions'

/v2/system/upgrade

Методы для работы с обновлением устройства с помощью HTTP сервера.

Данный способ обновления проверяет файл обновления на электронную подпись.

Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
На поздних прошивках использовать новый метод: /v3/system/upgrade

GET - Получения статуса обновления
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
state string Описание состояния обновления.
stateId integer Идентификатор состояния обновления.
message string Описание под состояния обновления.
messageId string Идентификатор под состояния обновления. 
{
  "state": "Обновление не запущено",
  "stateId": 0,
  "message": "Обновление не запущено",
  "messageId": 0
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
422 Unprocessable Entity

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Обновление уже выполняется"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/system/upgrade' \
PUT - Запуск обновления устройства
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code integer Код ответа на запрос.
data object Параметры используемые при обновлении.
url string Ссылка на папку с файлами обновления на HTTP сервере.
mcu boolean Флаг включения обновления микроконтроллера устройства.
  • по умолчанию: False
opt boolean Флаг включения обновления раздела с приложениями на камере.
  • по умолчанию: False
media boolean Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере.
  • по умолчанию: False
rootfs boolean Флаг включения обновления раздела Linux на камере.
  • по умолчанию: False
skipVersion boolean Флаг пропуска проверки версий прошивок.
Warning:

Доступен начиная с версии 2.5.0.12.x

  • по умолчанию: False
 
{
  "code": 0,
  "data": {
    "url": "http://192.168.0.100:80/2.5.0.14.7",
    "mcu": false,
    "opt": false,
    "media": false,
    "rootfs": false,
    "skipVersion": false
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/system/upgrade' \
--data-raw '{
    "url":"http://192.168.0.100:80/2.5.0.14.7",
    "mcu":true,
    "opt":true,
    "media":true,
    "rootfs":true
}'

/v3/system/upgrade

Методы для работы с обновлением устройства с помощью HTTP сервера.

Данный способ обновления проверяет файл обновления на электронную подпись.

На прошивках начиная с 2.5.0.10.x перед обновлением устройство будет перезагружено.

GET - Получения статуса обновления
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
state string Описание состояния обновления.
stateId integer Идентификатор состояния обновления.
message string Описание под состояния обновления.
messageId string Идентификатор под состояния обновления. 
{
  "state": "Обновление не запущено",
  "stateId": 0,
  "message": "Обновление не запущено",
  "messageId": 0
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
422 Unprocessable Entity

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Обновление уже выполняется"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v3/system/upgrade' \
PUT - Запуск обновления устройства
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code integer Код ответа на запрос.
data object Параметры используемые при обновлении.
url string Ссылка на папку с файлами обновления на HTTP сервере.
mcu boolean Флаг включения обновления микроконтроллера устройства.
  • по умолчанию: False
opt boolean Флаг включения обновления раздела с приложениями на камере.
  • по умолчанию: False
media boolean Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере.
  • по умолчанию: False
rootfs boolean Флаг включения обновления раздела Linux на камере.
  • по умолчанию: False
skipVersion boolean Флаг пропуска проверки версий прошивок.
Warning:

Доступен начиная с версии 2.5.0.12.x

  • по умолчанию: False
 
{
  "code": 0,
  "data": {
    "url": "http://192.168.0.100:80/2.5.0.14.7",
    "mcu": false,
    "opt": false,
    "media": false,
    "rootfs": false,
    "skipVersion": false
  }
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
413 Payload Too Large

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Размер данных превышает ограничение в 1024000 байт"
    }
  ]
}
500 Internal Server Error

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Ошибка выделения памяти"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v3/system/upgrade' \
--data-raw '{
    "url":"http://192.168.0.100:80/2.5.0.14.7",
    "mcu":true,
    "opt":true,
    "media":true,
    "rootfs":true
}'

/v4/system/upgrade

Методы для работы с обновлением устройства с помощью HTTP сервера.

Данный способ обновления проверяет файл обновления на электронную подпись.

На прошивках начиная с 2.5.0.10.x перед обновлением устройство будет перезагружено.

GET - Получения статуса обновления
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
state string Описание состояния обновления.
stateId integer Идентификатор состояния обновления.
message string Описание под состояния обновления.
messageId string Идентификатор под состояния обновления. 
{
  "state": "Обновление не запущено",
  "stateId": 0,
  "message": "Обновление не запущено",
  "messageId": 0
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v4/system/upgrade' \
PUT - Запуск обновления устройства
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
code integer
  • по умолчанию: 200
data object  
type object  
properties     
{
  "code": 200,
  "data": {
    "type": null,
    "properties": null
  }
}
Примеры

CURL:

curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v4/system/upgrade' \
--data-raw '{
    "server":"192.168.0.100:21",
    "auth":{
        "username":"username",
        "password":"password"
    },
    "path":"",
    "name":"goke_7205_v300_imx335.iscom",
    "mcu":true,
    "opt":true,
    "media":true,
    "rootfs":true
}'

Производитель

/v1/manufacturer

Метод получения информации об устройстве указанной на производстве.

Метод не доступен для устройств на прошивке ниже 2.5.0.4.x

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
mac string MAC-адрес устройства.
serialNumber string Серийный номер устройства.
revision string Ревизия устройства.
timestamp string Дата и время создания QR кода.
testTimestamp string Дата и время завершения тестирования.
manufacturer string Наименование производитель.
batchNumber integer Номер партии. 
{
  "mac": "08:13:00:00:00:00",
  "serialNumber": "0000000000",
  "revision": "5.3",
  "timestamp": "2024-05-28 09:39:23",
  "testTimestamp": "2024-05-28 09:39:24",
  "manufacturer": "VD",
  "batchNumber": 10
}
401 Unauthorized

Тело:

Описание параметров
Название Тип Описание
errors array Массив возвращаемых ошибок.
field string Наименование параметра.
message string Сообщение с ошибкой. 
{
  "errors": [
    {
      "field": null,
      "message": "Требуется авторизация"
    }
  ]
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/manufacturer'

Сервисные коды

/serviceCode/settings

Методы получения / изменения сервисного кода.

Метод не доступен для устройств на прошивке ниже 2.5.0.4.x.

GET - Получение параметров
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения / выключения сервисного кода.
  • по умолчанию: False
pass integer Сервисный код для настройки устройства с клавиатуры.
  • по умолчанию: 123456
  • ограничения: от 100000 до 999999
 
{
  "enabled": false,
  "pass": 123456
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/serviceCode/settings'
PUT - Получение параметров
Запрос

Тело:

{
  "enabled": false,
  "pass": 123456
}
Ответы
200 OK

Тело:

Описание параметров
Название Тип Описание
enabled boolean Флаг включения / выключения сервисного кода.
  • по умолчанию: False
pass integer Сервисный код для настройки устройства с клавиатуры.
  • по умолчанию: 123456
  • ограничения: от 100000 до 999999
 
{
  "enabled": false,
  "pass": 123456
}
Примеры

CURL:

curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/serviceCode/settings' \
Наверх