Documentation

Explore the detailed technical specifications to learn how to integrate NaBi into your application.

Contact the developer

General Track API
1.0.0
OAS3

Explore our APIs. Read our guides to learn how to integrate and get started in order to access your data.
Host: note that General Track API request paths follow this format: api.general-track.com/{API version}/{API path}.
The current api version is v2

The Device API refers to interface devices connected to the internet (identified by the IMEI), which send data (GPS, temperature, events, etc..) to the server. Example device types: NaBi Solo (battery powered tracker), T10 (fleet tracker), S10 (vehicle security tracker).

You can get your sensor data, events and coordinates via both Device API and Synchronization API endpoints. The main differences between them are as follows:

  • At Device API endpoints, sensor data can be requested according to the IMEI of the sender device and the time period of the event/measurement. The most common use case is that the data to be displayed is requested directly from here instead of a WEB- or mobile backend database. Get data directly from Device API instead of own database.
  • The Synchronization API helps you mirror the database by getting your data by database insertion time. For example, your server can requests the newly inserted lines once in a minute. You can insert results to your own database and you can generate alarms based on the received sensor values/events.

Getting Started

Welcome to our API reference page! Here you can learn about the tools which we provide you to enrich any of your applications or websites with information received from your devices.

Log in or register an account

In order to get started with our API you need to have a General Track device.

By purchasing the device you will be invited to the General Track website where you can get your credentials to use the API. We will send you an e-mail with details on how to finish registration and then you can login to the system.

Obtaining API and Private key

Before getting started, you have to generate your own api key which identifies you, and a private key to sign your requests. It can be achieved by visiting the general track website API manager page .

Generating a signature

Our API server needs to identify your request to be sure that you are the one who made the request. To achieve this you need to generate a signature and include it in your request header.

We use Private and Public keys to verify your identity. You sign your request with the private key, and we validate it by its public key component. When you login to our website you can request your private key, which we show you only once for security reasons, so you need to save it then.

We generated the codes required for signature, you simply need to insert them into your programme and use them as presented below.

The parameters we use:

  • data - String -

    The requested API URI with the version number. If there is whitespace in the URI because of the date, encode it like the code below:

    Example: $data = str_replace(' ', '%20', '/v2/device/track/894823952?from=2019-04-27 10:10:10&to=2019-04-27 10:10:10')

  • keyPath - String -

    Relative path to the private key.

    Example: 'file://privateKey.pem'

PHP
                            if($signature = OpenSSL::Instance()->privateKey($keyPath)->sign($data)) {
                                echo $signature;
                            }
                        
NodeJS
                            OpenSSL.privateKey(keyPath).sign(data).then((signature) => {
                                console.log(signature);
                            });
                        
Java
                            try {
                                String sign = OpenSSL.INSTANCE.privateKey(keyPath).sign(data);
                                System.out.println(sign);
                            } catch (Exception e) {
                                e.printStackTrace();
                            }
                        

Launching API requests

We provide you with a simple PHP code to make use of the signature module and API endpoints. We designed it to be straightforward, but let us briefly summarize the following:

Signing the request

The GT API requires a different signature for each URI request. You need to generate it before every request using the module and the private key.

Generating a URI

You need to use the following syntax: https://api.general-track.com/{API version}/{API path}/{IMEI (Optional)}?{parameters (Optional)} The keyword 'optional' indicates that a parameter is not required by each URI: https://api.general-track.com/v2/device/list

IMPORTANTYou need to compose the URL by putting the query parameters into alphabetical order.

Making API requests

The code example assumes that the OpenSSL mobule file and the .PEM private key are in the root directory next to the script to be run. Here you can set the endpoint and the API key and make a request to the endpoint with CURL. The key is generated and attached to the request header by the OpenSSL module.

PHP
                            require_once "./OpenSSL.php";

                            $baseURL = "https://api.general-track.com";
                            $keyPath = "file://private.pem";
                            $endPoint = str_replace(' ', '%20', '/v2/device/list');
                            $apiKey = '-apikey-';

                            if($signature = OpenSSL::Instance()->privateKey($keyPath)->sign($endPoint)) {
                                $ch = curl_init();

                                $headers = [
                                    'x-apikey: '.$apiKey,
                                    'x-signature: '.$signature
                                ];

                                curl_setopt($ch, CURLOPT_URL, $baseURL.$endPoint);
                                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                                curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

                                $response = json_decode(curl_exec($ch));
                                curl_close($ch);

                                var_dump($response);
                            }
                        

NaBi Solo Datasheet

You can download this document by clicking HERE

NaBi Connect Datasheet

You can download this document by clicking HERE

RFS10 Sensor Datasheet

You can download this document by clicking HERE

Cold Chain

You can download this document by clicking HERE

GPS Tracking

You can download this document by clicking HERE

Hourmeter

You can download this document by clicking HERE

Mounting Solutions

Variety of use cases require different mounting solutions. Please select the suitable mounting for your application or contact us if you need something special for your application.

Vásároljon NaBi kiegészítőket a webáruházban

Pipe clamp

NaBi can be mounted with one or two screws pipe clamp onto planar surfaces or existing screwing locations.

Steel and rubber ties

The simplest mounting solution for NaBi is the fixing by industrial rubber or steel ties. They can fix NaBi to pipes, posts and other structural elements.

We provide a fastener tool for the steel ties which makes the tighten and the cutting of the ties simple and fast.

Weldable robust steel enclosure

NaBi can be deployed in the roughest environments in a weldable protective metal case.

The robust steel enclosure enables the application on containers, tools of excavators, construction machines, and in the railway industry. Special head screws prevent unauthorized removal.

Rögzítés IBC tartályokon

NaBi can be easily mounted on 1000 liters IBC containers by using a special console.

The console can be used universally in case of different IBC container manufacturers. The solution does not disturb the draining nor the stacking of the containers.

EPAL pallets

NaBi can be ordered with special end caps to place it into the standard hole inside EPAL pallets.

The standard manufacturing process of pallets remains the same by using the pre-drilled standard location inside the pallet blocks.

Traffic sign

NaBi can be easily fixed inside the pole of traffic signs and it can be removed only by a special tool.

It ensures in case of both the mobile and the fixed traffic signs that the signs are on the expected location and orientation in order to avoid accidents.

Do you need a custom mounting?

Don’t hesitate to contact us!
Gtr Loading...