## appKey和appSecret验证
由途狐管车服务平台给出api连接地址、有效的appkey和appSecret,用户通过appkey、appSecret获取accessToken。 调用API时传入appkey和accessToken,并对请求参数进行签名,途狐API服务器端会验证请求参数是否合法。**获取的accessToken需要添加到消息头中,每次访问在消息头中携带传递。定义Key值为X-Access-Token。如:{“X-Access-Token”:“xxxxx”}**
## API签名
为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名,途狐服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。目前支持的签名算法有:MD5(本接口通用参数里面signMethod的值为md5),签名大体过程如下:
对所有API请求参数(包括公共参数和业务参数,但除去sign参数和byte\[\]类型的参数),根据参数名称的ASCII码表的顺序排序。如:foo=1, bar=2, foo\_bar=3, foobar=4排序后的顺序是bar=2, foo=1, foo\_bar=3, foobar=4。
将排序好的参数名和参数值拼装在一起,根据上面的示例得到的结果为:bar2foo1foo\_bar3foobar4。
把拼装好的字符串采用utf-8编码,使用签名算法对编码后的字节流进行摘要。如果使用MD5算法,则需要在拼装的字符串前后加上app的secret后,再进行摘要,如:md5(secret+bar2foo1foo\_bar3foobar4+secret)。
将摘要得到的字节流结果使用十六进制表示,如:hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”。
说明:MD5是128位长度的摘要算法,用16进制表示,一个十六进制的字符能表示4个位,所以签名后的字符串长度固定为32个十六进制字符。
### 算法
JAVA代码示例:
~~~
public static String signTuhuRequest(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();
}
~~~
- 目录
- 概述
- 使用场景
- 使用方法
- 协议格式
- 公共约定
- API简介
- 通信流程
- API列表
- 接口调用限制说明
- API详情
- 认证说明
- 通用参数
- 获取accessToken
- 刷新accessToken
- 注册设备到平台
- 根据账户获取设备信息
- 根据账户获取所有设备的最新定位数据
- 根据IMEI获取最新定位数据
- 根据IMEI获取设备详细信息
- 根据IMEI获取轨迹数据
- 获取设备支持的指令列表
- 指定设备发送指令
- 获取设备指令结果
- 根据用户名获取分组列表
- 创建分组
- 修改分组信息
- 删除分组
- 根据账户获取车辆列表
- 根据分组ID获取车辆列表
- 添加车辆
- 修改车牌
- 转移车辆(改变分组)
- 获取围栏列表
- 获取围栏相关车辆
- 新增围栏
- 删除围栏
- 围栏关联车辆
- 消息推送