Що таке 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 надає методи для роботи з користувачами. Залежно від доступних прав користувачі GPS-Trace Console можуть створювати записи користувачів, оновлювати дані користувачів і призначати клієнтські плани, модулі та права доступу.
Як працюють методи даних акаунта?
Розділ акаунта містить методи для створення, читання, оновлення та видалення даних акаунта. Ці дії часто називають CRUD-операціями.
- Створити акаунт
- Видалити акаунт
- Оновити дані акаунта
- Отримати дані акаунта
Під час створення клієнтського акаунта запит може містити застосунок, який потрібно призначити цьому акаунту. Це робиться через поле reg_apps. Доступні застосунки залежать від рівня доступу користувача та умов договору.
Записи користувачів створюються разом із клієнтським акаунтом і залишаються неактивними, доки не завершено процес активації.
Щоб активувати акаунт:
- Користувач GPS-Trace Console надсилає клієнту посилання для активації.
- Клієнт переходить за посиланням і вводить адресу електронної пошти та пароль.
- Клієнт підтверджує реєстрацію через посилання підтвердження в електронному листі.
- Після підтвердження акаунт користувача стає активним відповідно до призначеного застосунка, плану та прав доступу.
Чи використовується цей API для безпосереднього відстеження транспортних засобів?
API призначений для операцій у GPS-Trace Console та обміну даними із зовнішніми системами. Він не є заміною мобільного застосунка Forguard або інших інтерфейсів моніторингу GPS-Trace.
Користувачі GPS-Trace Console можуть застосовувати API для роботи з об'єктами, клієнтськими планами, статистикою, Історією, CRM-системами та білінговими системами — залежно від рівня доступу.
Для чого можна використовувати API?
Platform API можна використовувати для підключення GPS-Trace до CRM, білінгу, звітності або внутрішніх систем.
Наприклад, користувачі GPS-Trace 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. Якщо у вас його немає, ви також можете зареєструватися тут.