|
|
@@ -60,18 +60,72 @@ Authorization: Bearer {{token}}
|
|
|
| 415 | 请求失败，不支持的媒体类型 |
|
|
|
| 500 | 请求失败，服务端内部错误 |
|
|
|
|
|
|
+
|
|
|
+## 返回结果规范
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "msg": "操作成功",
|
|
|
+ "data": 一个标准的json对象或者数组对象
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 背景图片列表
|
|
|
+### GET 请求URL
|
|
|
+{{api_url}}/v1/device/background
|
|
|
+
|
|
|
+### 返回结果
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "msg": "操作成功",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "id": 1,
|
|
|
+ "name": "t",
|
|
|
+ "displayName": "t",
|
|
|
+ "size": 10,
|
|
|
+ "imgUrl": "v1/static/xx/1.jpg",
|
|
|
+ "version": null,
|
|
|
+ "status": 0,
|
|
|
+ "isDel": 0,
|
|
|
+ "createTime": "2024-12-05T11:01:38",
|
|
|
+ "updateTime": "2024-12-05T11:01:54"
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "time": 1733367719077
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+1. 成功，状态码200，返回设备配置列表数据
|
|
|
+2. 失败，状态码401，授权失败
|
|
|
+3. 具体返回状态码和http标准状态码一致，具体请查看[HTTP状态码](https://www.runoob.com/http/http-status-codes.html)
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "msg": "操作成功",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "id": 背景图片id,
|
|
|
+ ""
|
|
|
+ }
|
|
|
+ ]
|
|
|
+
|
|
|
+}
|
|
|
+```
|
|
|
## 同步设备配置列表数据
|
|
|
|
|
|
### GET请求URL
|
|
|
|
|
|
- {{api_url}}/sync?{{query_params}}
|
|
|
+ {{api_url}}/v1/device/sync?{{query_params}}
|
|
|
+### HEAD 参数
|
|
|
+
|
|
|
|
|
|
### 查寻参数
|
|
|
|
|
|
| 参数名 | 参数类型 | 值 | 说明 |
|
|
|
-| -------- | ------------ | --------------------- | ------------------------------------------------- |
|
|
|
-| package | string | cn.izhiju.android.xxx | 获取配置的应用包名，必须字段如：cn.izhiju.android.panela |
|
|
|
-| key | string | 平台相关的密钥 | 应用获取升级的密钥，必须字段 |
|
|
|
+| -------- | ------------ | --------------------- | ------------------------------------------------- |
|
|
|
| deviceId | string | ac:bc:cd:ee:11:22 | 设备ID或MAC地址，必须字段，后台添加限制时保持一致即可，智能家居应用目前定为大写MAC去冒号 |
|
|
|
| type | string | device | 获取哪些配置 all和不传为所有，device为设备配置列表，scene为场景配置列表，area为区域配置列表，all为所有组合配置
|
|
|
|
|
|
@@ -81,6 +135,88 @@ Authorization: Bearer {{token}}
|
|
|
2. 失败，状态码401，授权失败
|
|
|
3. 具体返回状态码和http标准状态码一致，具体请查看[HTTP状态码](https://www.runoob.com/http/http-status-codes.html)
|
|
|
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "msg": "操作成功",
|
|
|
+ "data": {
|
|
|
+ "city": {
|
|
|
+ "location_id": "101010100",
|
|
|
+ "location_name_en": "Beijing",
|
|
|
+ "location_name_zh": "北京",
|
|
|
+ "iso_3166_1": "CN",
|
|
|
+ "country_region_en": "China",
|
|
|
+ "country_region_zh": "中国",
|
|
|
+ "adm1_name_en": "Beijing",
|
|
|
+ "adm1_name_zh": "北京市",
|
|
|
+ "adm2_name_en": "Beijing",
|
|
|
+ "adm2_name_zh": "北京市",
|
|
|
+ "timezone": "Asia/Shanghai",
|
|
|
+ "latitude": "39.904987",
|
|
|
+ "longitude": "116.405289",
|
|
|
+ "adcode": "110000"
|
|
|
+ },
|
|
|
+ "areas": [
|
|
|
+ {
|
|
|
+ "id": 1,
|
|
|
+ "pid": 0,
|
|
|
+ "name": "三楼",
|
|
|
+ "groupable": true
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "devices": [
|
|
|
+ {
|
|
|
+ "opr": "addOrUpd",
|
|
|
+ "id": 322,
|
|
|
+ "pid": 0,
|
|
|
+ "area_id": 2,
|
|
|
+ "type": "gateway",
|
|
|
+ "subtype": "YG003",
|
|
|
+ "name": "4001",
|
|
|
+ "display_name": "主网关",
|
|
|
+ "version": 1,
|
|
|
+ "config": {
|
|
|
+ "address": "A51234F85667",
|
|
|
+ "master": true
|
|
|
+ }
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "scenes": [
|
|
|
+ {
|
|
|
+ "opr": "addOrUpd",
|
|
|
+ "id": 335,
|
|
|
+ "pid": 0,
|
|
|
+ "area_id": 2,
|
|
|
+ "type": "scene",
|
|
|
+ "subtype": "scene",
|
|
|
+ "name": "3001",
|
|
|
+ "display_name": "场景1",
|
|
|
+ "description": "场景1",
|
|
|
+ "version": 1,
|
|
|
+ "actions": {
|
|
|
+ "winter": [
|
|
|
+ {
|
|
|
+ "name": "0005"
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "summer": [
|
|
|
+ {
|
|
|
+ "name": "0004"
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "common": [
|
|
|
+ {
|
|
|
+ "name": "0003"
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ },
|
|
|
+ "time": 1733367851249
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
## 返回数据格式总体定义说明
|
|
|
1. 数据格式为json，返回数据为数据列表，json中采用驼峰命名方式
|
|
|
|
|
|
@@ -89,6 +225,7 @@ Authorization: Bearer {{token}}
|
|
|
|
|
|
为支持增量同步机制；所有对象新增操作模式字段：opr；枚举有：addOrUpd|del
|
|
|
|
|
|
+
|
|
|
```json
|
|
|
[
|
|
|
//第一个模板为所有配置，包含必选配置和可选配置，不同设备类型的配置都有说明
|
|
|
@@ -195,9 +332,7 @@ Authorization: Bearer {{token}}
|
|
|
"fill_light": false,//是否开启补光灯
|
|
|
"live_detection": false,//是否开启活体检测
|
|
|
"face_valve":0.55,//人脸阀值 0-1
|
|
|
- "mask_detection": false,//是否开启口罩检测
|
|
|
- "background":["internal://bg1","http://www.abc.com/img/id/background.png"] //bg1-bg4 4张背景图为内置，本地没有指定时显示默认第一个下标背景图,网关或面板要下载的背景图列表
|
|
|
-
|
|
|
+ "mask_detection": false//是否开启口罩检测
|
|
|
}
|
|
|
}
|
|
|
]
|
|
|
@@ -628,8 +763,7 @@ Authorization: Bearer {{token}}
|
|
|
"lock_weekday": [1, 2, 3, 4, 5,6,7], //一周中哪些天需要锁定
|
|
|
"lock_start_time": "12:00:00", //一天中锁定的开始时间，格式为24小时制
|
|
|
"lock_end_time": "23:59:59", //一天中锁定的结束时间，格式为24小时制
|
|
|
- "icons":["","",""],
|
|
|
- "background":["","","",""]
|
|
|
+ "icons":["","",""] //可选，目前是在设备端定义
|
|
|
}
|
|
|
},
|
|
|
]
|
