iotsaas/docs/tuya/全屋基础服务包.md
2995840376 0ce191c448 chore: 初始化 iotsaas 版本库基线
纳入范围:
- backend/  Spring Boot 多模块后端(iot-common/device/rule/data/alarm/auth)
- frontend/admin/  Vue3 + Element Plus 管理后台
- Android/   涂鸦原生 APP (com.xhai.iot)
- backend/sql/  Flyway 风格迁移脚本(V2~V21)
- docs/       对接文档与设计文档

排除范围:
- 构建产物: node_modules/ target/ build/ dist/ .gradle/
- 签名密钥: *.jks *.keystore (严禁入库)
- 本机配置: Android/local.properties
- 运行日志: logs/ *.log
- AI 协作本地数据 .codebuddy/ 与第三方 demo tuya-demo/

.gitattributes 统一以 LF 存储, Windows 批处理保留 CRLF
2026-10-27 12:00:41 +08:00

94 lines
8.0 KiB
Markdown

# 全屋基础服务包
# 全屋基础服务包
提供涂鸦全屋智能体系基础业务开放能力
## 全屋管理
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [添加家庭](https://developer.tuya.com/cn/docs/cloud/b3014bea96?id=Kawfjdqri4xgi) | POST:/v1.0/home/create-home|
| [查询家庭](https://developer.tuya.com/cn/docs/cloud/0dbe66fef6?id=Kawfjdzu0dava) | GET:/v1.0/homes/{home_id}|
| [修改家庭](https://developer.tuya.com/cn/docs/cloud/334c5cfcdb?id=Kawfje8vm4n40) | PUT:/v1.0/homes/{home_id}|
| [删除家庭](https://developer.tuya.com/cn/docs/cloud/6889fd21cf?id=Kawfjei1b8ci4) | DELETE:/v1.0/homes/{home_id}|
| [查询家庭下的设备列表](https://developer.tuya.com/cn/docs/cloud/d7ee73aadb?id=Kawfjer0wkt2a) | GET:/v1.0/homes/{home_id}/devices|
| [查询家庭成员列表信息](https://developer.tuya.com/cn/docs/cloud/9e1fa96cca?id=Kawfjf04nr6dd) | GET:/v1.0/homes/{home_id}/members|
| [添加家庭成员 ](https://developer.tuya.com/cn/docs/cloud/83bc26c9d3?id=Kawfjf96h07rc) | POST:/v1.0/homes/{home_id}/members|
| [修改家庭成员信息](https://developer.tuya.com/cn/docs/cloud/9a1353697a?id=Kawfjfigqx7va) | PUT:/v1.0/homes/{home_id}/members/{uid}|
| [删除家庭成员](https://developer.tuya.com/cn/docs/cloud/cd4ca9d9af?id=Kawfjfrashst0) | DELETE:/v1.0/homes/{home_id}/members/{uid}|
| [添加房间](https://developer.tuya.com/cn/docs/cloud/42590b6dcc?id=Kawfjg0brs1zl) | POST:/v1.0/homes/{home_id}/room|
| [查询家庭下的房间列表](https://developer.tuya.com/cn/docs/cloud/5a2fe10caa?id=Kawfjg9hodgdw) | GET:/v1.0/homes/{home_id}/rooms|
| [删除房间](https://developer.tuya.com/cn/docs/cloud/cf7a22a637?id=Kawfjgin5zae3) | DELETE:/v1.0/homes/{home_id}/rooms/{room_id}|
| [修改房间名称](https://developer.tuya.com/cn/docs/cloud/04635dba27?id=Kawfjgribi8tq) | PUT:/v1.0/homes/{home_id}/rooms/{room_id}|
| [查询家庭房间设备](https://developer.tuya.com/cn/docs/cloud/23ecef19df?id=Kawfjh0l67rd9) | GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices|
| [查询⽤户家庭列表](https://developer.tuya.com/cn/docs/cloud/f5dd40ed14?id=Kawfjh9hpov1n) | GET:/v1.0/users/{uid}/homes|
| [新增房间内的设备](https://developer.tuya.com/cn/docs/cloud/580cf6d356?id=Kawfjhifn3l0x) | POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices|
| [修改家庭下房间内的设备](https://developer.tuya.com/cn/docs/cloud/ecdaced5c6?id=Kawfjhri0bzhd) | PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices|
| [删除家庭下房间内的设备](https://developer.tuya.com/cn/docs/cloud/d3e25dfd74?id=Kawfji0jh3voy) | DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices|
| [获取设备列表](https://developer.tuya.com/cn/docs/cloud/7ccd629a6c?id=Kconjb15xpvd3) | GET:/v1.0/devices|
## 全屋用户管理
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [同步用户](https://developer.tuya.com/cn/docs/cloud/21707ff1ba?id=Kawfjd7120rb0) | POST:/v1.0/apps/{schema}/user|
| [获取用户信息](https://developer.tuya.com/cn/docs/cloud/cfebf22ad3?id=Kawfjdgic5c0w) | GET:/v1.0/users/{uid}/infos|
| [获取用户列表](https://developer.tuya.com/cn/docs/cloud/76f3e0885f?id=Kawfji9n0sdmq) | GET:/v2.0/apps/{schema}/users|
| [取消删除](https://developer.tuya.com/cn/docs/cloud/7795856216?id=Kawfjiiunt8nm) | POST:/v1.0/users/{uid}/actions/cancel-delete|
| [用户预删除](https://developer.tuya.com/cn/docs/cloud/bbd768f1a4?id=Kawfjirpecmr9) | POST:/v1.0/users/{uid}/actions/pre-delete|
| [获取用户的设备列表](https://developer.tuya.com/cn/docs/cloud/ad2823ae46?id=Kconjtzq1vk1q) | GET:/v1.0/users/{uid}/devices|
## 全屋应用管理
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [获取应用详情](https://developer.tuya.com/cn/docs/cloud/0ebeab240f?id=Kawfawol4q13d) | GET:/v1.0/apps/{schema}|
| [获取应用的名称、logo、描述、创建时间等](https://developer.tuya.com/cn/docs/cloud/a545296b59?id=Kbi8cu9is5f82) | GET:/v1.1/apps/{schema}|
## 全屋配网管理
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [获取子设备列表](https://developer.tuya.com/cn/docs/cloud/cacbce6b79?id=Ka7kk1hiphgsq) | GET:/v1.0/devices/{deviceId}/list-sub|
| [允许子设备入网](https://developer.tuya.com/cn/docs/cloud/f621a0d195?id=Ka7kk1wyebguk) | PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery|
| [获取配网设备列表](https://developer.tuya.com/cn/docs/cloud/469697c782?id=Ka7kk2ca9vv30) | GET:/v1.0/device/paring/tokens/{token}|
## 全屋设备管理
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [查询网关下 Zigbee 设备](https://developer.tuya.com/cn/docs/cloud/fd92a062fa?id=Kd30e9f9fm3w6) | GET:/v1.0/devices/{deviceId}/sub-devices|
| [批量查询设备出厂信息](https://developer.tuya.com/cn/docs/cloud/75f8d057b8?id=Ka7kjx0i4m255) | GET:/v1.0/devices/factory-infos|
| [修改设备名称](https://developer.tuya.com/cn/docs/cloud/a358769080?id=Ka7kjxvo4fcck) | PUT:/v1.0/devices/{device_id}|
| [查询设备日志](https://developer.tuya.com/cn/docs/cloud/0a30fc557f?id=Ka7kjybdo0jse) | GET:/v1.0/devices/{device_id}/logs|
| [恢复设备出厂设置](https://developer.tuya.com/cn/docs/cloud/b509cc39f0?id=Ka7kjyramq32j) | PUT:/v1.0/devices/{device_id}/reset-factory|
| [获取设备详情](https://developer.tuya.com/cn/docs/archived-documents/aaed54c509?id=Kd9d5jc76leu0) | GET:/v1.0/devices/{deviceId}|
| [移除设备](https://developer.tuya.com/cn/docs/archived-documents/e67c990de9?id=Kd9d5gpp1w0nn) | DELETE:/v1.0/devices/{deviceId}|
| [获取设备状态](https://developer.tuya.com/cn/docs/archived-documents/2169b22ef1?id=Kd9d5gflfoav8) | GET:/v1.0/devices/{deviceId}/status|
| [获取设备列表 v2](https://developer.tuya.com/cn/docs/cloud/997abb41b9?id=Ka7kk116tsy0c) | GET:/v2.0/devices|
| [批量查询关联 App 用户维度设备列表](https://developer.tuya.com/cn/docs/cloud/fc19523d18?id=Kakr4p8nq5xsc) | GET:/v1.0/iot-01/associated-users/devices|
| [删除用户](https://developer.tuya.com/cn/docs/cloud/651ed36cf4?id=Karrvqb08mcdl) | DELETE:/v1.0/devices/{device_id}/users/{user_id}|
| [修改设备成员](https://developer.tuya.com/cn/docs/cloud/f4490c1999?id=Katuezkphh9n5) | PUT:/v1.0/devices/{device_id}/users/{user_id}|
| [查询设备成员信息](https://developer.tuya.com/cn/docs/cloud/75bface38d?id=Katuew1w5k2ua) | GET:/v1.0/devices/{device_id}/users/{user_id}|
| [新增设备成员](https://developer.tuya.com/cn/docs/cloud/846b71d903?id=Katueyj54gace) | POST:/v1.0/devices/{device_id}/user|
| [根据设备 ID查询成员信息列表](https://developer.tuya.com/cn/docs/cloud/4da81b7cd1?id=Kcgu2b5ko311e) | GET:/v1.0/devices/{device_id}/users|
## 全屋设备控制
| API名称 | 接口地址 |
| :------------- | :---------------- |
| [修改功能点名称](https://developer.tuya.com/cn/docs/cloud/d33378b16a?id=Ka7kk2sso8177) | PUT:/v1.0/devices/{device_id}/functions/{function_code}|
| [控制设备](https://developer.tuya.com/cn/docs/cloud/8125a2f727?id=Kd4f9okcnf292) | POST:/v1.0/devices/{deviceId}/commands|
| [获取设备支持的指令集](https://developer.tuya.com/cn/docs/archived-documents/373f533b7c?id=Kd9d5j591rg9w) | GET:/v1.0/devices/{deviceId}/functions|
| [获取设备规格属性](https://developer.tuya.com/cn/docs/archived-documents/7e213a32f7?id=Kd9d5gkvhy62x) | GET:/v1.0/devices/{deviceId}/specifications|
| [按品类获取指令集](https://developer.tuya.com/cn/docs/cloud/e2e046207e?id=Ka7kk4hx3ryv3) | GET:/v1.0/functions/{category}|
| [批量获取指令集](https://developer.tuya.com/cn/docs/cloud/00eb24be6a?id=Kafh6yip67ui0) | GET:/v1.0/devices/functions|
| [获取设备规格属性](https://developer.tuya.com/cn/docs/cloud/f2c0abfbbd?id=Kb26d4cf4wnrd) | GET:/v1.1/devices/{device_id}/specifications|