Skip to content

Common

Authentication

To use Entity Service API, the client application should provide an API Key and an API Signature.

Specify the API key in your request by including it as the value of the x-tn-api_key header. Specify api signature in your request by including it as the value of the x-tn-api_signature header.

Signature Generation

The API Signature is unique per request. You can create a valid API signature for your request as follows:
api­key + “:” + timestamp + “:” + SHA256 (api­key + “:” + timestamp + “:” + api­secret) where timestamp is the value of UTC in seconds, such as 1393379693.

You can find below a sample of Postman Pre-request script that shows how to generate these values:

1
2
3
4
5
6
7
8
var apiKey = // <Provided API Key>
var apiSecret = // <Provided API Secret>
var timestamp = Math.round(new Date().getTime() / 1000);
var signature = apiKey + ':' + timestamp + ':' + CryptoJS.SHA256(apiKey + ':' + timestamp + ':' + apiSecret).toString();

// Use these environment in the Request Headers: x-tn-api_key and x-tn-api_signature
postman.setEnvironmentVariable("api_key", apiKey);
postman.setEnvironmentVariable('api_signature', signature);

General Parameters

Common Headers

These are headers common to all endpoints of the API.

Name Description
x-tn-api_key Telenav assigned API KEY
x-tn-api_signature Generated API signature
x-tn-deviceid Unique device identifier

Common Parameters

For GET API, attach to the query parameters. For POST API, attach to the json body parameters.

Name Description Example
user_id Unique user identifier d770c779-8bdb-4f0d-82d6-480d888fad49
locale Used to determine the preferred response language. Whenever possible, the API will return the response data in the language specified in this parameter. en-US