LCA设备配网服务API
更新时间：2020-03-13 10:13:55
1. 查询可配网的LCA产品列表
定义描述
| path |
版本 |
描述 |
是否需要用户身份的鉴权 |
| /awss/enrollee/lca/product/list |
1.0.5 |
接口用访问者身份拉取边缘网关列表，列表中含有待配网设备信息 |
是，客户端SDK需启用身份的鉴权 |
请求参数
| 参数 |
类型 |
必填 |
描述 |
| request |
Object |
是 |
请求对象 |
| request.pageNo |
int |
是 |
当前页数 |
| request.pageSize |
int |
是 |
一页记录数 |
| request.groupId |
String |
否 |
全屋业务下的房屋id |
| request.iotId |
String |
否 |
边缘网关的iotId |
返回参数
| 参数 |
类型 |
描述 |
| edgeGateways |
List |
EdgeGateway对象列表 |
| pageNo |
int |
当前页数 |
| pageSize |
int |
一页记录数 |
| total |
int |
边缘网关的个数 |
EdgeGateway对象
| iotId |
String |
是 |
边缘网关iotId |
| name |
String |
是 |
边缘网关名称 |
| models |
List |
是 |
为空时返回空数组 |
Model对象
| modelName |
String |
是 |
model名称 |
| deviceName |
String |
是 |
设备名称 |
| productKeys |
List |
是 |
为空时返回空数组，上限10个 |
示例
请求示例
{
"request": {
"iotToken": "109049c8xxxxxxf6f62e29a3ba",
"apiVer": "1.0.5"
},
"id": 150000000000,
"params": {
"request": {
"pageNo": 1,
"pageSize": 10,
"groupId": "xxxxxxxx",
"iotId": "xxxxxxxxxxxxxxx"
}
},
"version": "1.0"
}
正常返回示例
{
"code": 200,
"data": {
"pageNo": 1,
"pageSize": 10,
"total": 1,
"edgeGateways": [{
"iotId": "model1",
"name": "设备名称1",
"models": [{
"modelName": "xxxxxxx",
"deviceName": "xxxxxxxxx",
"productKeys": ["productKey1", "productKey2", "productKey3"]
}]
}]
},
"message": "success"
}
2. 网关接入LCA子设备请求
定义描述
| path |
版本 |
描述 |
是否需要用户身份的鉴权 |
| /thing/gateway/lca/permit |
1.0.5 |
网关接入LCA子设备请求 |
是，客户端SDK需启用身份的鉴权 |
请求参数
| 参数 |
类型 |
必填 |
描述 |
| request |
Object |
是 |
请求对象 |
| request.time |
int |
是 |
网关开启的配网窗口时间，单位秒 |
| request.productKey |
String |
是 |
待配网设备的productKey |
| request.model |
String |
是 |
待配网设备的model |
| request.deviceName |
String |
是 |
待配网设备的设备名 |
| request.gatewayIotId |
String |
是 |
网关iotId |
返回参数
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.5",
"iotToken": "token"
},
"params": {
"request": {
"time": 60,
"productKey": "xxxxxxxxx",
"model": "xxxxxxx",
"deviceName": "xxxxxxxx",
"gatewayIotId": "xxxxxxxxxxxxxx"
}
}
}
正常返回示例
{
"code": 200,
"message": "success"
}