Тип канала Samsara в ArcGIS Velocity отправляет HTTPS-запросы на указанный URL API Samsara с соответствующими параметрами.
Примеры
Ниже приведены примеры использования канала Samsara:
- API Samsara с URL-адресом https://api.samsara.com/fleet/vehicles/stats?types=gps запрашивается каждые пять секунд для получения текущего местоположения транспортных средств и соответствующей статистики.
- API Samsara с URL-адресом https://api.samsara.com/fleet/equipment/locations запрашивается каждую минуту для получения текущего местоположения оборудования.
- Любая конечная точка запроса GET из API Samsara (v2), которая возвращает данные и объект разбивки в ответе JSON.
Примечания по использованию
При работе с каналом Samsara учитывайте следующее:
- Канал Samsara опрашивает указанный URL API Samsara для загрузки данных с частотой, заданной с помощью шага Интервал опроса канала мастера настройки.
Примечание:
Канал не должен быть настроен на запуск чаще, чем API Samsara может возвращать объекты.
- Когда задан интервал опроса, опрос происходит через регулярные временные интервалы, в противоположность времени запуска канала. Например, если канал настроен на опрос данных каждые пять минут и канал запускается в 8:03, первый запрос данных произойдет в 8:05, следующий — в 8:10 и т.д.
- Уровни лицензий Velocity на подписку имеют ограничения на объем данных, которые могут быть получены с помощью канала, как указано ниже. Если каналы превышают предел приема данных вашего уровня лицензии, в журналы записывается сообщение, и вам отправляется электронное письмо с уведомлением о достижении предела. Если скорость передачи данных канала превышает предел уровня подписки больше часа, канал останавливается. Проконсультируйтесь со своим представителем Esri или службой технической поддержки Esri , чтобы изучить уровни лицензий Velocity, которые поддерживают ваши рабочие процессы. Уровни лицензий следующие:
- Standard — прием и обработка данных со скоростью 25 КБ/с (примерно 100 событий в секунду).
- Advanced — прием и обработка данных со скоростью 250 КБ/с (примерно 1,000 событий в секунду).
- Dedicated — прием и обработка данных со скоростью 2,500 КБ/с (примерно 10,000 событий в секунду).
- Параметр Параметры URL поддерживает глобальные переменные канала. По умолчанию, глобальные переменные канала конвертируются во время эпохи (миллисекунды с 1 января 1970 UTC). При желании вы можете преобразовать глобальные переменные канала в секунды эпохи (секунды с 1 января 1970 года) и строковый формат даты и времени. Ниже перечислены аналитические переменные канала и время, которое они представляют. При первом запуске канала после запуска или перезапуска $feed.FeedLastScheduledStart время будет равно текущему времени запуска минус пять минут.
- $feed.FeedStartTime - время запуска канала
- $feed.FeedScheduledStartTime - запланированное время следующего запуска
- $feed.FeedLastScheduledStartTime - запланированное время последнего запуска
- Канал Samsara автоматически обрабатывает ответ JSON от API Samsara в возвращаемом объекте data и сглаживает JSON.
- Вы можете сгладить массивы и предоставить определенные исключения при сглаживании массивов. Разделяйте исключения при сглаживании нескольких массивов запятыми.
- Velocity автоматически обрабатывает ответы с разбивкой на страницы от API Samsara для обработки всех объектов.
- После настройки параметров подключения канала задайте схему и параметры ключевых полей.
Параметры
Ниже приведены параметры канала Samsara:
| Параметр | Описание | Тип данных |
|---|---|---|
URL | Samsara API URL. Это должна быть конечная точка запроса GET API Samsara, поскольку канал извлекает данные для приема. URL вместе с предоставленными параметрами URL управляет данными, возвращаемыми API Samsara. Чтобы найти URL конечной точки API Samsara, перейдите в раздел Обзор API Samsara. | Строка |
Ключ API | Ключ Samsara API. Укажите ключ API в следующей форме: samsara_api_<yourAPIKey>. | Строка |
Параметры URL | Дополнительные параметры URL, которые необходимо включить в URL HTTP-запроса, отправляемого на указанный URL Samsara. Хотя параметры также могут быть заданы в параметре URL, параметры URL, указанные здесь, имеют приоритет над соответствующими параметрами, заданными в параметре URL. Заданные здесь параметры всегда будут закодированы в URL. Этот параметр поддерживает глобальные переменные канала. | Пара ключ-значение |
Глобальные переменные | Преобразуйте глобальные переменные канала в пользовательский формат даты и времени. Это дополнительный параметр. Узнайте больше о настройке формата даты (миллисекунды эпохи, секунды эпохи и формат строки) | Строка |
Дополнительное ведение журнала | Указывает, будет ли включено ведение журнала необработанных HTTP-запросов и ответов, отправленных из Velocity на Samsara URL. Это дополнительный параметр. Примечание:Включайте этот параметр только в целях устранения неполадок и отключайте его после завершения устранения неполадок. После включения запустите канал, журналы уровня отладки будут доступны на странице журналов канала. При необходимости обратитесь в Esri Technical Поддержка за помощью в устранении неполадок. | Boolean |
Советы и ограничения
Ниже приведены обсуждения и ограничения при использовании канала Samsara:
- Для использования этого типа канала необходимы подписка Samsara и ключ API.
- Текущее поколение API Samsara использует формат RFC 3339 для отметок времени. Для настройки установите параметр Время начала в поле с этой строкой datetime и укажите формат строки datetime yyyy-MM-dd'T'HH:mm:ss'Z'.
- API Samsara можно опрашивать каждые пять секунд.