0% found this document useful (0 votes)
219 views

Public Convention

This document summarizes an API for a vehicle tracking platform. It describes how dealers can access GPS and vehicle data through the API by authenticating with their dealer account. The API uses JSON over HTTP and returns data including location information, tracking history and vehicle details. It also allows functions like geofencing. Developers must provide credentials to get an access token for authentication when calling API methods.

Uploaded by

Eduardo Correia
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
219 views

Public Convention

This document summarizes an API for a vehicle tracking platform. It describes how dealers can access GPS and vehicle data through the API by authenticating with their dealer account. The API uses JSON over HTTP and returns data including location information, tracking history and vehicle details. It also allows functions like geofencing. Developers must provide credentials to get an access token for authentication when calling API methods.

Uploaded by

Eduardo Correia
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 47

中文 (apiJimi.

html)
Overview
Application

Dealers have their own system and would like to expand relevant GPS function. The customer account of the de
aler is managed by the dealer's own system and is used to log in to the dealer's system. Dealer system account
and the car online platform account is managed by dealer. Dealer use the car online platform account to get the
related data. IMEI is managed by dealer’s own system and dealer can get data by IMEI. Distributor’s application
server calling API.

Usage
To get appKey adn appSecret, distirbutors need to provide their account and password. Calling api interface by
appkey and appSecret to obtain access_token. Distributor use the access_token to acquire data needed to visit
OPEN API in Application Server.

Protocol format

Public convention

Convention
The API use UTC time in default: format yyyy-MM-dd HH:mm:ss
UTF-8 and JSON is used by default.
Context-Type:default application/json charset=utf-8

The API use UTC time in default: format yyyy-MM-dd HH:mm:ss

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). S


ee interface description for details

1002 Illegal user/illegal device (not their own or subordinate account o


r device)

10003 Repeat operation

1004 Illegal access, token exception! (Token failure or nonexistent)

1005 Illegal access, ip access exceeds limit!


code Value Description

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

Transport protocols
HTTP,
Flowchart of communication program

Communication flow

API data flow


API List
Interface typ Method Parameter Na
e me Description

Certification A jimi.oauth.token.get Get access_token


PI

User API jimi.user.child.list Check all subaccount information under the account

User API jimi.user.device.list Check all device information under the account

User API jimi.user.device.location.l Check the latest location information for all devices under the ac
ist count

Device API jimi.device.location.get Get the latest location data based on IMEI

Device API jimi.device.track.list Obtain track data according to IMEI

Device API jimi.open.device.bind Bind users for device IMEI

Device API jimi.open.device.unbind Unbind users for device IMEI

Device API jimi.open.device.update Modify the vehicle information for the equipment IMEI

Geo-fence AP jimi.open.device.fence.cr Wifi, base station location analysis


I eate

Geo-fence AP jimi.open.device.fence.d Create an geo fence for the device IMEI


I elete

LBS-API jimi.lbs.address.get Remove the geo fence for the device IMEI

Message jimi.push.device.alarmt Push alerts notification

Protocol details
Call entry

Call URL of API. All interfaces use this URL.

Call environment (HTTP)

Overseas formal environment http://open.10000track.com/route/rest

Authentication

User get access_token by appkey and appSecret, which are provided by JIMI platform. Incoming appkey and ac
cess_token needed and request parameters should be signed when call API. JIMI server will authenticate the re
quest parameters.

Common params

Required or Value descri Default valu


Name Type not Description ption es

method String Yes API interface name

timestamp String Yes Timestamp, format:yyyy-


MM-dd HH:mm:ss. Plus
or minus10 minutes is all
owed. e.g:2012-03-25 2
0:00:00
Required or Value descri Default valu
Name Type not Description ption es

app_key String Yes APP_KEY distributed by Correspond t


JIMI o company le
vel, only one

sign String Yes API input parameters sig


nature result

sign_method String No Optional, specify the sig md5 md5


nature method. System
default md5, support met
hods are: md5

v String No Optional, specify the API 1.0 1.0


version. System default
1.0, support version: 1.0

format String No Optional, specify respon json


se format. default::json

API signature

To prevent the API call hacked by hackers, any API calling needs be with a signature,TOP server will authentica
te signature based on request parameters., Illegal signature request will be rejected. Signature algorithms sup
ported by TOP are: MD5 (sign_Method value in common parameters ismd5). The general process of signature i
s as follows:

Sample
Sort all API requested parameters based on ASCII of parameters names (including common parameters
and business parameters, but excluding sign and byte parameter. For example: foo=1, bar=2, foo_bar=3, f
oobar=4. Order sorted is bar=2, foo=1, foo_bar=3, foobar=4

Put all parameter names and values together, the result is bar2foo1foo_bar3foobar4。
The assembled string use utf-8 encoding. Use signature algorithm to abstract compiled byte stream . If use the
MD5 algorithm, you need to add app and secret before abstract. E.g:md5(secret+bar2foo1foo_bar3foobar4+se
cret);
Byte stream is showed in hexadecimal. For example:hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F7
26C64”

Description: MD5 is the 128-bit summary algorithm and is in hexa


decimal. a hexadecimal character can represent four bits, so the
signature string length is 32 hexadecimal characters.
JAVA code example:

Algorithm
public static String signTopRequest(Map params, String secret, String signMethod) throws IOExce
// 1:Check whether the parameters have been sorted
String[] keys = params.keySet().toArray(new String[0]);
Arrays.sort(keys);

// 2:: Put all parameter names and parameter values together


StringBuilder query = new StringBuilder();
if (Constants.SIGN_METHOD_MD5.equals(signMethod)) {
query.append(secret);
}
for (String key : keys) {
String value = params.get(key);
if (StringUtils.areNotEmpty(key, value)) {
query.append(key).append(value);
}
}

// 3: use MD5/HMAC to encrypt


byte[] bytes;
if (Constants.SIGN_METHOD_HMAC.equals(signMethod)) {
bytes = encryptHMAC(query.toString(), secret);
} else {
query.append(secret);
bytes = encryptMD5(query.toString());
}

// 4: convert binary to uppercase hexadecimal


return byte2hex(bytes);
}

public static byte[] encryptHMAC(String data, String secret) throws IOException {


byte[] bytes = null;
try {
SecretKey secretKey = new SecretKeySpec(secret.getBytes(Constants.CHARSET_UTF8), "HmacM
Mac mac = Mac.getInstance(secretKey.getAlgorithm());
mac.init(secretKey);
bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
} catch (GeneralSecurityException gse) {
throw new IOException(gse.toString());
}
return bytes;
}

public static byte[] encryptMD5(String data) throws IOException {


return encryptMD5(data.getBytes(Constants.CHARSET_UTF8));
}

public static String byte2hex(byte[] bytes) {


StringBuilder sign = new StringBuilder();
for (int i = 0; i < bytes.length; i++) {
String hex = Integer.toHexString(bytes[i] & 0xFF);
if (hex.length() == 1) {
sign.append("0");
}
sign.append(hex.toUpperCase());
}
return sign.toString();
}

Get accesstoken

Interface
Obtain accesstoken which is valid within 2 hours.

Request URL
Method value in common parameters is method的值为jimi.oauth.token.get

HTTP request method


GET/POST

Request parameter
(1)common parameter
See: common parameter
(2)private parameters

Required or Parameter Descri Value descri Default valu


Name Type not ption ption e

user_id String Yes User ID

user_password_m String Yes MD5 of user ID pas commons-co MD5 result is


d5 sword dec.jar Digest lowercase
Utils.md5Hex
(pwd.getBety
());

expires_in number Yes access token validi 60-7200


ty period. Unit:seco
nds

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


Parameter Type Description

result String Result

accessToken string accesstoken of following interface, which corresponds to the company


account

expiresIn string validity

account string account requested

appKey string APP_KEY distributed by JIMI

Correct return example:

{
"code": 0,
"message": "success",
"result": {
"appKey": "8FB345B8693CCD003CC2DAB61EC8791D",
"account": "jimitest",
"accessToken": "7da3330ec28e3996b6ef4a7e3390ba71",
"expiresIn": 60
}
}

Wrong return example:

{"code":xxx,"message":"Incorrect username or password"}

Acquire all sub-account information


Interface
Query all sub-account information.

Request URL
Method value in common parameters is jimi.user.child.list

HTTP request method

GET/POST

Request parameters
(1)common parameter
See: common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes - accesstoken: used for identifying legal thir


d party

target string Yes - User account inquired ( account or sub-ac


count used for acquiring token)

Returned value

Parameter Type Description


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 parameters

Result params list:

Parameter Type Description

account string log in account

name string name

type int Account Type 3:end user 8:tier-1 distributor 9:ordinary users
10:ordinary distributor 11:sales

displayFlag Int Available or not (1:Available,0:not available)

address string location

birth string birthday

companyName string Company Name

email string mailbox

phone string contact number

language string Language (zh,en)

sex int Gender 0 male,1 female


Parameter Type Description

enabledFlag int Flag:1 Available, 0not available

remark string Remark

Correct return example:

{
"code": 0,
"message": "success",
"result": [
{
"account": "123123",
"name": "测试",
"type": 8,
"displayFlag": 1,
"address": null,
"birth": "2017-04-22 00:00:00",
"companyName": "",
"email": "",
"phone": "",
"language": "zh",
"sex": 0,
"enabledFlag": 1,
"remark": null
}
]
}

Wrong return example:

{"code":xxx,"message":"The account does not exist"}


Acquire all sub-account IMEI information

Interface
Query all sub-account device information

Request URL
Method value in common parameters is jimi.user.device.list

HTTP request method

GET/POST

Request parameters
(1)common parameter
See: common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

target string Yes - User account enquired ( account or sub-a


ccount used for acquiring token)

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 params list:

Parameter Type Description

imei String Device IMEI

deviceName String Device name

mcType String Device model

mcTypeUseScope String Automobile, electromobile, personal, pet, plane, others

sim String Sim card number

expiration String Expire date

activationTime String Activation time

reMark String Remarks

vehicleName String Vehicle name

vehicleIcon String Vehicle icon

vehicleNumber String License plate number


Parameter Type Description

vehicleModels String Brand

carFrame String Frame number

driverName String Driver name

driverPhone String Driver phone number

enabledFlag int Available or not (1:Available,0:not available)

engineNumber String Motor engine number

Correct return example:


{
"code": 0,
"message": "success",
"result": [
{
"imei": "868120145233604",
"deviceName": "868120145233604",
"mcType": "GT300L",
"mcTypeUseScope": "personal",
"sim": "415451",
"expiration": "2037-04-01 23:59:59",
"activationTime": "2017-04-01 11:02:20",
"reMark": "test",
"vehicleName": null,
"vehicleIcon": "bus",
"vehicleNumber": "1CW591",
"vehicleModels": null,
"carFrame": "2235",
"driverName": "driver",
"driverPhone": "13825036579",
"enabledFlag": 1,
"engineNumber": "8565674"
}
]
}

Wrong return example:

{"code":xxx,"message":"Account queried doesn’t exist"}

Obtain latest location information of IMEI based on t


he account
Interface
Get the latest location information for all devices under an account name

Request URL
Method value in common parameters is jimi.user.device.location.list

HTTP request method

GET/POST

Request parameters
(1)common parameter
See: common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

target string Yes - User account enquired ( account or sub-a


ccount used for acquiring token)
Required or Default valu
Parameter Type not e Description

map_type string No - If you want to display on Baidu map, the r


eturned latitude and longitude of map_typ
e = BAIDU will be calibrated by baidu cali
bration

If you want to display on google map, the


returned latitude and longitude of map_ty
pe=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 The return
ed data

result string The returned data

result数据:

Parameter Type Description

imei string Device IMEI


Parameter Type Description

deviceName 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 Expired or not: 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

string string Speed (unit: km / h)

accStatus string ACC 0: OFF 1: ON

electQuantity string Device battery (0-100), some models are not supported

powerValue string External voltage(0-100), some models are not supported

Correct return example:


{
"code": 0,
"message": "success",
"result": [
{
"imei": "868120145233604",
"deviceName": "868120145233604",
"icon": "bus",
"status": "0",
"posType": "GPS",
"lat": 22.577282,
"lng": 113.916604,
"hbTime": "2017-04-26 09:14:50",
"accStatus": "0",
"speed": "0",
"gpsTime": "2017-04-26 09:17:46",
"activationFlag": "1",
"expireFlag": "1",
"electQuantity": "60",
"locDesc": null
}
]
}

Wrong return example:

{"code":xxx,"message":"The account does not exist"}

Get the latest location data based on IMEI

Interface
Get the latest location information for a single or multiple devices

Request URL
Method value in common parameters is jimi.device.location.get

HTTP request method

GET/POST

Request parameters
(1)common parameter
See:common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imeis string Yes - Device IMEI. Separate imei by comma; P


OST is recommended if too many devices
(maximum 100 IMEI)
Required or Default valu
Parameter Type not e Description

map_type string Yes - If you want to display on Baidu map, the r


eturned latitude and longitude of map_typ
e = BAIDU will be calibrated by baidu cali
bration

If you want to display on google map, the


returned latitude and longitude of map_ty
pe=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 params list:

Parameter Type Description

imei string Device IMEI

device_info string Device name


Parameter Type Description

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

Correct return example:


{
"code": 0,
"message": "success",
"result": [
{
"imei": "868120145233604",
"deviceName": "868120145233604",
"icon": "bus",
"status": "0",
"posType": "GPS",
"lat": 22.577282,
"lng": 113.916604,
"hbTime": "2017-04-26 09:14:50",
"accStatus": "0",
"speed": "0",
"gpsTime": "2017-04-26 09:17:46",
"activationFlag": "1",
"expireFlag": "1",
"electQuantity": "60",
"locDesc": null
}
]
}

Wrong return example:

{"code":xxx,"message":"Illegal device"}

Get the track data based on IMEI

Interface
Single device acquire 2 days track data within 3 months.。

Request URL
Method value in common parameters is jimi.device.track.list

HTTP request method

GET/POST

Request parameters
(1)common parameter
See:common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes - accesstoken: used for identifying legal thir


d party

imei string Yes - Device imei( only 1 each time)

begin_time number Yes - Start time Format: yyyy-MM-dd HH:mm:s


s

end_time number Yes - End time Format: yyyy-MM-dd HH:mm:ss


end_time should be earlier than current ti
me
Required or Default valu
Parameter Type not e Description

map_type string No - If you want to display on Baidu map, the r


eturned latitude and longitude of map_typ
e = BAIDU will be calibrated by baidu cali
bration

If you want to display on google map, the


returned latitude and longitude of map_ty
pe=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


Parameter Type Description

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

Correct return example:

{
"code": 0,
"message": "success",
"result": [
{
"lat": 22.577144898887813,
"lng": 113.91674845964586,
"gpsTime": "2017-04-26 00:00:58",
"direction": 0,
"gpsSpeed": -1,
"posType": 3
},
{
"lat": 22.57708,
"lng": 113.916631,
"gpsTime": "2017-04-26 00:01:30",
"direction": 184,
"gpsSpeed": 0,
"posType": 1
}
]
}
Wrong return example:

{"code":xxx,"message":"IMEI does not exist{353419031939627}"}

{" code ":xxx,"message":"The device has expired{353419031939627}"}

Bind the user for the device IMEI

Interface
Bind user by IMEI。

Request URL

Method value in common parameters is jimi.open.device.bind

HTTP请求方式

POST

Request parameters
(1)common parameter
See:common parameter
(2)private parameters
Required or Default valu
Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imei string Yes - Device imei

user_id string Yes - Bound user account, which must be termi


nal account

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

Correct return example:

{
"code": 0,
"message": "Bind user success",
"result": null
}

Wrong return example:

{"code":xxx,"message":"The device is already bound to another user"}


Unbind users for device IMEI

Interface
Unbind the user by IMEI

Request URL

Method value in common parameters is jimi.open.device.unbind

HTTP request method

POST

Request parameters
(1)common parameter
See:common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imei string Yes - Device imei

user_id string Yes - Original bound user account


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

Correct return example:

{
"code": 0,
"message": "Unbound success",
"result": null
}

Wrong return example:

{"code":xxx,"message":"unauthorized user"}

Modify vehicle information by IMEI

Interface
Modify vehicle information by IMEI

Request URL
Method value in common parameters is jimi.open.device.update

HTTP request method

POST

Request parameters
(1)common parameter
See:common parameter
(2)private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying le


gal third party

imei string Yes - Device IMEI

device_name string No - Device name

vehicle_name string No - Vehicle name

vehicle_icon string No - Vehicle icon

vehicle_number string No - Vehicle plate number

vehicle_models string No - Vehicle brand

driver_name string No - Driver name

driver_phone string No - Driver phone


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

Correct return example:

{
"code": 0,
"message": "Modify device vehicle information successfully",
"result": null
}

Wrong return example:

{"code":xxx,"message":"imei doesn’t exists"}

Wifi, base station locating analysis interface

Interface
Allocate by total devices under the account (10 times/day/device. All sub-accounts included)
Request URL
Method value in common parameters is jimi.lbs.address.get

HTTP request method

GET/POST

Request parameters
(1)common parameter
See:common parameter
(2)Private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imei number Yes - Device Imei

lbs number No - (wifi/LBS: at least one) LBS inforamtio


n group (mcc,mnc,lac,cell,rssi), max 7.
Each group has five, which should not be
null and sorted in order. MCC, China: 460
MNC LAC information, 2312 23222 CELL
code: 23222 RSSI Semaphore-70

Wifi string No - (wifi/LBS: at least one) mac1,rssi1| ma


c2,rssi2 Mac address, no colon in betwee
n. Rssi signal strength
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 params list:

Parameter Type Description

lng string longitude

lat string latitude

accuracy string Accuracy, the greater the value the better

Correct return example:

{
"code": 0,
"message": "success",
"result": {
"lat": 40.65615416521587,
"lng": 109.89894039833524,
"accuracy": 0
}
}
Wrong return example:

{"code":xxx,"message":"illegal device"}

Create geo-fence for IMEI

Interface
Create geo-fence for IMEI

Request URL

Method value in common parameters is jimi.open.device.fence.create

HTTP request method

POST

Request parameters
(1)common parameter
See: common parameter
(2)Private parameters

Required or Default valu


Parameter Type not e Description
Required or Default valu
Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imei string Yes - Device Imei

fence_name string Yes - Geo-fence name

alarm_type string Yes - Alarm type (in / out / in, out)

report_mode string Yes - Alarm reporting mode, 0: GPRS,1:SM


S+GPRS

alarm_switch string Yes - Fence alarm switch(ON/OFF)

lng string Yes - Longitude

lat string Yes - latitude

radius string Yes - Fence radius(1~9999;unit: 100 meters)

zoom_level string Yes - Zoom level (3-19)

map_type string Yes - Map (BAIDU / GOOGLE)

Returned value

Parameter Type Description

code int Return code: 0: return correctly Other: failure. Refer to the error code
description If ret is not 0, there will be a corresponding error message
The returned data
Parameter Type Description

message string If ret is not 0, there will be a corresponding error message

result string The returned data. Fence serial number returned if succeed.

Correct return example:

{
"code": 0,
"message": "Successfully create geo-fence.",
"result": "5"
}

Wrong return example:

{
"code": 41003,
"message": "Device is not online, geo-fence creation failed ",
"result": null
}

Delete geo-fence for device IMEI

Interface
Delete geo-fence for device IMEI

Request URL
Method value in common parameters is jimi.open.device.fence.delete

HTTP request method

POST

Request parameters
(1)common parameter
See:common parameter
(2)Private parameters

Required or Default valu


Parameter Type not e Description

access_token string Yes accesstoken: used for identifying legal thir


d party

imei string Yes - Device imei

instruct_no string Yes - Geo-fence command serial number

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


Parameter Type Description

result string The returned data

Correct return example:

{
"code": 0,
"message": "delete the geo fence successfully",
"result": null
}

Wrong return example:

{
"code": 41003,
"message": "The device is not online and geo-fence can’t be deleted",
"result": null
}

Message push interface

Interface
Third-party platform provide the url address to receive message while JIMI platform call the url request to send d
ata.

Message service List


Message service Description

jimi.push.device.alarm Alarm data

Content pushed:

Parameter Type Description

msgType String Message type, corresponding to the message service list

data String The content of the message, corresponding to msgType

Alarm push ( jimi.push.device.alarm )


Alarms pushed are as follows:

Parameter Type Description

imei string Device imei

deviceName string Device name

alarmType string Alarm type

alarmName string Alarm name

lat string Latitude

lng string Longitude

alarmTime string Alarm time, format (yyyy-MM-dd HH: mm: ss)

E.g:
{
"msgType": "jimi.push.device.alarm",
"data": {
"imei": "868120145233604",
"deviceName": "868120145233604",
"alarmType": "2",
"alarmName": "Power off alarm",
"lat": 40.65615416521587,
"lng": 109.89894039833524,
"alarmTime": "2017-05-08 12:00:00"
}
}

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


Parameter Description

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 alarmm

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


Parameter Description

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

You might also like