Перейти до основного вмісту

Вступ

API M2M Platform надає розробникам програмний доступ до всіх основних функцій системи моніторингу, керування пристроями та роботи з телематичними даними. Інтерфейс побудований на REST-архітектурі та використовує стандартизовані механізми взаємодії через HTTP(S)-запити. Усі дані передаються у форматі JSON.

API орієнтований на інтеграцію зовнішніх систем, автоматизацію бізнес-процесів та створення власних сервісів, які працюють з пристроями, групами, координатами, маршрутами, звітами, командами та іншими сутностями M2M Платформи.

Формат взаємодії​

Базовий URL: https://my.m2m.eu/api/

Формат даних: application/json

Методи:

  • GET — отримання даних
  • POST — створення сутності або запуск операції
  • PUT — оновлення даних
  • PATCH — часткове оновлення
  • DELETE — видалення сутності

Автентифікація та безпека​

Усі запити до API потребують авторизації. Використовується механізм Bearer Token.

Кожен запит має містити заголовок:

Authorization: Bearer <token>

Токен генерується за наявності актуальних логіну та пароля.

Без коректного токена доступ до API неможливий.

Усі з’єднання виконуються виключно через HTTPS.

Час "життя" основного токена - 120 хвилин. Час життя refresh токена - 30 діб.

Основні можливості API​

API дозволяє керувати ключовими об’єктами платформи:

Пристрої (Devices):

  • отримання списку пристроїв
  • отримання детальної інформації
  • керування характеристиками
  • виконання команд
  • отримання останніх позицій

Групи (Groups):

  • об’єднання пристроїв
  • керування вкладеністю груп
  • отримання складу груп

Позиції та маршрути:

  • отримання останніх координат
  • запит треків за період
  • телематичні параметри

Події (Events):

  • отримання списку подій та сповіщень

Налаштування та параметри:

  • датчики
  • користувацькі поля
  • типи пристроїв
  • конфігурації

Кожна сутність має власний набір REST-ендпоінтів, детально описаних у Swagger.

Документація Swagger​

Повна специфікація методів доступна в Swagger UI:

https://my.m2m.eu/api/swagger-ui/index.html

Swagger UI містить:

  • опис усіх ендпоінтів
  • структури даних
  • приклади запитів і відповідей
  • можливі коди помилок

Swagger можна використовувати як інтерактивне середовище для тестування API-запитів.