Как устроена интеграция

События, отчёты и настройки платформы доступны не только в консоли, но и по API. Это позволяет передавать данные в вашу систему учёта, диспетчерскую или BI.

ДоступCopy Anchor Link

Интеграция получает доступ по API-токену организации. Токен выпускает администратор организации, он действует только в рамках этой организации и отзывается в любой момент. Храните токен в хранилище секретов и не передавайте в клиентский код.

Что можно получатьCopy Anchor Link

• События — нарушения, интервалы простоя, присутствие людей в зонах — с временем, камерой, зоной и ссылкой на доказательство.
• Отчёты — сводки по периодам и сменам.
• Уведомление о событии — вебхук на ваш адрес в момент фиксации события. Подключается по согласованию при запуске интеграции.

Формат ответовCopy Anchor Link

Каждая ручка API отвечает единым конвертом:

{ "data": { }, "error": null }

{ "data": null, "error": { "code": "vms.camera.detector_required", "message": "…" } }

При успехе заполнено data, при ошибке — error. Поле error.code — машинный код ошибки, подробнее в разделе Коды ошибок.

ПодробностиCopy Anchor Link

Описание токенов, ручек и вебхуков открывается после входа в учётную запись организации.