Skip to main content

Introduction

The API M2M Platform provides developers with programmatic access to all core features of the system, including monitoring, device management, and telematics data processing. The interface is based on the REST architecture and uses standardized mechanisms for interaction through HTTP(S) requests. All data is transmitted in JSON format.

The API is designed for integrating external systems, automating business processes, and building custom services that interact with devices, groups, positions, tracks, reports, commands, and other platform entities

Interaction Format​

Base URL: https://my.m2m.eu/api/

Data Format: application/json

HTTP(S) Method:

  • GET — retrieve data
  • POST — create an entity or start an operation
  • PUT — update data
  • PATCH — partial update
  • DELETE — delete an entity

Authentication and Security​

All API requests require authorization. The platform uses a Bearer Token mechanism.

Each request must include the header:

Authorization: Bearer <token>

The token is generated if you have a valid username and password.

Without a valid token, access to the API is not possible.

All communication is performed strictly over HTTPS.

Core API Features​

The API allows managing key platform objects:

Devices:

  • retrieve the list of devices
  • get detailed information
  • manage characteristics
  • execute commands
  • fetch last known positions

Groups:

  • group devices
  • manage nested group structures
  • retrieve group members

Positions and Tracks:

  • get latest coordinates
  • request tracks for a specific period
  • telematics parameters

Events:

  • retrieve lists of events and notifications

Settings and Parameters​

  • sensors
  • custom fields
  • device types
  • configuration parameters

Each entity has its own set of REST endpoints documented in Swagger.

Swagger Documentation​

The full API specification is available through Swagger UI:

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

Swagger UI contains:

  • detailed description of all endpoints
  • data structures
  • request and response examples
  • error codes

*Swagger also serves as an interactive environment for testing API requests.