English概述

使用场景

经销商自己有一套系统，想在这个基础上扩充相关GPS功能。
经销商的客户的账号由经销商自己的系统管理，用于登录经销商的系统。
经销商系统的账号和汽车在线平台的账号对应关系，经销商自己管理，经销商使用汽车在线平台的账号来获取相应设备数据。
设备IMEI一般都会在出货前导入平台，导入到经销商账号后由经销商自己的系统管理，经销商可根据imei获取设备数据。 经销商的应用服务器调用API接口获取相应数据后自行处理。
注：WGS84经纬度显示在相应地图需要转换坐标，请查看第三方地图接口，如高德开放平台。

使用方法

经销商提供他的几米平台登录账号、密码、邮箱和营业执照照片给业务申请appKey，appSecret 通过appkey、appSecret调用api接口获取访问令牌(access_token)。 经销商在应用服务器端使用该access_token访问Open Api接口获取所需的数据。

协议格式

公共约定

约定

服务器默认采用UTF-8编码，数据采用JSON格式
请求：Context-Type:application/x-www-form-urlencoded
响应：Context-Type:application/json charset=utf-8
时间统一采用UTC时间，国内是北京时间，格式yyyy-MM-dd HH:mm:ss
国外环境，时间是零时区UTC时间，格式yyyy-MM-dd HH:mm:ss
                    

返回数据公共属性

Code解释

业务错误码

通信流程

API数据流程

API列表

接口调用限制/频次说明

协议详情

调用入口

调用 API的服务URL地址，文档中所有接口都使用该url访问

认证

由几米服务平台给出API连接地址、有效的appkey和appSecret，用户通过 appkey、appSecret
获取 access_token。 调用API时传入 appkey和access_token，并对请求参数进行签名，几米服务器端会验证
请求参数是否合法。
注：通用参数“v”选择0.9，不验证签名。

通用参数

API签名

public static String signTopRequest(Map params, String secret, String signMethod) throws IOException {
    // 第一步：检查参数是否已经排序
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);
 
    // 第二步：把所有参数名和参数值串在一起
    StringBuilder query = new StringBuilder();
    if ("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);
        }
    }
 
    // 第三步：使用MD5/HMAC加密
    byte[] bytes;
    if ("hmac".equals(signMethod)) {
        bytes = encryptHMAC(query.toString(), secret);
    } else {
        query.append(secret);
        bytes = encryptMD5(query.toString());
    }
 
    // 第四步：把二进制转化为大写的十六进制
    return byte2hex(bytes);
}
 
public static byte[] encryptHMAC(String data, String secret) throws IOException {
    byte[] bytes = null;
    try {
        SecretKey secretKey = new SecretKeySpec(secret.getBytes("UTF-8"), "HmacMD5");
        Mac mac = Mac.getInstance(secretKey.getAlgorithm());
        mac.init(secretKey);
        bytes = mac.doFinal(data.getBytes("UTF-8"));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}
 
public static byte[] encryptMD5(String data) throws IOException {
    return encryptMD5(data.getBytes("UTF-8"));
}

private static byte[] encryptMD5(byte[] bytes) throws IOException {
	MessageDigest md = null;
	try {
		md = MessageDigest.getInstance("MD5");
	} catch (NoSuchAlgorithmException e) {
		throw new IOException(e.toString());
	}
	return md.digest(bytes);
}
 
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();
}
                            

#import "JAVAToOC.h"
#import <CommonCrypto/CommonDigest.h>
@implementation JAVAToOC

+ (NSString *)signToRequest:(NSDictionary *)params
                     secret:(NSString *)secret
                 signMethod:(NSString *)signMethod
{
    
    //第一步：参数按ASCII码表排序
    NSArray *keys = params.allKeys;
    
    NSStringCompareOptions comparisonOptions =NSCaseInsensitiveSearch|NSNumericSearch|
    NSWidthInsensitiveSearch|NSForcedOrderingSearch;
    NSComparator sort = ^(NSString *obj1,NSString *obj2){
        NSRange range =NSMakeRange(0,obj1.length);
        return [obj1 compare:obj2 options:comparisonOptions range:range];
    };
    NSArray *keysSort = [keys sortedArrayUsingComparator:sort];
   
    //第二步：把所有参数名和参数串在一起
    NSMutableString *appendStr = [[NSMutableString alloc] init];
    if ([@"md5" isEqualToString:signMethod]) {
        [appendStr appendString:secret];
    }
    
    for (NSString *key in keysSort) {
        NSString *value = params[key];
        if (value) {
            [appendStr appendString:[NSString stringWithFormat:@"%@%@",key,value]];
        }
    }
    // 第三步：使用MD5加密
    [appendStr appendString:secret];
    NSString *md5Result = [self md5HexDigest:appendStr];
    
    return md5Result;
}

//MARK - md5加密
+ (NSString *) md5HexDigest:(NSString *)str
{
    const char *original_str = [str UTF8String];
    unsigned char result[CC_MD5_DIGEST_LENGTH];
    CC_MD5(original_str, strlen(original_str), result);
    NSMutableString *hash = [NSMutableString string];
    for (int i = 0; i < 16; i++)
    [hash appendFormat:@"%02X", result[i]];
    return [hash uppercaseString];
}

@end
                            

API调用示例

获取accesstoken

接口说明

获取后续访问接口的令牌，1分钟内只能访请求1次，在有效期内访问token不变。

请求URL

本接口通用参数里面method的值为jimi.oauth.token.get

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB123456789",
    "account": "jimitest",
    "accessToken": "7da3330ec28e3996b6ef4a7123456789",
    "expiresIn": 60,
    "refreshToken": "7da3330ec28e3996b6ef4a7123456789",
    "time": "2017-06-15 10:00:00"
  }
}
                    

错误返回示例：

{"code":xxx,"message":"账号或密码错误"}

刷新accesstoken

接口说明

该接口用于在accessToken即将失效时，通过该接口强制更新令牌，1分钟内只能访请求1次。

请求URL

本接口通用参数里面method的值为jimi.oauth.token.refresh

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
   

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB123456789",
    "account": "jimitest",
    "accessToken": "7da3330ec28e3996b6ef4a7123456789",
    "expiresIn": 60,
    "refreshToken": "7da3330ec28e3996b6ef4a7123456789",
    "time": "2017-06-15 10:00:00"
  }
}
                    

错误返回示例：

{"code":xxx,"message":"非法请求，token无效"}

创建平台账号

接口说明

为指定账号创建子账号。

请求URL

本接口通用参数里面method的值为jimi.user.child.createPlatformUsers

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
   

返回值

正确返回示例：

{
  "code": 0,
  "message": "添加成功",
  "result": null
}
                    

错误返回示例：

{"code":12001,"message":"创建用户失败，结果码：213"}

根据账户，获取该账户下的所有子账户信息

接口说明

查询账号下的所有子账户信息。

请求URL

本接口通用参数里面 method的值为jimi.user.child.list

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "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
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"查询的账号不存在"}

根据账户，获取该账户下的所有IMEI信息

接口说明

查询账户下所有设备信息。

请求URL

本接口通用参数里面method的值为jimi.user.device.list

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表：

正确返回示例：

{
  "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": "粤B3604",
      "vehicleModels": null,
      "carFrame": "2235",
      "driverName": "driver",
      "driverPhone": "13825036579",
      "enabledFlag": 1,
      "engineNumber": "8565674"
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"查询的账号不存在"}

根据账户，获取该账户下所有IMEI的最新定位数据

接口说明

获取一个账户名下所有设备最新位置信息。

请求URL

本接口通用参数里面method的值为jimi.user.device.location.list

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result数据:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
        "imei":"201912260011110",
        "deviceName":"GT300L++-11110",
        "icon":"automobile",
        "status":"1",
        "posType":"GPS",
        "lat":22.579998960919067,
        "lng":113.92774687675565,
        "hbTime":"2019-12-26 22:47:07",
        "accStatus":"1",
        "powerValue":null,
        "powerStatus":"1",
        "speed":"94",
        "gpsTime":"2019-12-26 20:48:58",
        "activationFlag":"1",
        "expireFlag":"1",
        "electQuantity":"100",
        "locDesc":null,
        "mileage":null
    },
    {
        "imei":"869354040542244",
        "deviceName":"GT300FZ+-42244",
        "icon":"automobile",
        "status":"0",
        "posType":"LBS",
        "lat":22.580009603951005,
        "lng":113.92818862706419,
        "hbTime":"2019-11-19 18:42:27",
        "accStatus":"0",
        "powerValue":null,
        "powerStatus":"0",
        "speed":null,
        "gpsTime":"2019-11-19 18:35:54",
        "activationFlag":"1",
        "expireFlag":"1",
        "electQuantity":"100",
        "locDesc":null,
        "mileage":"8983728.82476919"
    }
]
}
                    

错误返回示例：

{"code":xxx,"message":"查询的账号不存在"}

根据IMEI获取最新定位数据

接口说明

获取单个或多个设备最新的位置信息

请求URL

本接口通用参数里面method的值为jimi.device.location.get

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "201801090000053",
      "deviceName": "GT320-00053",
      "icon": "automobile",
      "status": "1",
      "posType": "GPS",
      "lat": 22.58474332760045,
      "lng": 113.94101783150425,
      "hbTime": "2019-01-18 15:32:43",
      "accStatus": "1",
      "powerValue": null,
      "speed": "82",
      "gpsTime": "2019-01-18 15:25:44",
      "activationFlag": "1",
      "expireFlag": "1",
      "electQuantity": "100",
      "locDesc": null
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"查询的账号不存在"}

根据IMEI查询数据

接口说明

获取单个或多个设备最新的位置信息

请求URL

本接口通用参数里面method的值为jimi.device.location.getByImei

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
        "imei": "201901151234568",
        "status": "0",
        "lat": 22.58202343477221,
        "lng": 113.93004104938407,
        "posType": "GPS",
        "gpsTime": "2019-01-29 16:40:04",
        "hbTime": "2019-01-29 16:42:51",
        "speed": "20",
        "gpsSignal": "3",
        "direction": "西北向(方向数:332)",
        "mileage": "267103.63141907065",
        "gpsNum": "11",
        "powerStatus": "1"
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

根据IMEI获取设备详细信息

接口说明

获取单个或多个设备的详细信息

请求URL

本接口通用参数里面method的值为jimi.open.device.getDetails

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "987456123012358",
      "deviceName": "123456788012354ui",
      "account": "jimitest",
      "activationTime": "2016-10-27 11:44:29",
      "expiration": "2036-10-27 11:44:29",
      "mcType": "ET200",
      "sim": "22",
      "bindUserAccount": null,
      "status": "NORMAL",
      "driverPhone": "25",
      "vehicleIcon": "taxi",
      "equipType": null,
      "mcTypeUseScope": "electromobile",
      "reMark": "123456788012354",
      "sn": "123456788012354",
      "vehicleName": null,
      "vehicleNumber": "123456788012354u",
      "vehicleModels": null,
      "carFrame": "123456788012354",
      "driverName": "是",
      "idCard": "123456788012354",
      "engineNumber": "123456788012354",
      "installTime": null,
      "installAddress": "123456788012354",
      "installCompany": "123456788012354",
      "installPosition": "123456788012354",
      "installPersonnel": "123456788012354",
      "installImage": "",
      "salesMan": null
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

根据IMEI获取设备ODB车况，故障信息

接口说明

获取单个或多个设备的ODB车况，故障信息

时间跨度不超过90天的数据。

请求URL

本接口通用参数里面method的值为jimi.open.device.getObdVehicleCondition

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "batteryVoltage": 13,
      "rotatingSpeed": 0,
      "gpsSpeed": 0,
      "engineLoad": 0,
      "throttlePosition": 0,
      "waterTemperature": 89,
      "fuelConsumption2": 0,
      "fuelConsumption1": 0,
      "oilPer": 0,
      "acc": 0,
      "idleTime": 0,
      "maxSpeed": 0,
      "gpsLen": 0,
      "gpsInfo": 0,
      "lat": 0,
      "lng": 0,
      "speed": 0,
      "gpsMode": 0,
      "positionStatus": 0,
      "direction": "正北向(方向数:0)"
    },
    {
      "batteryVoltage": 13,
      "rotatingSpeed": 0,
      "gpsSpeed": 0,
      "engineLoad": 0,
      "throttlePosition": 0,
      "waterTemperature": 89,
      "fuelConsumption2": 0,
      "fuelConsumption1": 0,
      "oilPer": 0,
      "acc": 0,
      "idleTime": 0,
      "maxSpeed": 0,
      "gpsLen": 0,
      "gpsInfo": 0,
      "lat": 0,
      "lng": 0,
      "speed": 0,
      "gpsMode": 0,
      "positionStatus": 0,
      "direction": "正北向(方向数:0)"
    },
    {
      "batteryVoltage": 13,
      "rotatingSpeed": 0,
      "gpsSpeed": 0,
      "engineLoad": 0,
      "throttlePosition": 0,
      "waterTemperature": 89,
      "fuelConsumption2": 0,
      "fuelConsumption1": 0,
      "oilPer": 0,
      "acc": 0,
      "idleTime": 0,
      "maxSpeed": 0,
      "gpsLen": 0,
      "gpsInfo": 0,
      "lat": 0,
      "lng": 0,
      "speed": 0,
      "gpsMode": 0,
      "positionStatus": 0,
      "direction": "正北向(方向数:0)"
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

获取打卡统计

接口说明

根据imei号,开始时间和结束时间

时间跨度不超过90天的数据。

请求URL

本接口通用参数里面method的值为jimi.open.device.getClock

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "201801030929012",
      "posMode": 1,
      "clockType": 1,
      "lat": 39.92839,
      "lng": 119.539592,
      "addr": "河北省秦皇岛市海港区汨罗江道1号,天河铝塑板厂南174米",
      "gpsTime": "2019-09-09 09:47:24"
    },
    {
      "imei": "201801030929012",
      "posMode": 1,
      "clockType": 2,
      "lat": 39.918617,
      "lng": 119.477338,
      "addr": "河北省秦皇岛市海港区潘阳湖路,津秦客运专线西北137米",
      "gpsTime": "2019-09-09 09:47:24"
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

根据IMEI获取轨迹数据

接口说明

允许有线设备获取三个月内，时间跨度不超过2天的轨迹数据。

允许无线设备获取三个月内，时间跨度不超过60天的轨迹数据。

请求URL

本接口通用参数里面 method的值为jimi.device.track.list

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result数据列表:

正确返回示例：

{
  "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
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"IMEI不存在{353419031939627}"}

{" code ":xxx,"message":"该设备已过期{353419031939627}"}

为设备IMEI修改车辆信息

接口说明

提供通过设备imei号更改车辆信息。

请求URL

本接口通用参数里面 method的值为jimi.open.device.update

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "修改设备车辆信息成功",
  "result": null
}
                    

错误返回示例：

{"code":xxx,"message":"设备imei不存在"}

转移设备

接口说明

将账号上的设备转移到下级账号上。

请求URL

本接口通用参数里面 method的值为jimi.open.device.move

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "转移设备成功",
  "result": null
}
                    

错误返回示例：

{"code":12002,"message":"转移设备失败，结果码：217"}

获取设备支持的指令列表

接口说明

获取指定设备机型支持的指令列表。
注：不同型号的设备指令表不一样，获取到的指令列表是后台平台配置好，可以通过此接口下发给设备的，另可跟业务人员要相关型号指令表文档，辅助理解，接口不支持自定义指令。

请求URL

本接口通用参数里面 method的值为jimi.open.instruction.list

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "id": 81,
      "orderName": "SOS设置",
      "orderContent": "SOS,A,{0},{1},{2}#",
      "orderExplain": "SOS号码用于接收报警短信以及接收SOS报警，支持3~20位数字SOS号码设置",
      "orderMsg": "",
      "isOffLine": "1"
    }
	...
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

指定设备发送指令

接口说明

给指定设备发送指令。

请求URL

本接口通用参数里面 method的值为jimi.open.instruction.send

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

inst_param_json参数说明

inst_param_json参数示例：
{\"inst_id\":\"81\", \"inst_template\":\"SOS,A,{0},{1},{2}#\", \"is_cover\": false, \"params\":[\"13243\",\"13241\"]}

返回值

正确返回示例：

{
  "code": 0,
  "message": "发送指令成功",
  "result": null
}
                    

错误返回示例：

{"code": 12005,"message": "下发指令失败，结果码：226","result": null}

获取设备指令结果

接口说明

获取设备已发送的指令结果。

请求URL

本接口通用参数里面 method的值为jimi.open.instruction.result

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "codeId": "99",
      "code": "status#",
      "content": "参数错误",
      "isExecute": "4",
      "sendTime": "2017-06-19 11:46:00",
      "sender": "jimitest",
      "receiveDevice": "868120111111117",
      "isOffLine": "1",
      "idsource": "自定指令"
    }
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法设备"}

为设备IMEI创建电子围栏

接口说明

为设备imei创建一个电子围栏信息

请求URL

本接口通用参数里面method的值为jimi.open.device.fence.create

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "创建电子围栏成功",
  "result": "5"
}
                    

错误返回示例：

{
  "code": 41003,
  "message": "设备不在线，无法创建电子围栏",
  "result": null
}
                    

为设备IMEI删除电子围栏

接口说明

为设备imei删除一个电子围栏信息

请求URL

本接口通用参数里面method的值为jimi.open.device.fence.delete

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "删除电子围栏成功",
  "result": "5"
}
                    

错误返回示例：

{
  "code": 41003,
  "message": "设备不在线，无法删除电子围栏",
  "result": null
}
                    

获取设备电子围栏信息

接口说明

查询设备已设置的电子围栏记录

请求URL

本接口通用参数里面method的值为jimi.open.device.fence.get

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "456789123456801",
      "fenceName": "11111111111",
      "instructNo": "1",
      "alarmType": "in,out",
      "radius": "5344",
      "mapType": "baidu",
      "zoomLevel": "12",
      "lat": 22.6969,
      "lng": 113.988498,
      "gpsLat": 22.693452554454886,
      "gpsLng": 113.97709023148917,
	  " instructCode":255
    },
    {
      "imei": "456789123456801",
      "fenceName": "1111223",
      "instructNo": "2",
      "alarmType": "in,out",
      "radius": "4191",
      "mapType": "baidu",
      "zoomLevel": "12",
      "lat": 22.613654,
      "lng": 113.998272,
      "gpsLat": 22.610193418762954,
      "gpsLng": 113.98684308538836,
	 " instructCode":255
    }]
}

                    

创建平台围栏

接口说明

为设备imei创建一个平台围栏信息（一个imei最多创建20个平台围栏；围栏名称不可包含特俗字符；围栏名称不可重复）

请求URL

本接口通用参数里面method的值为jimi.open.plat.fence.create

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "成功",
  "result": "01013fa931464dd792596c8194b93a11"
}
                    

错误返回示例：

{
  "code": 12008,
  "message": "围栏超过创建个数",
  "result": null
}
                    

删除平台围栏

接口说明

删除平台围栏信息

请求URL

本接口通用参数里面method的值为jimi.open.plat.fence.delete

HTTP请求方式

POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "成功",
  "result": null
}
                    

错误返回示例：

{
  "code": 12012,
  "message": "删除围栏失败",
  "result": null
}
                    

查询平台围栏

接口说明

查询平台围栏信息

请求URL

本接口通用参数里面method的值为jimi.open.plat.fence.query

HTTP请求方式

GET

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
    "code":0,
    "data":[
        {
            "imei":"201902270000991",
            "fenceName":"20190404135126",
            "fenceShape":"circle",
            "status":"",
            "lng":113.92678,
            "lat":22.594122,
            "gpsLng":22.5876611571396,
            "gpsLat":113.92075500939703,
            "radius":400,
            "mapType":"baidu",
            "scale":16,
            "fenceId":"f6f725bc7582417c94a53fd87f46a70a"
        },
        {
            "imei":"201902270000991",
            "fenceName":"大家围栏",
            "fenceShape":"circle",
            "status":"",
            "lng":114.03696,
            "lat":22.616546,
            "gpsLng":22.609745442778124,
            "gpsLat":114.03099923044476,
            "radius":200,
            "mapType":"baidu",
            "scale":3,
            "fenceId":"61fc1f44ad2d414c9c9d3cd5cf7ba3c5"
        }
    ],
    "msg":"success"
}
                    

wifi、基站定位解析接口

接口说明

按用户名下总设备数（按每10次/天/设备，包含下级所有子账户）总数配置限额。
wifi、基站定位解析接口，相同设备10秒只能调1次，接口返回的坐标系为WGS84

请求URL

本接口通用参数里面 method的值为jimi.lbs.address.get

HTTP请求方式

GET/POST

请求参数

(1)通用参数
    参见:通用参数

(2)私有参数
    

请求示例：
format=json&lbs=460,1,816,29946,35|460,1,816,29944,33|460,1,816,16506,26|460,1,816,35346,26|460,1,816,29945,24|460,1,816,3895,24|460,1,816,19204,23&wifi=A8574E560756,61|C4473F99F778,64|643AB14071FA,66|D0C7C0351C74,72|30FC6838249E,74|CC90E8A827BB,74|286C075B88E7,75|0023C994F9C7,87&access_token=80e2cf80e2cf80e2cf80e2cf80e2cfcd&imei=86812016200327&sign=C678A69680224F369680224F3CD82CD6

返回值

result参数列表：

正确返回示例：

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

错误返回示例：

{"code":xxx,"message":"非法设备"}

消息推送接口

接口说明

第三方平台提供已经调通的消息接收的url地址发给对接人员，几米平台调用该url请求发送数据

消息服务列表

推送的内容如下:

告警推送 (jimi.push.device.alarm)

推送策略：当告警推送失败时，会将失败告警记录下，第二天上午9点定时重推一次，如果还是失败则丢弃。

推送的告警属性如下：

消息示例:

参数示例：
  "msgType": "jimi.push.device.alarm",
  "data": {
    "imei": "868120145233604",
    "deviceName": "868120145233604",
    "alarmType": "2",
    "alarmName": "断电报警",
    "lat": 40.65615416521587,
    "lng": 109.89894039833524,
    "alarmTime": "2017-05-08 12:00:00",
    "address": "北京市xxx路"
  }
                    

附：设备告警类型