Перейти к основному содержимому
Версия: 1.17.1

Веб-сокеты

В OMNI Platform реализована возможность отправлять события, приходящие от OMNI-агента, на сторонний сервис по веб-сокетам. Ниже показано подключение по веб-сокету на примере HTTP-клиента Postman:

  1. Скачайте и установите Postman.
  2. В интерфейсе клиента выберите file -> new -> WebSocket.
  3. В открывшейся вкладке укажите request URL:
  • ws://$DOMAIN/event-service/<event_type>/ws?endpoint_id=<endpoint_id>&scope_id=<workspace_id|agent_id|camera_id|profile_group_id> — для передачи событий по веб-сокету.
ВНИМАНИЕ!

Для получения событий укажите тип событий, которые будут отправляться по веб-сокету. Всего доступно пять типов событий: non_identification, identification, har, roi, crossing.

Для подключения по веб-сокету используется endpoint_id, который указан в дашборде на странице Веб-сокеты. Также запросить endpoint_id можно через API (См.пункт Эндпоинты веб-сокета раздела Справочник по API).

Для фильтрации отправляемых по веб-сокету событий укажите значение scope_id. Доступны следующие значения фильтрации: идентификатор воркспейса, идентификатор агента, идентификатор камеры или идентификатор списка наблюдения.

  1. Соединение установлено, события отправляются на сервер.
примечание

Поскольку данные платформы и агента синхронизируются в среднем один раз в минуту, может произойти следующая ситуация:

Если в течение в среднем одной минуты после удаления профиля из базы человек, которому принадлежал этот профиль, попадает в поле зрения камеры, OMNI-агент формирует событие идентификации и передает его в платформу. Профиля на платформе уже не существует, поэтому платформа не сможет передать такое событие по веб-сокету. Такие «потерянные» события можно будет вывести только через GraphQL API платформы.