# 导入 IoT 账号
# 简介
IoT 账号是指机械设备上的通用唯一识别码(UID)。在 Cat.1 设备的通话功能集成过程中,您需要用到这些 UID 作为参数传递给接口函数。
本文将指导您将 UID 导入到菊风后台。您可以在两种导入方式中任选一种:
# 前提条件
确保已经联系菊风开启自助导入 IoT 账号的权限。
接口 api 需要配置 IP 白名单,只允许白名单内的 IP 进行访问接口,增强接口的安全性,请联系我们并提供 IP 地址。
# 通过接口导入
# 准备参数
在通过接口导入账号的过程中,您会用到两个参数:appKey
和 密钥
。这两个参数需要在开发者控制台获取。
- 获取原始
appkey
和秘钥
,参考文档 (opens new window)。
# 请求地址
导入 IOT 账号的请求地址格式为:https://cloud.juphoon.com/bff-manage/cloudApi/importLicenseData/
。
# 鉴权说明
请求导号接口需要鉴权,Token 的生成规则:将appKey
、密钥
、timeStamp
按序连接,然后进行 md5 加密(32 位小写),生成的字符串则为token
。
appKey = f9c7bxxxxxxx6753a234409c
密钥 = f1H5xxxxxxxxI76p4
timeStamp = 1596595533
token = MD5(f9c7bxxxxxxx6753a234409cf1H5xxxxxxxxI76p41596595533)
TIP
密钥:用于 token
加密,密钥请联系我们获取,务必妥善保管好。(要重新获取,与旧版接口的密钥不同不兼容)
# 请求说明
调用传参:具体校验参数和 token
,导入数据参数统一采用 post 提交 json 格式串,返回的数据为 json 字符串;
POST 校验参数
参数 | 类型 | 说明 |
---|---|---|
appKey | string | 应用的 appkey |
licenseType | string | 常规 rtos 设备类型,填 Rtosdevice;常规智能硬件类型,填 Bdevice。 |
timeStamp | int | 提交接口的时间戳(秒),例:1596538800 |
token | string | 生成的校验 token |
POST 导入数据数据
参数 | 类型 | 说明 |
---|---|---|
data | list | 类型必须 list,样例:["portal001","portal002","portal003","portal004"],个数上限最多 1000 个。 |
TIP
业务说明:设备按照业务分为智能硬件设备和 rtos 设备,在导入时需要确认 licenseType 字段为所要导入的业务类型,Rtosdevice 代表 rtos 设备,Bdevice 代表安卓智能硬件设备
//请求 body 示例:
{
"appKey":"f9c7bxxxxxxx6753a234409c",
"timeStamp":1596595533,
"licenseType":"Bdevice",
"token":"44fee5c798b026281c41ef1c2eed2b0e",
"data":["test111","test112","test113"]
}
# 请求结果
在发送请求成功后会收到返回值:
参数 | 类型 | 说明 |
---|---|---|
ret | int | true 为接口调用成功,false 则为失败 |
msg | string | 接口调用失败时返回该字段 |
existsList | 重复导入的设备数据数组 | |
errorList | 导入错误的设备数据数组 | |
devList | 导入成功设备 |
返回服务请求正常 body 示例:
{
"ret": 0,
"msg": "ok",
"existsList": [], //代表重复导入设备,空 list 表示无
"errorList": ["test111"], //代表导入错误设备
"devList": ["test112"] //代表导入成功设备
}
返回服务请求错误 body 示例:
{
"ret": 7993,
"msg": "时间错误,有效范围 1 分钟内"
}
错误信息说明:
参数 | 类型 | 说明 |
---|---|---|
1000 | 系统出错 | 说联系我们明 |
1001 | 设备不能为空/单次导入最多 1000 个/appkey 不能为空/appKey 长度不能超过 64 位/appKey 格式错误/时间戳不能为空/设备类型不能为空/签名 token 不能为空/token 长度不为 32 位/token 格式错误 | 传的参数规则校验 |
2029 | 应用不存在 | |
7026 | Token 校验失败 | |
7301 | rtos 导入功能未开通,不允许 | 联系我们 |
7302 | rtos 余额不足 | |
7308 | 智能硬件导入功能未开通或不允许导入 | 联系我们 |
7309 | 可导入设备个数余额不足 | |
7310 | 设备类型错误 | licenseType 传参内容不正确 |
7992 | 密钥不存在 | 加密 token 时所使用的密钥不正确 |
7993 | 时间错误,有效范围 1 分钟内 | 接口时间不要在同一分钟内重复提交 |
7994 | 重复提交 | 接口参数 token 重复使用 |
7995 | IP 不允许 | 联系管理员添加 ip 白名单 |
7997 | 操作失败 | 联系我们 |
# 通过控制台导入
登录菊风云 IoT 控制台。
访问 服务管理 (opens new window) - 操作 - 账号导入 ,点击导入 打开导入弹框。
打开弹框后,点击 csv 模板说明及下载。
下载 csv 模板,并按照要求修改模板文件后上传 csv 文件即可导入账号。