Skip to main content

Правила уведомлений

При попадании объекта в определенную геозону (или в любую) вы можете получить уведомление о наступлении данного события. Geofencing API предоставляет очень гибкий механизм, благодаря которому вы можете уточнить с какими именно объектами или геозонами должны отслеживаться события.

Создание правила#

Геозоны в рамках Geofencing API описываются в формате GeoJSON, что позволяет описать практически любую геометрию (полигон, точка с радиусом, квадрат и так далее). Пример описания геометрии небольшой зоны:

При создании правила уведомлений доступно 3 параметра:

ПараметрОписание
objectIdUUID объекта, для которого создается правило уведомления. Если правило должно работать для всех объектов слежения, тогда должно использоваться значение *
geofenceIdUUID объекта, для которого создается правило уведомления. Если правило должно работать для всех геозон, тогда должно использоваться значение *
minEventSpeedМинимальная скорость движения объекта, при которой событие сработает. Если не указано, то событие сработает при любой скорости.
eventTypes
  • 'inside' - событие будет срабатывать, пока объект(ы) находятся внутри геозоны
  • 'outside' - событие будет срабатывать, пока объект(ы) находятся вне геозоны
  • 'enter' - событие будет срабатывать только при входе в геозону
  • 'exit' - событие будет срабатывать только при выходе из геозоны
  • 'entering' - тоже самое, что enter, только событие сработает от 3 точек
  • 'exiting' - тоже самое, что exit, только событие сработает от 3 точек
  • 'cross' - событие только при пересечении (вход и выход) геозоны
notificationType1 - для WebHook, 2 - для rabbitMQ, 3 - для Redis, 4 - для MQTT, 5 - для gRPC
notificationWebhookUrlURL, куда будет отправлен POST-запрос со всей информацией о произошедшем событии. Актуально только если notificationType равен 1
ttlВремя жизни правила в секундах. По истечении срока правило уведомления автоматически уничтожится

Каждое правило при создании получает UUID. Подробнее о создании геозоны вы можете прочитать в документации в формате Open API.

Отладка#

В личном кабинете на платформе СтарЛайн Карт доступен специальный раздел "Геозоны и объекты", в котором вы можете просматривать все созданные пользователем геозоны и объекты, без необходимости разрабатывать собственные отладочные инструменты.