Telematics API

Overview

The API (application programming interface) is used for external servers/services to access data from the EMIT telematics platform. This is done via a program "key", similar to the concept of a username/password except for a computer program.

Creating a Key

On the connect site a key can be created under "Data API" on the top tab.

The main keys are under "Add or remove data applications" at the top. Creating a key here will allow data access to all units for the entire company. To make a new key pick a name at the bottom and select "Add Application". The dialog will appear with an ID and secret- note that the secret is only shown once!

Guest Keys

Sometimes a site customer will want to access data via the API. This is done via Guest Keys which will allow for data access to only a subset of units. These types of keys are created under "Add or remove Customer data applications" on the Data API tab. The keys are created like a normal company-wide key, except a customer will be specified in the "SiteCustomer" box.

The bottom of the Data API tab shows lists of units under each customer. If some are missing then go to the unit and change the Site Customer under that unit's "Unit Information" tab.

API programming reference

The API documentation can be found here: [1]

The most commonly used endpoints are "GET /api/1/units" (get unit list), "GET /api/1/units/allData" (get all data, including a filter for some time period), and "GET /api/1/units/allEvents" (get all alerts for some time period).