云服务 API 参考全屋智能全屋基础服务包

全屋基础服务包

更新时间：2024-04-02 08:55:08下载pdf

提供涂鸦全屋智能体系基础业务开放能力

全屋管理

API名称	接口地址
添加家庭	POST:/v1.0/home/create-home
查询家庭	GET:/v1.0/homes/{home_id}
修改家庭	PUT:/v1.0/homes/{home_id}
删除家庭	DELETE:/v1.0/homes/{home_id}
查询家庭下的设备列表	GET:/v1.0/homes/{home_id}/devices
查询家庭成员列表信息	GET:/v1.0/homes/{home_id}/members
添加家庭成员	POST:/v1.0/homes/{home_id}/members
修改家庭成员信息	PUT:/v1.0/homes/{home_id}/members/{uid}
删除家庭成员	DELETE:/v1.0/homes/{home_id}/members/{uid}
添加房间	POST:/v1.0/homes/{home_id}/room
查询家庭下的房间列表	GET:/v1.0/homes/{home_id}/rooms
删除房间	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}
修改房间名称	PUT:/v1.0/homes/{home_id}/rooms/{room_id}
查询家庭房间设备	GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
查询⽤户家庭列表	GET:/v1.0/users/{uid}/homes
新增房间内的设备	POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
修改家庭下房间内的设备	PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
删除家庭下房间内的设备	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices
获取设备列表	GET:/v1.0/devices

全屋用户管理

API名称	接口地址
同步用户	POST:/v1.0/apps/{schema}/user
获取用户信息	GET:/v1.0/users/{uid}/infos
获取用户列表	GET:/v2.0/apps/{schema}/users
取消删除	POST:/v1.0/users/{uid}/actions/cancel-delete
用户预删除	POST:/v1.0/users/{uid}/actions/pre-delete
获取用户的设备列表	GET:/v1.0/users/{uid}/devices

全屋应用管理

API名称	接口地址
获取应用详情	GET:/v1.0/apps/{schema}
获取应用的名称、logo、描述、创建时间等	GET:/v1.1/apps/{schema}

全屋配网管理

API名称	接口地址
获取子设备列表	GET:/v1.0/devices/{deviceId}/list-sub
允许子设备入网	PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
获取配网设备列表	GET:/v1.0/device/paring/tokens/{token}

全屋设备管理

API名称	接口地址
查询网关下 Zigbee 设备	GET:/v1.0/devices/{deviceId}/sub-devices
批量查询设备出厂信息	GET:/v1.0/devices/factory-infos
修改设备名称	PUT:/v1.0/devices/{device_id}
查询设备日志	GET:/v1.0/devices/{device_id}/logs
恢复设备出厂设置	PUT:/v1.0/devices/{device_id}/reset-factory
获取设备详情	GET:/v1.0/devices/{deviceId}
移除设备	DELETE:/v1.0/devices/{deviceId}
获取设备状态	GET:/v1.0/devices/{deviceId}/status
获取设备列表 v2	GET:/v2.0/devices
批量查询关联 App 用户维度设备列表	GET:/v1.0/iot-01/associated-users/devices
删除用户	DELETE:/v1.0/devices/{device_id}/users/{user_id}
修改设备成员	PUT:/v1.0/devices/{device_id}/users/{user_id}
查询设备成员信息	GET:/v1.0/devices/{device_id}/users/{user_id}
新增设备成员	POST:/v1.0/devices/{device_id}/user
根据设备 ID查询成员信息列表	GET:/v1.0/devices/{device_id}/users

全屋设备控制

API名称	接口地址
修改功能点名称	PUT:/v1.0/devices/{device_id}/functions/{function_code}
控制设备	POST:/v1.0/devices/{deviceId}/commands
获取设备支持的指令集	GET:/v1.0/devices/{deviceId}/functions
获取设备规格属性	GET:/v1.0/devices/{deviceId}/specifications
按品类获取指令集	GET:/v1.0/functions/{category}
批量获取指令集	GET:/v1.0/devices/functions
获取设备规格属性	GET:/v1.1/devices/{device_id}/specifications

上一篇全屋智能

下一篇全屋管理