General Introduction

Overview

The Mobile Devices Application Programming Interface (API) has been created to let users and partners connect their application with track and trace & navigation devices in a very easy and efficient way.

The API returns Tracking and Messaging data in a format that can be easily integrated into an application or a web site.

We intend to make all data about your devices available through the API.
Currently, you can use the API to request very specific tracking information or messages sent by your devices.

In addition, you can use the API to send messages to your devices, allowing live content push to devices, in an easy and intuitive way.

The API also offers more administrative features enabling fine-tuned management of the security and visibility of your data.

Summary of API Features

On this section, you’ll find a list of the main endpoints provided by the API, and various example usage for them.

Units Endpoint (Fleet Snapshots)

This endpoint may be used to search for units (devices) and access units’ information matching various criteria. Examples:

  • Get a unit identifier knowing its Modem ID or Serial Number
  • Get all the units that emitted points after a specific date
  • Get all the units with their last known position
  • Get the last tracking record data emitted by a group of unit
    • and refine the search for GPS_DIR and GPS_SPEED

The response is a list of units. According to the requested elements, each unit in the response includes the following information :

- The id of the device.
- The Serial/Modid of the device.
- The Position of the device at a given time.
- The value of tracking record fields for the device at a given time.

Tracking Records Endpoint (History)

This endpoint may be used to access historical data about tracking records emitted by a unit.
Tracking records include location information, and also more customizable data about the devices at a specific time, such as Speed, Direction, Battery, Odometer etc… Examples:

  • Get the most recent 100 locations for a device.
  • Get all the tracking data for a group of units
    • after January 1, 2009
    • and before January 31, 2009
    • Or from 09:00 to 19:00 today
  • Get historical values for a specific field (like Speed, Odometer etc…)

The response is a list of tracking records. According to the requested elements, each record in the response includes the following information :

- The id of the record.
- The Position of the device at the record time.
- The id and value of a tracking field (ie. Speed, odometer…) recorded.

Messages Endpoint (Communication)

This endpoint may be used to send and receive messages to devices.
The messaging system provided use channel identifiers to multiplex communication according to specific services on the device.

With this system, you would for example use the channel 11 to send and receive simple text messages with a device (in a similar way to SMS).

Meaning that every time you post a message for the device on the channel 11, the device will instantly be notified that a new text message is available, and provide a small mail icon on the display (if it’s a navigation unit).

Examples :

  • Get the most recent 25 messages posted by a device on a specific channel.
  • Get the configuration of a device
    • by posting a configuration request message (specific channel) to the device.
    • and looking for an answer to your message
    • Or by searching a previously received message on the channel
  • Assign and manage mission for a device
    • simply by posting JSON messages, on the Mission channel.
  • Push live message from external service (i.e. MSN message)

The response is a list of messages. According to the requested elements, each message in the response includes the following information :

- The id of the message.
- The status of the message.
- The author of the message.
- The recipient of the message.
- The channel of the message.
- The direction of the message.
- The reference message id (in case of a reply).
- The content of the message.