T Comm Public API

Welcome to our new public API. Below is an explanation on how you should authenticate your requests to the API. This authentication schema is required for all actions described in the OpenAPI spec linked below.

OpenAPI Specification

Authentication

Authentication is done by signing the request URL with your own private key which can be requested via the T Comm Servicedesk. The part which has to be signed starts after the first forward slash after the FQDN. The string that is signed should include all URL query parameters as well. When the URL is signed you will have to include both your public key and generated signature as query parameters in the fields ‘key’ and ‘hash’ respectively.

Signing the URL should be done with HMAC method and using the SHA256 algorithm.

Consider the following example for retrieving a list of units:
GET https://api.tcommtelematics.com/v1/units?sort_field=plate&sort_type=asc

The part which has to be signed is:
units?sort_field=plate&sort_type=asc

The final request URL will become:
GET https://api.tcommtelematics.com/v1/units?sort_field=plate&sort_type=asc&key=<public_key>&hash=<signature>

Example Code


<?php
$public_key    = "{PUBLIC_KEY}";
$private_key   = "{PRIVATE_KEY}";
$main_link     = 'https://api.tcommtelematics.com/';
$base_path     = "v1/updates/latest";
$conditions    = "?sort_field=id&sort_type=desc";
$hashBase      = $base_path . urlencode($conditions);
$hash          = hash_hmac('sha256', $hashBase, $private_key);
$api_url       = "{$main_link}{$base_path}{$conditions}&hash={$hash}&key={$public_key}";
?>

Use cases

Here you will find examples of the most common use cases.

Retrieve last updates

It's possible to get updates from units through the endpoint:
GET https://api.tcommtelematics.com/v1/updates/unit/{unit_id}?

Nonetheless this endpoint is not meant to be used if the goal is to get the last update of each unit.
For that case, one single query can be done to:
GET https://api.tcommtelematics.com/v1/updates/latest
This will return the latest update of ALL the customer units.

In case you are an OBSERVER, you can retrieve the latest updates at:
GET https://api.tcommtelematics.com/v1/observers/updates/latest

Retrieve ALL data

It's possible to retrieve the static data of a unit through the following endpoint:
GET https://api.tcommtelematics.com/v1/units/{unit_id}
But if the goal is to get ALL the static data from all the units, we can achieve that with one single request:
GET https://api.tcommtelematics.com/v1/units

Request limit

The API has a usage limit of 20 requests per minute or a request every 3 seconds.