Часто задаваемые вопросы: Методы Partner API

Что такое Partner API?

GPS-Trace Partner API — это мощный инструмент, который позволяет бизнесу интегрировать расширенные возможности GPS-трекинга в свои существующие системы. Он предлагает различные методы для создания и управления учетными записями пользователей и клиентскими планами, конфигурации объектов и генерации пользовательских отчетов, а также загрузки статистики.

Как мне аутентифицировать свои запросы к Partner API?

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

Какие ключевые функции у Partner API?

Ключевые функции GPS-Trace API включают:

• Управление учетными записями
• Управление компанией
• Управление клиентскими планами
• Управление объектами
• Управление пользователями
• Управление биллингом

Как я могу управлять пользователями с помощью Partner API?

Partner API предоставляет конечные точки для регистрации и управления пользователями. Вы можете создавать новые учетные записи пользователей, обновлять информацию о пользователях и управлять клиентскими планами и наборами модулей и разрешений для обеспечения безопасной и организованной базы пользователей.

Как работает управление учетными записями?

Подраздел CRUD учетных записей охватывает методы, связанные с операциями CRUD (Создание, Чтение, Обновление, Удаление) для учетных записей, которые включают:

• Создание учетных записей: Методы для создания новых учетных записей в системе.
• Удаление учетных записей: Методы для удаления учетных записей из системы.
• Обновление учетных записей: Методы для обновления существующей информации об учетной записи.
• Получение информации об учетной записи: Методы для получения деталей конкретных учетных записей.

При создании учетной записи клиента приложению присваивается учетная запись, предоставляющая клиенту доступ. Это реализуется через запрос, одним из обязательных полей которого является "reg_apps". Идентификаторы приложений включают:

• Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
• Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
• Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Сущности пользователей создаются одновременно с созданием учетной записи клиента и изначально неактивны. 

Для активации учетной записи:

• партнер отправляет своему клиенту специальную ссылку для активации.
• После нажатия на ссылку активации клиент вводит свой уникальный адрес электронной почты (который будет связан с учетной записью) и пароль.
• Затем клиент получает письмо с подтверждением регистрации на указанный адрес. Следуя ссылке в письме, клиент завершает процесс регистрации, вводя запрашиваемую информацию в форму, которая может включать пароль, ключ для входа и т.д.

В результате вы создаете нового пользователя с помощью нашего API всего за несколько кликов.

Это Partner API или API для GPS-мониторинга?

Это определенно Partner API, основанный на функциональности нашей Partner Panel. Вы не можете мониторить свой автопарк через него. Основная цель — управление и настройка клиентских учетных записей и объектов, установление тарифов, управление аналитикой и историей. С помощью нашего API вы можете интегрировать нашу партнерскую платформу с вашей CRM и биллинговой системой.

Как это может принести пользу моему бизнесу?

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

Могу ли я получить доступ к историческим данным трекинга с помощью Partner API?

Да, GPS-Trace Partner API позволяет получить доступ к историческим данным трекинга.
Эти данные ценны для анализа производительности, расследования инцидентов и оптимизации будущих операций. Например, вы можете использовать метод “GET /partner/units/{id}/messages“ (Получить сообщения объекта) для получения сообщений с устройства (объекта) на Forguard. Максимальное количество сообщений, которые можно получить, составляет 10 000, и вы также можете указать количество последних сообщений, которые хотите получить.

Пример запроса для получения последних 10 сообщений:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Поля в ответе будут зависеть от параметров, отправленных трекером.

Как пользовательская отчетность может помочь моему бизнесу?

Пользовательская отчетность позволяет создавать детализированные отчеты на основе ваших конкретных потребностей.
Эти отчеты могут включать данные об использовании и эффективности транспортных средств, предоставляя ценные инсайты для принятия решений и улучшения бизнес-стратегий. Например, чтобы получить последние данные телеметрии объекта, вам следует использовать метод “GET /partner/units/{id}/telemetry” (Получить данные телеметрии).

Пример запроса:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

В результате вы получите отчет с последним телеметрическим сообщением каждого указанного вами устройства.

Как мне начать работу с Partner API?

Чтобы начать работу с Partner API, вы можете заполнить форму на нашем сайте или написать нам на business@gps-trace.com