logo

An Introduction to REST and the Trackerway API

Connecting systems made easy /version 1.0/


Rest API Introduction

  • Item Name : Restful API Documentation
  • Item Version : v 1.0
  • Author :TrackerWay | IT Department v 1.0
  • Contact Author : e-mail support

When we talk about the TrackerWay API, we use terms like “REST” and “RESTful.” “REST” stands for Representational State Transfer. It is an architectural style that is an alternative to RPC or SOAP-based web services.

While there is no official REST standard, there are common approaches and best practices used across the engineering community that help define how RESTful APIs should work. For example, most RESTful APIs follow specific constraints or design rules. Most APIs are not fully RESTful, including the TrackerWay API. But TrackerWay follows most of the practices and common definitions of the style. For example, the TrackerWay API has what we call “resources,” which are typically nouns like “subscribers” or “campaigns.” You take action on resources using the standard HTTP methods: POST, GET, PATCH, and DELETE.

Requirements

You will need the following tools to make use of the API.

  1. Code Editing Software (eg: Dreamweaver, Sublime Text or Notepad)
  2. Web Browser for testing (eg: Google Chrome or Mozilla Firefox)

Be careful with your API key. Sharing your API key with other people, means that they will be able to have access in the sensitive data of your devices and retrieve all the critical information of your vehicles. You should never reveal your API key, in case you think someone else has access to your API key, contact us immediately so we will reissue a new API key

Getting Started #back to top

At this point we would like to inform you that you will get the API results on your browser under the JSON and TXT format, as these two formats are the most common and easy to use! The first you must do in order to start using our API system, is to retrieve your API key. In order to see how you can get your API key, check this entry

Default API URL to call

                                                      
                        
                        
https://track.trackerway.com/api/api.php

In addition with the above command, you should add the two below parameters

                    
                                 
                                 
api=user
ver=1.0

So adding up all the above, a proper and complete API command must have the below format in order to return a result:

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY

Get Object List #back to top


Get a list with all your devices.

With the USER_GET_OBJECTS command you have the option to get the list of the GPS Objects you have added in your account. This API command will return in a JSON format various details for each of your devices, like device IMEI, device expiration date, if your device is active and more useful information!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=USER_GET_OBJECTS

Get Object GPRS Command Schedule #back to top

Get a list with all the scheduled GPRS commands for your devices

With the OBJECT_GET_CMDS command you can retrieve the scheduled GPRS commands you have planned to send to your devices. This API command returns the type of the command you chose to send and also the command itself. Note: You must add the IMEI of the device you want to get the result!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_GET_CMDS https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_GET_CMDS,111111111222

Send GPRS Command #back to top

Send a GPRS command to your device on ASCII or HEX format.

With the OBJECT_CMD_GPRS command you can send a GPRS command, either in ASCII or HEX format. In order to run this command, you should add various parameters, which are listed in detail below.Note: At the moment the API service is not replying anything to this command!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_CMD_GPRS,111111111222,TEST,ASCII,"Hello" https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_CMD_GPRS,111111111222,TEST,HEX,Hello

Send SMS Command #back to top

With the OBJECT_CMD_SMS command you can send a SMS command, to your device through the SMS Gateway server. In order to run this command, you should have enabled the SMS gateway in your account. For more details about the SMS Gateway please check here.

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_CMD_SMS,111111111222,TEST,"Hello"

Get Object Location #back to top

With the OBJECT_GET_LOCATIONS command you can easily retrieve the location of your objects, either seperated via IMEI or all your devices at once!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_GET_LOCATIONS,111111111222;111111111222 https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=OBJECT_GET_LOCATIONS,"*"

Get Markers #back to top

With the USER_GET_MARKERS command you can easily retrieve the markers you added in the GPS Tracking software, all at once. This command will return full marker details like: Marker name, description, visibility and more!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=USER_GET_MARKERS

Get Routes #back to top

With the USER_GET_ROUTES command you can easily retrieve the routes you added in the GPS Tracking software, all at once. This command will return full route details like: Route Name, color, deviation, coordinates and more!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=USER_GET_ROUTES

Get Zones #back to top

With the USER_GET_ZONES command you can easily retrieve the zones you added in the GPS Tracking software, all at once. This command will return full zone details like: Zone Name, color, visibility , coordinates and more!

                            
                               
                                
https://track.trackerway.com/api/api.php?api=user&ver=1.0&key=MyKEY&cmd=UUSER_GET_ZONES

Copyright and license #back to top

All rights reserved TrackerWay You can read our Terms of Service here.