¶ Requirements
预接入此接口，需按照推送接口文档实现并部署服务，便于接收此接口推送的业务数据。
配置 ip白名单
获取 client_id
获取 secret_key- 获取 secret_val
确定经纬度坐标系
¶ URL
¶ Method
POST
¶ Headers
| 参数名称 | 数据类型 | 必须 | 参数说明 |
|---|---|---|---|
| client_id | string | Y | 客户标识 |
| Content-Type | string | Y | application/json |
| secret_key | string | Y | 密钥 |
| api_id | string | Y | API标识(固定值：device-track-subscription) |
| raw | bool | Y | 明文传输标记 |
¶ Body
| 参数名称 | 数据类型 | 必须 | 参数说明 |
|---|---|---|---|
| device_id | string | Y | 设备 id，安卓系统支持 imei、mac、oaid、gaid，ios 系统支持 idfa 。（原值或 md5 值、不限大小写） |
| id_type | string | Y | 设备 id 类型，imei、mac、oaid、gaid、idfa 任选其一 |
| effective_days | int | Y | 订阅的有效期，单位天，0 代表撤销订阅。 |
¶ Body 加密
1.对 Body进行 zlib 压缩；
2.对压缩后的数据 进行 AES/CBC/PKCS5Padding 加密（由于AES秘钥长度限制，如之前使用的秘钥长度过长，需要截取前16位）；
3.将加密后的数据作为Body发送 HTTP 请求；
¶ 或者直接使用SDK，即可忽略URL，Method，Headers等参数和加解密操作（推荐）
¶ Response
| 参数名称 | 数据类型 | 必须 | 参数说明 |
|---|---|---|---|
| code | int | Y | 错误码 |
| msg | string | Y | 错误码描述信息 |
| data | object | N | |
| ｜req_id | string | N | 本次请求的唯一 id |
¶ Response 解密
1.将接收到的数据 进行 AES/CBC/PKCS5Padding 解密（由于AES秘钥长度限制，如之前使用的秘钥长度过长，需要截取前16位）；
2.对 Body进行 zlib 解压；
3.即可得到明文数据；
¶ Example
- Header
{
"client_id": "$client_id",
"secret_key": "$secret_key",
"Content-Type": "application/json",
"raw": true,
"api_id": "device-track-subscription"
}
- Body
{
"device_id": "94c5e 4da-38a4-42b7-ac89-fa1b7a85bf78",
"id_type":"oaid",
"effective_days": 1,
}
- Response
{
"code":0,
"msg":"ok",
"data":{
"req_id":"7bLGCKjyIME6nutRbic77B"
}
}
¶ Error Code
| 参数名称 | 参数类型 |
|---|---|
| 0 | 正常 |
| 10000 | 请求IP不在白名单 |
| 10100 | 客户id未指定 |
| 10101 | 客户id不存在 |
| 10102 | 客户未开通此服务 |
| 10200 | 秘钥key未指定 |
| 10201 | 秘钥key不存在 |
| 10202 | 解密失败 |
| 22100 | 参数错误 |
| 22101 | date_range 参数错误 |
| 22103 | id_type 参数错误 |
| 22104 | date_range 超出限制 |
| 22105 | 未查到 |
| 22106 | 订阅有效期错误 |
| 22107 | 查询功能错误 |
| 22108 | 内部错误 |