Что такое GPS-Trace Platform API?
Platform API — это программный интерфейс для зарегистрированных пользователей GPS-Trace Console. Он позволяет внешним системам (например, CRM, биллингу или инструментам отчетности) запрашивать данные GPS-Trace и выполнять выбранные операции в Console.
API включает методы для работы с пользователями, клиентскими планами, объектами, биллинговыми данными, статистикой и отчетами.
Как проходит аутентификация API-запросов?
API-запросы проходят аутентификацию с помощью API-токена. Токен — это ключ доступа, сгенерированный в GPS-Trace Console. Его необходимо передавать в каждом запросе, чтобы платформа могла проверить, какие действия разрешены пользователю.
Токен передается в заголовке запроса X-AccessToken.
Какие группы методов API доступны?
API включает следующие группы методов:
- Методы данных аккаунта
- Методы данных компании
- Методы клиентских планов
- Методы объектов
- Методы пользователей
- Методы биллинговых данных
- Методы статистики и отчетов
Как работать с пользователями через API?
Platform API предоставляет методы для работы с пользователями. В зависимости от доступных прав пользователи Console могут создавать записи пользователей, обновлять данные пользователей и назначать клиентские планы, модули и права доступа.
Как работают методы данных аккаунта?
Раздел аккаунта включает методы для создания, чтения, обновления и удаления данных аккаунта. Эти действия часто называют CRUD-операциями.
- Создать аккаунт
- Удалить аккаунт
- Обновить данные аккаунта
- Получить данные аккаунта
При создании клиентского аккаунта запрос может включать приложение, которое следует назначить аккаунту. Это выполняется через поле reg_apps. Доступные приложения зависят от уровня доступа пользователя и условий соглашения.
Записи пользователей создаются вместе с клиентским аккаунтом и остаются неактивными, пока не будет завершен процесс активации.
Чтобы активировать аккаунт:
- Пользователь Console отправляет клиенту ссылку для активации.
- Клиент переходит по ссылке и вводит адрес электронной почты и пароль.
- Клиент подтверждает регистрацию по ссылке подтверждения из письма.
- После подтверждения пользовательский аккаунт становится активным в соответствии с назначенным приложением, планом и правами доступа.
Используется ли этот API для прямого отслеживания транспорта?
API предназначен для операций в GPS-Trace Console и обмена данными с внешними системами. Он не является заменой мобильного приложения Forguard или других интерфейсов мониторинга GPS-Trace.
Пользователи Console могут применять API для работы с объектами, клиентскими планами, статистикой, историей, CRM-системами и биллинговыми системами — в зависимости от уровня доступа.
Для чего можно использовать API?
Platform API можно использовать, чтобы связать GPS-Trace с CRM, биллингом, отчетностью или внутренними системами.
Например, пользователи Console могут получать данные объектов, работать с клиентскими планами, экспортировать статистику и сокращать повторяющиеся ручные действия во внешних рабочих процессах.
Можно ли получать исторические данные мониторинга через API?
Да, Platform API может предоставлять доступ к историческим данным мониторинга — в зависимости от доступных методов и прав.
Например, метод GET /partner/units/{id}/messages получает сообщения от объекта. Максимальное количество сообщений, которое можно получить, — 10 000. Также можно указать, сколько последних сообщений вы хотите получить.
Пример запроса, чтобы получить последние 10 сообщений:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Поля в ответе зависят от параметров, которые передает устройство.
Как получить телеметрические данные?
Чтобы получить последние телеметрические данные по объекту, используйте метод GET /partner/units/{id}/telemetry. Ответ содержит последнее доступное телеметрическое сообщение для указанного объекта. Точный набор полей зависит от данных, которые передает устройство.
Пример запроса:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Как начать работу с API?
Чтобы запросить доступ к API, просто войдите в свой аккаунт Console. Если его нет, вы также можете зарегистрироваться здесь.