Integrations Documentation

Key assignment, management and documentation for Integrations happens inside MyEROAD, under Settings > Administration > Integrations.

Current Integration APIs

Detailed documentation on these API path parameters, response samples and usage is found within the API Documentation section within MyEROAD.


Latest Machine State returns data for a given machine (vehicle, trailer, etc). Common return values include:

  • Status
  • Machine ID
  • Organisation ID
  • Event data
  • Driver data
  • Device Data (EROAD's on-board telematics hardware)
  • Location data


Introspection returns the entities to which a key has access. Especially useful for requests constructed using an entity UUID, Introspection queries the endpoint for a list of entities, then iterates over this list against the specific API endpoint to satisfy your usecase. Common return values include:

  • Entities
  • Permissions

Create a key

  1. Click the API Keys tab if you're not there already.
  2. Click the Create new API Key button. This takes you to the edit screen.
  3. Fill in:
    1. Technical Contact
    2. A name for your key
    3. Expiry date
  4. Click Add products.
  5. An API key needs to have one or more products assigned to it. A product represents one or more API endpoints: they may be in functional groups or wrapped into a specific plan. The products shown are dependent on your organisation's API plan / rights.
  6. This may generate additional options, depending on the nature of the API. Resolve those to your requirements.
  7. Click Create key.

This will generate a new key and add it to your set of keys.

Managing Keys

image2020 9 3 13 57 33

From left to right:

  • View Key: Shows the same information in the Key box in a slide-out panel.
  • Copy Key: Copies the key string to your computer's clipboard.
  • Edit: Lets you edit the key properties. Keys are not re-generated after the edit.
  • Delete: Removes the key permanently.