Вступление
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.
Основные возможности API
API позволяет управлять ключевыми объектами платформы:
Устройства (Devices):
- получение списка устройств
- получение детальной информации
- управление характеристиками
- выполнение команд
- получение последних позиций
Группы (Groups):
- объединение устройств
- управление вложенностью групп
- получение составов групп
Позиции и треки:
- получение последних координат
- запрос треков за период
- телематические параметры
События (Events):
- получение списка событий и уведомлений
Налаштування та параметри:
- датчики
- пользовательские поля
- типы устройств
- конфигурации
Каждая сущность имеет свой набор REST-эндпоинтов, подробно описанных в Swagger-интерфейсе.
Документация Swagger
Полная спецификация методов доступна в Swagger UI:
https://my.m2m.eu/api/swagger-ui/index.html
Swagger UI содержит:
- описание всех эндпоинтов
- структуры данных
- примеры запросов и ответов
- возможные коды ошибок
Swagger можно использовать как интерактивную среду для тестирования API-запросов.