Перейти к основному содержимому
Версия: 3.0.0 (последняя)

Справочник по API

В дополнение к интерфейсу веб-конфигуратора, OMNI Agent использует следующие HTTP-эндпоинты.

/about​

Получение информации о версии OMNI Agent.

Метод: GET

Параметры запроса: —

Параметры ответа:

  • version: string — версия OMNI Agent.
  • full_version_with_hash: string — версия OMNI Agent с хэшем.
  • build_hash: string — хэш git коммита, из которого собран OMNI Agent.
  • build_date: string — дата сборки OMNI Agent.
  • name: string — имя исполняемого файла OMNI Agent.
  • used_software: object — объект, описывающий версии используемых библиотек.
    • FaceSDK: string — версия используемого Face SDK.
  • may_be_standalone: bool — признак доступности Standalone-режима.

/preset_activation/<activation_group_id>/<enable|disable>​

Активация или деактивация группы сценариев видеоаналитики, у которых одинаковое поле activation_group_id. Используется для управления модулем активации на входе сценария, позволяя внешним системам включать или выключать видеоаналитику без отключения камер.

Метод: POST

Параметры в URL:

  • activation_group_id: string – идентификатор группы сценариев, которые необходимо активировать или деактивировать.

  • enable|disable: string – действие: включить (enable) или выключить (disable) сценарии.

  • Не принимает тело запроса.

Параметры ответа:

status: bool – статус успешности обработки запроса.

/preset_activation​

Возвращает текущее состояние активации всех известных activation_group_id, зарегистрированных в системе.

Метод: GET

Параметры запроса: Запрос не требует параметров.

Параметры ответа: Ответ содержит JSON-объект, где ключ — activation_group_id, а значение — true (активна) или false (деактивирована).

Пример успешного ответа:

{
  "EntranceCamera": true,
  "CashRegister": false,
  "DoorSensors": true
}