1. 目录
| 缩名 | 全名 | 方法 | 中文 | 角色 | 描述 |
|---|---|---|---|---|---|
| ADD | Create | POST | 创建 | Zoon | 创建店铺 |
| DEL | Delete | DELETE | 删除 | Funder | 删除店铺 |
| SET | Update | PUT | 修改 | Zoon | 修改店铺 |
| DOL | Deleto | PUT | 软删 | Zoon | 软删店铺 |
| DIS | Disable | PUT | 关闭 | Ceo | 关闭店铺 |
| ENB | Enable | PUT | 打开 | Ceo | 打开店铺 |
| RCC | Recycle | PUT | 回收 | Ceo | 回收店铺 |
| PUB | Publish | PUT | 发布 | Zoon | 发布店铺 |
| OFF | Offline | PUT | 下线 | Zoon | 下线店铺 |
| GET | Get | GET | 详情 | Ceo | 详情店铺 |
| GIT | Git | GET | 私详 | Zoon | 私详店铺 |
| QRY | Query | GET | 查询 | Ceo | 查询店铺 |
| QRI | Queri | GET | 私查 | Zoon | 私查店铺 |
2. 创建房物。
调用场景
店长登录超级控制台后,可以以Shep角色创建自己的房物。房物创建目前只能由Butler进行。
请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| type | body | String | 是 | 无 | Mats | 房物类型代码,本字段受rood_type表的code字段外键约束 |
| name | body | String | 是 | 无 | Mats | 房物名称 |
| room_id | body | String | 是 | 无 | Minew | 房间的ID |
| dev_id | body | String | 是 | 无 | Minew | 设备的ID |
返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 创建的房物ID |
错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
调用代码
3. 删除房物。
4. 调用场景
God在超级控制台登录. 它会让资源永久消失。但要删除一个房物，你需要把房物对应的所有设备都删除，才能删除房物。
5. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | DelRood | |
| URL | https://api.xdua.com/rood | |
| Method | DELETE | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | DEL | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
| XduaApiRoles | God | Zoon可以删除房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | DeleteRood | |
| XduaApiRule | DeleteRood | |
| XduaApiAstates | 0 | 所有state检查 |
| XduaApiEnable | true | 接口使能 |
6. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要删除的房物ID |
7. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 删除的房物ID |
8. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
9. SDK调用
</code></pre> </div>
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})/*----------------------------
- 运行如下代码
- 下面的删除操作是不会成功的，
- 因为"TeStTeSt"作为一个测试房物是不可以被删除的。如果为了测试，可以新建一个房物，然后立刻删除。
--------------------------/
const rood_id ="TeStTeSt"; //要删除的房物ID
let res = await xduaClient.delRood(rood_id)
if(res.error == 0){
console.log("测试成功");
}else{ console.log("测试失败");
console.log(res); } </code></pre> </div>文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
</code></pre>
</div></div></div>
# 描述
关闭房物。
# 调用场景
神管理员登录[超级控制台](http://consolex.xdua.com)后,可以关闭普通开发者的房物。使得房物进入DISABLED状态，也只有Zoon角色重新打开这个房物。
管理员（Zoon）
1. 登录[http://consoler.{zond_id}.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询房物，条件是某个房物。
3. 点击`冻结`，可以关闭房物。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |DisRoodtmpl | |
|URL |https://api.xdua.com/roodtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |DIS | |
|XduaApiColor |X | 只有持有神房物，才可以创建房物 |
|XduaApiAudience |ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房物直辖房物,只有这个房物的登录人员才可以访问|
|XduaApiSubject |i | 必须是创建者才可以自闭房物|
|XduaApiRoles |Admin | 只有神级管理员才可以关闭普通开发者的房物|
|XduaApiResource |rood | |
|XduaApiKparam |id | |
|XduaApiAction |DisableRoodtmpl | |
|XduaApiRule |DisableRoodtmpl | |
|XduaApiAstates |`0,0` 或者`0` | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房物ID |
# 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房物ID |
# 错误码
# 描述
软删房物。
# 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以点击自己的房物，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |DolRoodtmpl | |
|URL |https://api.xdua.com/roodtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |DOL | |
|XduaApiColor |X | 只有持有神房物，才可以创建房物 |
|XduaApiAudience |ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 只有创建者自己才能删除自己创建的房物|
|XduaApiRoles |Zoon | 只要登录就可以创建房物|
|XduaApiResource |rood | |
|XduaApiKparam |id | |
|XduaApiAction |DeletoRoodtmpl | |
|XduaApiRule |DeletoRoodtmpl | |
|XduaApiAstates |0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房物ID |
# 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房物ID |
# 错误码
# 描述
打开房物。
# 调用场景
管理员（Zoon）
1. 登录[http://consolex.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询房物，条件是某个被冻结的房物。
3. 点击`解冻`，可以解冻店铺。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |EnbRoodtmpl | |
|URL |https://api.xdua.com/roodtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |ENB | |
|XduaApiColor |X | 只有持有神房物，才可以创建房物 |
|XduaApiAudience |ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |u | 神登录后解冻开发者的房物|
|XduaApiRoles |Admin | 只有神才可以解冻房物|
|XduaApiResource |rood | |
|XduaApiKparam |id | |
|XduaApiAction |EnableRoodtmpl | |
|XduaApiRule |EnableRoodtmpl | |
|XduaApiAstates |0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房物ID |
# 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房物ID |
# 错误码
# 描述
详情房物。
# 调用场景
管理员登录[超级控制台](http://consolex.xdua.com)后,可以随意查询能看见的所有房物列表。点击其中一个房物（不管是不是自己的），就可以点击访问。
# 配置参数
|参数名 |参数值 |说明 |
|------ |------ |---- |
|URL |https://api.xdua.com/roodtmpl| |
|Method |GET | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |GET | |
|XduaApiColor |X | 只有持有神房物，才可以创建房物 |
|XduaApiAudience |ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | !表示除了允许匿名房物之外的所有房物访问|
|XduaApiRoles |Zoon | 只要Zoon才可以访问其它房物的房物|
|XduaApiResource |rood | |
|XduaApiKparam |id | |
|XduaApiAction |GetRoodtmpl | |
|XduaApiRule |GetRoodtmpl | |
|XduaApiRoodtmplAstate |0 | 房物zone.state必须是0(STATE_ENABLED) |
|XduaApiCorpAstate |0 | 房物corp.state必须是0(STATE_ENABLED) |
|XduaApiShopAstate |0 | 房物shop.state必须是0(STATE_ENABLED) |
|XduaApiRoodtmplAstate |0 | 房物rood.state必须是0(STATE_ENABLED) |
|XduaApiRoodtmplAstate |0 | 房物 rood.state必须是0(STATE_ENABLED) |
|XduaApiRoodtmplAstate |0 | 房物rood.state必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要修改的房物ID |
# 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |result |string |rYub4wrT |详情的角权ID |
|name |result.data |string | |角权的名称 |
|code |result.data |string | |角权的执照号 |
|type |result.data |string | |角权的种类 |
|avatar |result.data |string | |角权图标 |
|brief |result.data |string | |角权的描述 |
|state |result.data |int |1 |角权的状态 |
|stato |result.data |string |"冻服更新" |角权的状态说明 |
|expire |result.data |int |0 |角权状态过期时间(UNIX时间戳) |
|creator_id |result.list[] |string |Dmtv7TrE |社区创建者ID |
|creator_name |result.list[] |string |辣椒帅 |社区创建者名字 |
|ipdator_id |result.list[] |string |XiyRvUp3 |社区最近一次更新者ID |
|ipdator_name |result.list[] |string |周海潮 |社区最近一次更新者名字 |
|cstamp |result.data |string |2020-01-20 02:19:55 |角权创建时间 |
|istamp |result.data |string |2020-01-20 02:23:24 |角权最近更新时间 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|id |string |角权的id |
|rood_id |string |所属户群的id |
|rood_name |string |所属户群的名字 |
|igrp_id |string |所属户群的id |
|igrp_name |string |所属户群的名字 |
|code |string |角权的代号 |
|name |string |角权名 |
|brief |string |角权说明 |
|avatar |string |角权的头像 |
|enabeld |int |角权的使能状态 |
|cstamp |string |创建的时间戳字符串 |
|istamp |string |更新的时间戳字符串 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|id |string |角权的id |
|roue_id |string |所属户群的id |
|roue_name |string |所属户群的名字 |
|igrp_id |string |所属户群的id |
|igrp_name |string |所属户群的名字 |
|code |string |角权的代号 |
|name |string |角权名 |
|brief |string |角权说明 |
|avatar |string |角权的头像 |
|enabeld |int |角权的使能状态 |
|cstamp |string |创建的时间戳字符串 |
|istamp |string |更新的时间戳字符串 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|verified|int |1=房物是有效的|
|did |string |请求该房物的设备id|
|uid |string |房物吃鱼者房物id。匿名房物的房物永远是anonymus|
|did |string |请求该房物的设备id|
|aid |string |请求该房物的设备id|
|aud |string |请求该房物的应用的名字,本字段与aid对应|
|nbf |int |Not Before房物生效时间之前|
|iss |string |房物签发机关。在地球号服务中本字段为常值lovearth|
|iat |string |房物签发UTC时间戳|
|ip |string |房物请求时客户端的ip|
|ua |string |房物请求时客户端的RoodtmplAgent|
|exp |int |房物的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。|
|vtl |int |房物的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的rood计算vtl为0时，会自动被重置为-1|
|ugrp |string |房物持有房物所在的房物群,匿名房物的户群是常量:"XdUaXduA"|
|role |string |房物持有房物所在的角色列表,匿名房物的角色列表是常量:"none"|
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |result |string |rYub4wrT |详情的房物ID |
|name |result.data |string | |房物的名称 |
|code |result.data |string | |房物的执照号 |
|type |result.data |string | |房物的种类 |
|avatar |result.data |string | |房物图标 |
|brief |result.data |string | |房物的描述 |
|state |result.data |int |1 |房物的状态 |
|stato |result.data |string |"冻服更新" |房物的状态说明 |
|expire |result.data |int |0 |房物状态过期时间(UNIX时间戳) |
|creator_id |result.list[] |string |Dmtv7TrE |社区创建者ID |
|creator_name |result.list[] |string |辣椒帅 |社区创建者名字 |
|updator_id |result.list[] |string |XiyRvUp3 |社区最近一次更新者ID |
|updator_name |result.list[] |string |周海潮 |社区最近一次更新者名字 |
|cstamp |result.data |string |2020-01-20 02:19:55 |房物创建时间 |
|ustamp |result.data |string |2020-01-20 02:23:24 |房物最近更新时间 |
> [!note]
> 房物的使能状态,0:打开 1:关闭. 关闭的房物处于冻结状态,不接受登陆/注册所有操作.
#### 返回示例
result部分
```json
{
"id":"rYub4wrT",
"data": {
},
}
10. 错误码
11. 描述
私详房物。
12. 调用场景
开发者登录超级控制台后,在房物列表，选择房物，点击详情，就可以查看自己的房物。GIT的默认字段和GET不一样。
13. 配置参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| URL | https://api.xdua.com/roodtmpl | |
| Method | GET | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | GIT | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 只有自己才可以访问自己创建的房物 |
| XduaApiRoles | Zoon | 只要登录就可以创建房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | GetRoodtmpl | |
| XduaApiRule | GetRoodtmpl | |
| XduaApiRoodtmplAstate | 0 | 房物zone.state必须是0(STATE_ENABLED) |
| XduaApiCorpAstate | 0 | 房物corp.state必须是0(STATE_ENABLED) |
| XduaApiShopAstate | 0 | 房物shop.state必须是0(STATE_ENABLED) |
| XduaApiRoodtmplAstate | 0 | 房物rood.state必须是0(STATE_ENABLED) |
| XduaApiRoodtmplAstate | 0 | 房物 rood.state必须是0(STATE_ENABLED) |
| XduaApiRoodtmplAstate | 0 | 房物rood.state必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
14. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要修改的房物ID |
15. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 详情的房物ID |
| name | result.data | string | 房物的名称 | |
| avatar | result.data | string | 房物图标 | |
| brief | result.data | string | 房物的描述 | |
| state | result.data | int | 1 | 房物的状态 |
| stato | result.data | string | "冻服更新" | 房物的状态说明 |
| expire | result.data | int | 0 | 房物状态过期时间(UNIX时间戳) |
| creator_id | result.list[] | string | Dmtv7TrE | 房物创建者ID |
| creator_name | result.list[] | string | 辣椒帅 | 房物创建者名字 |
| ipdator_id | result.list[] | string | XiyRvUp3 | 房物最近一次更新者ID |
| ipdator_name | result.list[] | string | 周海潮 | 房物最近一次更新者名字 |
| cstamp | result.data | string | 2020-01-20 02:19:55 | 房物创建时间 |
| istamp | result.data | string | 2020-01-20 02:23:24 | 房物最近更新时间 |
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
16. 错误码
17. 描述
下线房物。
18. 调用场景
开发者登录超级控制台后,可以下线自己创建的房物。
19. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | OffRoodtmpl | |
| URL | https://api.xdua.com/roodtmpl | |
| Method | PUT | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | OFF | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 只能房物的创建者才能下线自己的房物 |
| XduaApiRoles | Zoon | 只要登录就可以创建房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | OfflineRoodtmpl | |
| XduaApiRule | OfflineRoodtmpl | |
| XduaApiAstates | 0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
20. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要删除的房物ID |
21. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 删除的房物ID |
22. 错误码
23. 描述
发布房物。
24. 调用场景
开发者登录超级控制台后,可以下线/发布自己的房物。这个动作是管理员不能干涉的。
25. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | PubRoodtmpl | |
| URL | https://api.xdua.com/roodtmpl | |
| Method | PUT | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | PUB | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 只有房物的创建者自己才能上下线自己的房物 |
| XduaApiRoles | Zoon | 只要登录就可以创建房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | OnlineRoodtmpl | |
| XduaApiRule | OnlineRoodtmpl | |
| XduaApiAstates | 0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
26. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要删除的房物ID |
27. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 删除的房物ID |
28. 错误码
29. 描述
私查房物。
30. 调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有房物。
31. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | QriRoodtmpl | |
| URL | https://api.xdua.com/roodtmpl | |
| Method | GET | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | QRI | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 所有注册房物均可以使用 |
| XduaApiRoles | Zoon | 必须是Zoon才可以查询角色 |
| XduaApiResource | rood | |
| XduaApiKparam | where |
常量 |
| XduaApiAction | QueriRoodtmpl | |
| XduaApiRule | QueriRoodtmpl | |
| XduaApiAstates | 0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
32. URL
GET:https://api.xdua.com/roodtmpl
33. 请求参数
34. 返回参数
result.list部分
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 详情的房物ID |
| name | result.list[] | string | 房物的名称 | |
| avatar | result.list[] | string | 房物图标 | |
| brief | result.list[] | string | 房物的描述 | |
| state | result.list[] | int | 0 | 房物的状态 |
| stato | result.list[] | string | "冻服更新" | 房物的状态说 |
| expire | result.list[] | int | 0 | 房物状态过期时间(UNIX时间戳) |
| creator_id | result.list[] | string | Dmtv7TrE | 房物创建者ID |
| creator_name | result.list[] | string | 辣椒帅 | 房物创建者名字 |
| ipdator_id | result.list[] | string | XiyRvUp3 | 房物最近一次更新者ID |
| ipdator_name | result.list[] | string | 周海潮 | 房物最近一次更新者名字 |
| cstamp | result.list[] | string | 2020-01-20 02:19:55 | 房物创建时间 |
| istamp | result.list[] | string | 2020-01-20 02:23:24 | 房物最近更新时间 |
35. 错误码
36. 描述
查询房物。
37. 调用场景
38. GET
39. 请求参数
查询房间"9COkOKGl"里绑定的设备
data: {
limit: '10', //每次查询返回的行数
page: '0', //第几页
sort: 'inc:DESC', //按时间倒叙
where: '{"room_id" : "9COkOKGl"}'//查询房间id是"9COkOKGl"的房间里的设备
}
查询家庭"15rTsVWR"里绑定的设备
data: {
limit: '10', //每次查询返回的行数
page: '0', //第几页
sort: 'inc:DESC', //按时间倒叙
where: '{"home_id" : "15rTsVWR"}'//查询家庭"9COkOKGl"里的所有设备
}
40. 返回参数
result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | body.list[] | string | rYub4wrT | 家庭ID |
| type | body.list[] | number | 0 | 本字段暂时无意义，未来用 |
| name | body.list[] | string | 样板间的床垫 |
为本次绑定设置的备注 |
| room_id | body.list[] | string | "P4lTCMkE" |
房间id,如果没有房间，这个字段可以忽略 |
| room_name | body.list[] | string | 高档房间201室 |
房间名字,如果没有房间设计，这个字段可以忽略。 |
| home_id | body.list[] | string | "15rTsVWR" |
房间id,如果没有房间，这个字段可以忽略 |
| home_name | body.list[] | string | 济南分所养老院 |
或者是“焦帅的家”这样的 |
| note | body.list[] | string | 测试案例 |
备注 |
| dev_id | body.list[] | string | dQ9js7is |
备注 |
| dev_vstr | body.list[] | string | 1111,91,17,* |
这是设备值的字符串 |
| cstamp | body.list[] | string | 2020-01-20 02:19:55 | 邀请创建时间 |
"list": [
{
"id": "hmaJWQK4",
"type": 0,
"name": "样板间的床垫",
"room_id": "P4lTCMkE",
"room_name": "样板间",
"devp_id": "MRpdfSTF",
"dev_id": "dQ9js7is",
"devp_name": "心率床垫",
"home_id": "15rTsVWR",
"home_name": "济南分所",
"cstamp": "2022-09-22 11:27:23",
"dev_vstr": "",
}
41. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
42. SDK调用
import axios from "axios";
const options = {
method: 'GET',
url: 'http://api.svkernel.xdua.com/rood',
headers: {
Authorization: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2NjM4MTczNTUsIm5iZiI6MTY2MzgxNzM1NSwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2NjM4MjMzNTUsImF1ZCI6IkNvbnNvbGVFIiwic3ViIjoiRHQ1bXZydEUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiQiIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydEUiLCJhcGkiOiJDcmVhdGVMb2dpbiIsInpvbmUiOiJFbGRyQ2FSRSIsImNvcnAiOiJJY3RKaW5hbiIsInNob3AiOiJGYWNpbGl0eSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJzYXAiOiJTdktlcm5lTCIsImxnbiI6IjI1ME4xQzF1IiwidGlkIjoiaGxmUUN2bU0ifQ.c_LJyHfJ_nhFiQ5VCsehxpSwdC08aagqgCubAOmkXs0agNopJcoRiMzsQSUMfCjwdJzc3qWlXssInWortCBTdBMlsOFCU5sHs1hnOw72AthZwkD01JsXmA5NUocBA6WeRW7XO6EV-LUkadG7S13e1L_fqp6OQjOqvZw2HJmx25edLhxLaS18vcA3Pk1va1b_WBLI3569z6ekD-ILrLMomqu9HbS4jR_G6Xwf95d5VMtBzRq1PdpqrBDievMrzjMgIUCDKNFiyGiQ4sB1Co7ZCbQKPmxnO-Eenrm9KkNgvlfTDj_9wR_1N2Ia4q3f0v3qzmeA0WrlHQJv-EI8XEGECA'
},
data: {limit: '10', page: '1', sort: 'inc:DESC', schema: 'OR2', where: '{}'}
};
axios.request(options).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.error(error);
});
43. 回收房物。
44. 调用场景
管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的房物。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的房物的名字。
45. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | RccRoodtmpl | |
| URL | https://api.xdua.com/roodtmpl | |
| Method | PUT | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | RCC | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | u表示除了允许匿名房物之外的所有房物访问 |
| XduaApiRoles | Zoon | 只要登录就可以创建房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | RecycleRoodtmpl | |
| XduaApiRule | RecycleRoodtmpl | |
| XduaApiAstates | 0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
46. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要删除的房物ID |
47. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 删除的房物ID |
48. 错误码
49. 描述
修改房物信息。本接口是God可以访问的，God几乎可以修改Rood的所有属性。在未来，Rood的不重要属性可以被其它角色修改。
50. 调用场景
开发者登录超级控制台后,可以修改自己创建的房物。开发者以God角色修改房物。未来可能开放给专门的房物/设备运维。
51. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | SetRood | |
| URL | https://api.xdua.com/rood | |
| Method | PUT | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | SET | |
| XduaApiColor | X | 只有持有神房物，才可以创建房物 |
| XduaApiAudience | ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | i,只有创建者自己才可以修改 |
| XduaApiRoles | Butler | 只要登录就可以创建房物 |
| XduaApiResource | rood | |
| XduaApiKparam | id | |
| XduaApiAction | UpdateRood | |
| XduaApiRule | UpdateRood | |
| XduaApiAstates | 0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
52. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | String | 是 | 无 | 6tYu82hM | 房物ID |
| type | body | String | 否 | 无 | Mats | 房物类型代码,本字段受rood_type表的code字段外键约束 |
| name | body | String | 否 | 无 | 蓝牙网关 | 房物的平台系统名字，由录入者自定义 |
[!note|label:为什么修改操作只能修改type和name?] 因为rood本身就是两个元素room和dev的搭配，修改任何一个的效果等同于删除重建。
53. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 修改的房物ID |
| updates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的房物名",
"brief":"新的房物介绍",
}
}
54. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
55. SDK调用
为了方便测试SetRood接口。数据库专门提供了一个测试房物rood_id=TeStTeSt。可以对这个房物的所有属性进行修改,而不用担心损坏数据库。
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})/*----------------------------
- 运行如下代码
- 下面的代码是直接可以运行的 --------------------------/ api_name = "修改房物"; const rood_id ="TeStTeSt"; //要修改的房物ID
/*----------------------------
- 下面展示的是修改"TeStTeSt"所有属性的操作，实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Test", //类别 name:"测试房物", //名字 }
const res_api = await xduaClient.setRood(rood_id,set_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
</code></pre>
</div>
文档还没有实现
```{% sample lang="php" -%}
文档还没有实现
</code></pre>
</div></div></div>
# 描述
修改房物。
# 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的房物。修改仅仅限于可以修改的name,brief等字段。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |SetRoodtmpl | |
|URL |https://api.xdua.com/roodtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |SET | |
|XduaApiColor |X | 只有持有神房物，才可以创建房物 |
|XduaApiAudience |ConsoleX | 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房物直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | i,只有创建者自己才可以修改|
|XduaApiRoles |Zoon | 只要登录就可以创建房物|
|XduaApiResource |rood | |
|XduaApiKparam |id | |
|XduaApiAction |UpdateRoodtmpl | |
|XduaApiRule |UpdateRoodtmpl | |
|XduaApiAstates |0 | 按序rood,zone,corp,shop,rood,rood,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要修改的房物ID |
|name |body |string |否 | | |房物的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符 |
|avatar |body |string |否 | | |房物图标，不超过40个字符。|
|brief |body |string |否 | | |房物描述，不超过64个字符。|
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|-------- |-------- |------------ |
|user_id|path|String|用户m5d,登陆时获得|可选|
|oldpwd |body|String|旧房物,32位md5码|可选|
|pwd |body|String|新房物,32位md5码|可选|
# 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |修改的房物ID |
|ipdates |result |json dict | |修改的内容 |
#### 示例
result字段
```json
{
"id":"rYub4wrT",
"updates":{
"name":"新的房物名",
"brief":"新的房物介绍",
}
}