GPS Tracking
GPS tracking, All of Highfive Electronics distributors, agents, dealers, clients can get GPS tracking platform service from us, including protocol data and code example, communication program, parameters, and the same time, all can get technology service and support. With these it would like to expand relevant GPS tracking function.
Please contact us for technology support as below:
info@gpstrackercn.com
All customer accounts can be managed and tracked, reported, monitored by dealer’s own GPS tracking platform, and is used and managed by distributors, agents,dealers, clients.
To visit our GPS tracking platform, all distributors, agents, dealers, clients need to get their account and password from us. It would be to obtain access our GPS tracking platform, manage, tracking, monitoring, positioning all of your assets .
Protocol format
Public convention
public attributes of returned data
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| code | int | Yes | result code |
| message | string | No | Code description |
Code explanation
| code | Value | Description |
|---|---|---|
| -1 | -1 | The system is busy |
| 0 | 0 | success |
| 1xxx | 1001 | Parameter error (lack of required parameters or format error). See interface description for details |
| 1002 | Illegal user/illegal device (not their own or subordinate account or device) | |
| 10003 | Repeat operation | |
| 1004 | Illegal access, token exception! (Token failure or nonexistent) | |
| 1005 | Illegal access, ip access exceeds limit! | |
| 1006 | Illegal access, too frequently request! | |
| 1007 | Illegal access, request method error! | |
| 1008 | Illegal access, abnormal incoming! | |
| 41001 | Exceeds maximum geo-fence numbers | |
| 41002 | Fence name already exists! | |
| 41003 | The device is not online | |
| 41004 | Geo-fence operation failed |
Protocol details
Call entry
Call URL of API. All interfaces use this URL.
Authentication
Common parameters
API signature
To prevent the API call hacked by hackers, any API calling needs be with a signature,TOP server will authenticate signature based on request parameters.， Illegal signature request will be rejected.
Get the latest location data based on IMEI
Interface
Get the latest location information for a single or multiple devices
Request URL
HTTP request method
GET/POST
Request parameters
(1)common parameter
(2)private parameters
params list：
| Parameter | Type | Description |
|---|---|---|
| imei | string | Device IMEI |
| device_info | string | Device name |
| icon | string | Vehicle icon |
| status | string | Device status 0, offline; 1, online |
| lat | double | Longitude (if the device expires, the value is 0) |
| lng | double | Latitude (if the device expires, the value is 0) |
| expireFlag | string | Whether expired 1- expired 0 – not expired |
| activationFlag | string | Activate or not 1 – Activate 0 – Not active |
| posType | string | GPS, LBS, WIFI, BEACON |
| locDesc | string | Location information |
| gpsTime | string | GPS positioning time |
| hbTime | string | Heartbeat time |
| speed | string | Speed (unit: km / h) |
| speed | string | ACC 0: off 1: on |
| electQuantity | string | battery（0-100）, Some device models are not supported |
| powerValue | string | External voltage（0-100), Some device models are not supported |
Interface
Single device acquire 2 days track data within 3 months.
Request URL
Method value in common parameters.
HTTP request method
GET/POST
Request parameters
(1)common parameter
(2)private parameters
| Parameter | Type | Required or not | Default value | Description |
|---|---|---|---|---|
| access_token | string | Yes | – | accesstoken: used for identifying legal third party |
| imei | string | Yes | – | Device imei( only 1 each time) |
| begin_time | number | Yes | – | Start time Format: yyyy-MM-dd HH:mm:ss |
| end_time | number | Yes | – | End time Format: yyyy-MM-dd HH:mm:ss end_time should be earlier than current time |
| map_type | string | No | – | If you want to display on Baidu map, the returned latitude and longitude of map_type = BAIDU will be calibrated by baidu calibration
If you want to display on google map, the returned latitude and longitude of map_type=GOOGLE will be calibrated by google calibration. If map_type is null, then return origin latitude and longitude |
Returned value
| Parameter | Type | Description |
|---|---|---|
| code | int | Return code: 0: return correctly Other: failure. Refer to the error code description |
| message | string | If ret is not 0, there will be a corresponding error message |
| result | string | The returned data |
result data list:
| Parameter | Type | Description |
|---|---|---|
| lng | double | longitude |
| lat | double | latitude |
| gps_time | string | GPS positioning time. Format yyyy-MM-dd HH: mm: ss |
| direction | string | direction |
| gpsSpeed | string | GPS speed |
| posType | string | 1. GPS, 2. LBS, 3. WIFI |
Bind and Unbind the user for the device IMEI
Modify vehicle information by IMEI
Interface
Modify vehicle information by IMEI
Request URL
Method value in common parameters.
HTTP request method
POST
Request parameters
(1)common parameter
(2)private parameters
Wifi and base station locating analysis interface
Interface
Request URL
Method value in common parameters
HTTP request method
GET/POST
Request parameters
Interface Create geo-fence for IMEI
Request URL
HTTP request method
POST
Request parameters
Returned value
Delete geo-fence for device IMEI
Interface
Delete geo-fence for device IMEI
Request URL
Method value in common parameters.
HTTP request method
POST
Request parameters
Message push interface
Appendix: Device alarm type
| Parameter | Description |
|---|---|
| 1 | SOS |
| 2 | Power off alarm |
| 3 | Vibration alarm |
| 4 | Enter the geo- fence (terminal) |
| 5 | Leave the geo- fence (terminal) |
| 6 | Speed alarm |
| 9 | Displacement alarm |
| 10 | Into the satellite blind area alarm |
| 11 | Out of the satellite blind area alarm |
| 12 | Power on alarm |
| 13 | GPS first time positioning alarm |
| 14 | External battery low alarm |
| 15 | External low power protection alarm |
| 16 | SIM card change alarm |
| 17 | Shutdown alarm |
| 18 | Flight mode alarm after external battery is low |
| 19 | Tamper alarm |
| 22 | Voice alarm |
| 90 | Low battery alarm |
| 128 | Rearview mirror vibration alarm |
| 192 | Displacement alarm |
| 194 | Low backup battery ala |
| 195 | Boundary violation alarm |
| 1001 | ACC off |
| 1002 | ACC on |
| 1003 | Offline alarm |
| 1004 | Stop alarm |
| 1005 | Stay idle alarm |
| 1006 | Enter geo-fence |
| 1007 | Leave geo-fence |
| 1008 | Outside geo-fence for a long time |
| 1009 | Inside geo-fence for a long time |