Forráskód Böngészése

获取设备列表增加说明

miricy 1 éve
szülő
commit
7dc1d7ad0b
1 módosított fájl, 9 hozzáadás és 8 törlés
  1. 9 8
      product/deviceconfig.md

+ 9 - 8
product/deviceconfig.md

@@ -70,12 +70,11 @@ Authorization: Bearer {{token}}
 
 ## 服务器配置
 
-  接口需要实现能够通过设备id,获取和这个设备相关联的设备列表,场景列表,区域列表等配置信息。
-  接口需要实现能够通过设备id, 区域id,获取和这个设备所在区域树中,区域相关联的设备列表,场景列表等配置信息。
+  获取服务器配置信息,包含mqtt服务器地址,ftp服务器地址等。
 
 ### GET 请求URL
 
-{{api_url}}/v1/device/configs?deviceId=ac:bc:cd:ee:11:22&areaId=1
+{{api_url}}/v1/device/configs?deviceId=ac:bc:cd:ee:11:22
 
 ### 请求头参数
 
@@ -85,8 +84,6 @@ Authorization: Bearer {{key}}
 ### 请求参数
 
 deviceId: 设备唯一标识
-areaId: 区域id,可选参数,当包含区域id时,只返回这个区域树中的设备列表和场景列表。
-
 key: 用户授权token,服务器为设备分配的长期有有效的授权token,内置在设备中,无需用户手动获取。
 
 ### 返回结果
@@ -186,11 +183,15 @@ key: 用户授权token,服务器为设备分配的长期有有效的授权token
 
 ## 同步设备配置列表数据
 
+  接口需要实现能够通过设备id,获取和这个设备相关联的设备列表,场景列表,区域列表等配置信息。
+  接口需要实现能够通过设备id, 区域id,获取和这个设备所在区域树中,区域相关联的设备列表,场景列表等配置信息。
+
 ### GET请求URL
   
-  {{api_url}}/v1/device/configs/sync?deviceId=ac:bc:cd:ee:11:22&type=all
+  {{api_url}}/v1/device/configs/sync?deviceId=ac:bc:cd:ee:11:22&areaId=1&type=all
+
+### 请求头参数
 
-### 请求头参数:
 Content-Type: application/json
 Authorization: Bearer {{key}}
 
@@ -200,7 +201,7 @@ Authorization: Bearer {{key}}
 | -------- | ------------ | --------------------- | -------------------------------------------------                 |
 | deviceId | string   | ac:bc:cd:ee:11:22     | 设备ID或MAC地址,必须字段,后台添加限制时保持一致即可,智能家居应用目前定为大写MAC去冒号 |
 | type     | string   | device |  获取哪些配置 all和不传为所有,device为设备配置列表,scene为场景配置列表,area为区域配置列表,all为所有组合配置 |
-                         |
+| areaId   | string   | 1234 | 区域id,可选参数,当包含区域id时,只返回这个区域树中的设备列表和场景列表。 |
 
 ### 返回结果