注册设备
此接口用于设备动态注册场景。其中,设备端sdk已封装此接口,建议使用合适的sdk。
TIP
- 此接口路径详见环境说明
- 不参与通用验签规则,此处验签规则为:对body进行HMAC_MD5运算,
productSecret作为加密密钥,并将得到的字符串转换为大写,得到x-auth-sign值,作为请求头的一项值。
1 接口路径
POST {host}/iot-platform-register-service/register
2 请求参数
header内容:
| 名称 | 是否必需 | 描述 |
|---|---|---|
| x-auth-sign | 是 | 签名值 |
| x-auth-ts | 是 | 当前时间戳 |
| x-auth-traceId | 是 | 注册具体信息 |
body参数,json格式:
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| productKey | String | 是 | 产品标识 |
| version | String | 是 | 版本 |
| identities | Object[] | 是 | 注册具体信息 |
identities元素说明:
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| type | String | 是 | 注册标识信息类别:uid或mac |
| values | String[] | 是 | 注册标识信息:对应的uid或mac值 |
3 返回参数
统一返回参数说明参考:公共参数,以下是返回业务参数(data)的说明:
| 名称 | 类型 | 描述 |
|---|---|---|
| deviceId | BigInteger | 设备ID |
| productKey | String | 产品标识 |
| deviceSecret | String | 设备密钥 |
4 返回状态码
公共状态码说明参考:公共参数,以下是业务关联的状态码说明:
| code | 描述 |
|---|---|
| 130402 | 参数校验不通过 |
| 130401 | 没找到匹配策略 |
| 130502 | 动态注册已关闭 |
5 示例
请求示例1: uid注册方式
{
"identities": [
{
"type": "uid",
"values": [
"11111"
]
}
],
"productKey": "1_783dcb3cf4d",
"version": "1.0.1"
}
请求示例2: mac注册方式
{
"identities": [
{
"type": "mac",
"values": [
"11111"
]
}
],
"productKey": "1_783dcb3cf4d",
"version": "1.0.1"
}
返回示例
{
"code": "000000",
"data": {
"deviceId": "322074019652452352",
"deviceSecret": "85377d675787233f",
"productKey": "1_783dcb3cf4d"
},
"message": "success"
}