概述

使用场景

经销商自己有一套系统，想在这个基础上扩充相关GPS功能。 经销商的客户的账号由经销商自己的系统管理，用于登录经销商的系统。 经销商系统的账号和汽车在线平台的账号对应关系，经销商自己管理，经销商使用汽车在线平台的账号来获取相应设备数据。设备IMEI由经销商自己的系统管理，经销商可根据imei获取设备数据。 经销商的应用服务器调用API接口。

使用方法

经销商提供他的几米平台登录账号和密码来获取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，并对请求参数进行签名，几米服务器端会验证
请求参数是否合法。

通用参数

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
                            

获取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": "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",
    }
  ]
}
                    

错误返回示例：

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

根据IMEI获取最新定位数据

接口说明

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

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

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

错误返回示例：

{"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",
      "driverPhone": "25",
      "vehicleIcon": "taxi",
      "equipType": "WIRED",
      "mcTypeUseScope": "electromobile",
      "reMark": "123456788012354",
      "sn": "123456788012354",
      "vehicleName": null,
      "vehicleNumber": "123456788012354u",
      "carFrame": "123456788012354",
      "idCard": "123456788012354",
      "engineNumber": "123456788012354",
      "installTime": null,
    }
  ]
}
                    

错误返回示例：

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

转移设备

接口说明

将账号上的设备转移到指定账号上。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

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

错误返回示例：

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

创建车辆信息

接口说明

指定账号下创建车辆信息。如果指定账号下存在相同的车牌号，则返回该车辆的信息，不对其进行更新操作。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "添加成功",
  "result": {
    "id": 5756,
    "carOwnerName": "测试车主",
    "carOwnerPhone": "12356456456465456456",
    "cardType": "IDCARD",
    "carOwnerIdCard": "4526011995132565221",
    "carPlateNumber": "TX85512",
    "carModel": "Tc1",
    "carEngineNumber": "axsq123456",
    "carFrameNumber": "axsq12345623",
    "carType": "NEWCAR",
    "createTime": "2018-05-23 19:03:56",
    "overallSum": 18000,
    "loanMonth": "12",
    "loanSum": 15000,
    "salesman": "wwq",
    "homeAddress": "测试地址1",
    "workAddress": "测试地址2",
    "sex": 1,
    "carColor": "蓝色",
    "loanDate": "2018-08-15",
    "repaymentType": "STAGES"
    "bindAccount": "jimitest"
  }
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}

修改车辆信息

接口说明

通过车辆ID更新车辆信息，可更新子账户下的车辆。请求参数为空的情况下，自动设置值为空或者0

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

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

错误返回示例：

{"code":xxx,"message":"车牌号已经存在"}

删除车辆信息

接口说明

通过车辆ID删除车辆信息，只有未绑定设备的车辆才可进行删除操作。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "删除车辆成功",
  "result": null
}
                    

错误返回示例：

{"code":230,"message":"车辆不存在"}

车辆转移

接口说明

指定账号进行车辆转移。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "转移车辆成功",
  "result": null
}
                    

错误返回示例：

{"code":230,"message":"车辆不存在"}

车辆绑定IMEI设备

接口说明

对指定车辆进行IMEI号的绑定操作,已安装的设备不可进行绑定。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "绑定设备成功",
  "result": null
}
                    

错误返回示例：

{"code": 233,"message": "IMEI不存此账号下在或者已绑定其他车辆上"}

车辆解绑IMEI设备

接口说明

对指定车辆进行IMEI号的绑定操作,已安装的设备不可进行绑定。

请求URL

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

HTTP请求方式

POST

请求参数

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

(2)私有参数
    

返回值

正确返回示例：

{
  "code": 0,
  "message": "解绑设备成功",
  "result": null
}
                    

错误返回示例：

{"code": 232,"message": "该设备不属于此车辆下无法解绑"}

查询车辆详情

接口说明

通过车辆编号获取车辆详细信息。

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

equtList参数列表:

正确返回示例：

{
  "code": 0,
  "message": "成功",
  "result": [
    {
	"carId": 5750,
	"bindUserAccount": "huangwm",
	"carOwnerName": "测试车辆3",
	"carOwnerPhone": null,
	"cardType": "IDCARD",
	"carOwnerIdCard": "12312312112321",
	"carPlateNumber": "TX12321",
	"carModel": "TW12321",
	"carEngineNumber": "qas123",
	"carFrameNumber": "qwe123",
	"carType": "NEWCAR",
	"overallSum": 18000,
	"loanMonth": "12",
	"loanSum": 15000,
	"salesman": "wwq",
	"homeAddress": "测试地址1",
	"workAddress": "测试地址2",
	"sex": 1,
	"carColor": "蓝色",
	"loanDate": "2018-08-15",
	"repaymentType": "STAGES",
	"imeis": "201803161655008,201804271524201",
	"createTime": "2018-05-23 19:03:56",
	"updateTime": "2018-05-23 19:03:56",
	"equtList": [
        {
          "imei": "201803161655008",
          "deviceName": "ET110-55008",
          "activationTime": null,
          "expiration": null,
          "mcType": "ET110",
          "sim": "",
          "driverPhone": null,
          "vehicleIcon": "automobile",
          "equipType": "WIRED",
          "mcTypeUseScope": "electromobile",
          "reMark": null,
          "installTime": "2018-05-22"
        },
        {
          "imei": "201804271524201",
          "deviceName": "ET100-24201",
          "activationTime": null,
          "expiration": null,
          "mcType": "ET100",
          "sim": "",
          "driverPhone": null,
          "vehicleIcon": "automobile",
          "equipType": "WIRED",
          "mcTypeUseScope": "electromobile",
          "reMark": null,
          "installTime": "2018-05-22"
        }
      ]
    }
	......
  ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}

查询账号下的所有车辆信息

接口说明

通过车辆编号获取车辆详细信息。

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "成功",
  "result": [
	{
	  "carId": 5756,
	  "carOwnerName": "测试车主",
	  "carOwnerPhone": "12356456456465456456",
	  "cardType": "IDCARD",
	  "carOwnerIdCard": "4526011995132565221",
	  "carPlateNumber": "TX85512",
	  "carModel": "Tc1",
	  "carEngineNumber": "axsq123456",
	  "carFrameNumber": "axsq12345623",
	  "carType": "NEWCAR",
	  "overallSum": 18000,
	  "loanMonth": "12",
	  "loanSum": 15000,
	  "salesman": "wwq",
	  "homeAddress": "测试地址1",
	  "workAddress": "测试地址2",
	  "sex": 1,
	  "carColor": "蓝色",
	  "loanDate": "2018-08-15",
	  "repaymentType": "STAGES"
	  "imeis": null,
	  "createTime": "2018-05-23 19:03:56",
	  "updateTime": "2018-05-23 19:03:56"
	},
	{
	  "carId": 5750,
	  "carOwnerName": "测试车辆3",
	  "carOwnerPhone": null,
	  "cardType": "IDCARD",
	  "carOwnerIdCard": "12312312112321",
	  "carPlateNumber": "TX12321",
	  "carModel": "TW12321",
	  "carEngineNumber": "qas123",
	  "carFrameNumber": "qwe123",
	  "carType": "NEWCAR",
	  "overallSum": 18000,
	  "loanMonth": "12",
	  "loanSum": 15000,
	  "salesman": "wwqw",
	  "homeAddress": "测试地址3",
	  "workAddress": "测试地址4",
	  "sex": 1,
	  "carColor": "蓝色",
	  "loanDate": "2018-08-15",
	  "repaymentType": "STAGES"
	  "imeis": "201803161655008,201804271524201",
	  "createTime": "2018-05-22 14:42:59",
	  "updateTime": "2018-05-22 16:24:05"
	},
	.......
   ]
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}

获取设备支持的指令列表

接口说明

获取指定设备机型支持的指令列表。

请求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参数说明

返回值

正确返回示例：

{
  "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)私有参数
    

返回值

result参数列表:

正确返回示例：

{
  "code": 0,
  "message": "成功",
  "result": {
      "imei": "456789123456801",
      "fenceName": "11111111111",
      "fenceId": "0f566e9d9e0b4a2499832cd158b0c63b",
    }
}
                    

错误返回示例：

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

wifi、基站定位解析接口

接口说明

按用户名下总设备数（按每10次/天/设备，包含下级所有子账户）总数配置限额。
接口返回的坐标系为WGS84

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表：

正确返回示例：

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

错误返回示例：

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

消息推送接口

接口说明

第三方平台提供消息接收的url地址，几米平台调用该url请求发送数据

消息服务列表

推送的内容如下:

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

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

推送的告警属性如下：

消息示例:

  https://ip:port/xxx?msgType=jimi.push.device.alarm&data={"imei":"868120145212312","deviceName":"868120145212312","alarmType":"2","alarmName":"测试","lat":40.65615416521587,"lng":109.89894039833524,"alarmTime":"2017-05-08 12:00:00","address":"北京市xxx路"}
  
  参数：
  "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路"
  }
                    

附：设备告警类型

查询状态统计

接口说明

查询账号下设备状态信息。

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

items参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": {
    "page": 1,
    "size": 20,
    "number": 2,
    "lastPage": true,
    "items": [
      {
        "carId": "",
        "carOwnerName": "",
        "carPlateNumber": "",
        "imei": "201808221000079",
        "carOwnerPhone": "",
        "orgName": "ES003",
        "deviceName": "GT300-00079",
        "salesman": "",
        "deviceType": "GT300",
        "carEngineNumber": "",
        "carFrameNumber": "",
        "status": "0",
        "lat": 22.540203,
        "lng": 113.91854,
        "date": "2018-08-22 15:04:54",
        "lngLat": "113.91854/22.540203",
        "addr": "广东省深圳市南山区红花路19号,南山区文体中心西北63米",
        "times": 444446,
        "speed": 0,
        "gpsTime": "2018-08-22 15:07:56",
        "hbTime": "2018-08-22 15:04:54"
      },
      {
        "carId": 46049,
        "carOwnerName": "BB",
        "carPlateNumber": "BB-02",
        "imei": "201808221000012",
        "carOwnerPhone": "13812345678",
        "orgName": "ES001",
        "deviceName": "GT230-00012",
        "salesman": "李四8",
        "deviceType": "GT230",
        "carEngineNumber": "123456796",
        "carFrameNumber": "123456796",
        "status": "0",
        "lat": 22.540203,
        "lng": 113.91854,
        "date": "2018-08-22 15:05:34",
        "lngLat": "113.91854/22.540203",
        "addr": "广东省深圳市南山区红花路19号,南山区文体中心西北63米",
        "times": 444407,
        "speed": 0,
        "gpsTime": "2018-08-22 15:07:56",
        "hbTime": "2018-08-22 15:05:34"
      },
	  ..........
    ]
  }
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}

查询电量过低统计

接口说明

查询账号下设备电量信息。

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

items参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": {
    "page": 2,
    "size": 20,
    "number": 14,  //当前页查询数量
    "lastPage": true,  //是否为最后一页
    "items": [
      {
        "carId": 46053,
        "carOwnerName": "CC",
        "carPlateNumber": "CC-03",
        "imei": "201808221000066",
        "carOwnerPhone": "13812345678",
        "orgName": "ES002",
        "deviceName": "GT300-00066",
        "salesman": "李四16",
        "deviceType": "GT300",
        "carEngineNumber": "123456804",
        "carFrameNumber": "123456804",
        "power": 5
      },
      {
        "carId": "",
        "carOwnerName": "",
        "carPlateNumber": "",
        "imei": "201808221000067",
        "carOwnerPhone": "",
        "orgName": "ES002",
        "deviceName": "GT300-00067",
        "salesman": "",
        "deviceType": "GT300",
        "carEngineNumber": "",
        "carFrameNumber": "",
        "power": 5
      },
	  ..........
    ]
  }
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}

查询告警总览统计

接口说明

查询账号下设备告警总览信息。

请求URL

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

HTTP请求方式

GET/POST

请求参数

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

(2)私有参数
    

返回值

result参数列表:

items参数列表:

正确返回示例：

{
  "code": 0,
  "message": "success",
  "result": {
    "page": 1,
    "size": 20,
    "number": 20,
    "lastPage": false,
    "items": [
      {
        "carId": 46047,
        "carOwnerName": "AA",
        "carPlateNumber": "AA-03",
        "imei": "201808221000004",
        "orgName": "测试部门",
        "salesman": "李四4",
        "deviceType": "GT230",
        "sos": 0,
        "cutPower": 0,
        "vibration": 0,
        "enterTerminalGeozone": 0,
        "exitTerminalGeozone": 0,
        "overspeed": 0,
        "movement": 0,
        "blindAreaEnter": 0,
        "blindAreaExit": 0,
        "bootingNotification": 0,
        "firstFixNotification": 0,
        "lowExternalPower": 0,
        "lowPowerProtection": 0,
        "simCardChange": 0,
        "powerOff": 0,
        "airplaneModeAfterLowPowerProtection": 0,
        "disassembly": 0,
        "doorAlarm": 0,
        "voice": 0,
        "pseudoBaseStation": 0,
        "openCoverAlarm": 0,
        "lowPowerAlarm": 0,
        "sleepAlarm": 0,
        "lowPower": 0,
        "dvrVibration": 0,
        "overspeedDVR": 0,
        "rapidAcceleration": 0,
        "rapidDeceleration": 0,
        "sharpTurn": 0,
        "carCrash": 0,
        "illegalMobileAlert": 0,
        "insufficientBatteryBackupAlert": 0,
        "overStepAlert": 0,
        "exitGeozone": 4,
        "enterGeozone": 5,
        "offline": 1,
        "accOpen": 0,
        "accShutdown": 0,
        "longtimeNotOutFence": 4,
        "longtimeNotIntoFence": 4,
        "lingerAlert": 0,
        "stayAlert": 3,
        "sensitiveAreasFence": 24,
        "overspeedPlatform": 0,
        "separationAlarm": 0
      },
      {
        "carId": "",
        "carOwnerName": "",
        "carPlateNumber": "",
        "imei": "201808221000010",
        "orgName": "测试部门",
        "salesman": "",
        "deviceType": "GT230",
        "sos": 0,
        "cutPower": 0,
        "vibration": 0,
        "enterTerminalGeozone": 0,
        "exitTerminalGeozone": 0,
        "overspeed": 0,
        "movement": 0,
        "blindAreaEnter": 0,
        "blindAreaExit": 0,
        "bootingNotification": 0,
        "firstFixNotification": 0,
        "lowExternalPower": 0,
        "lowPowerProtection": 0,
        "simCardChange": 0,
        "powerOff": 0,
        "airplaneModeAfterLowPowerProtection": 0,
        "disassembly": 0,
        "doorAlarm": 0,
        "voice": 0,
        "pseudoBaseStation": 0,
        "openCoverAlarm": 0,
        "lowPowerAlarm": 0,
        "sleepAlarm": 0,
        "lowPower": 0,
        "dvrVibration": 0,
        "overspeedDVR": 0,
        "rapidAcceleration": 0,
        "rapidDeceleration": 0,
        "sharpTurn": 0,
        "carCrash": 0,
        "illegalMobileAlert": 0,
        "insufficientBatteryBackupAlert": 0,
        "overStepAlert": 0,
        "exitGeozone": 5,
        "enterGeozone": 4,
        "offline": 2,
        "accOpen": 0,
        "accShutdown": 0,
        "longtimeNotOutFence": 4,
        "longtimeNotIntoFence": 5,
        "lingerAlert": 0,
        "stayAlert": 4,
        "sensitiveAreasFence": 16,
        "overspeedPlatform": 0,
        "separationAlarm": 0
      },
	  ...........
    ]
  }
}
                    

错误返回示例：

{"code":xxx,"message":"非法用户"}