1. 创建家庭

1.1. 调用场景

任何用户都可以APP里创建家庭(home)。家庭是房间(room)的集合。家庭和房间在不同场景下有其特殊的应用。家庭可以用作机构的代号。房间可以作为养老院里的各个房间。

在地球号世界观里,设备一定是绑定在某个家庭的某个房间里。像海贼王里的罗一样,他的能力是room,就是在空间的意思。

在小米家庭应用中arqhome中,用户先创建家庭,然后设置房间,然后把设备绑定到某个房间上。

1.2. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type body String 0 未知种类
name body String Minew 家庭的平台系统名字,由录入者自定义
note body String 这是一个* 家庭的备注字段,简介,描述

1.3. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的家庭ID

1.4. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

1.5. SDK调用



const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

const add_params = {
    type:0,                 /*类别*/
    name:"我的家庭",        /*名字*/
    note:"我在云南的家",    /*备注*/
}

let res = await xduaClient.addHome(add_params)
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}
```

{% sample lang="php" -%}


```bash

2. 删除家庭。

2.1. 调用场景

在像米家这样的APP中,删除家庭=移除家庭,这样的接口必然牵扯到家庭里的房间也要删除,家庭里的成员也要删除。这种操作太危险了。

所以我们要求自删除家庭前,需要手动删除家庭里绑定的设备,家庭成员,只有它里面的东西为空,才可以正常删除。

2.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelHome
URL https://api.xdua.com/home
Method DELETE
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DEL
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有资源创建者自己可以访问这个口
XduaApiRoles God Zoon可以删除家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction DeleteHome
XduaApiRule DeleteHome
XduaApiAstates 0 所有state检查
XduaApiEnable true 接口使能

2.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

2.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

2.5. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

3. SDK调用



const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的删除操作是不会成功的,
 * 因为"TeStTeSt"作为一个测试家庭是不可以被删除的。如果为了测试,可以新建一个家庭,然后立刻删除。
 *--------------------------*/
const home_id ="TeStTeSt"; //要删除的家庭ID
let res = await xduaClient.delHome(home_id)
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

4. 关闭家庭。

4.1. 调用场景

冻结家庭,在更高权限把家庭冻结后,家庭资源不可以被更新,删除,修改。

4.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DIS
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖家庭,只有这个家庭的登录人员才可以访问
XduaApiSubject i 必须是创建者才可以自闭家庭
XduaApiRoles Admin 只有神级管理员才可以关闭普通开发者的家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction DisableHometmpl
XduaApiRule DisableHometmpl
XduaApiAstates 0,0 或者0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

4.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

4.5. 错误码

5. 软删家庭。

5.1. 调用场景

开发者登录超级控制台后,可以点击自己的家庭,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。

5.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DOL
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有创建者自己才能删除自己创建的家庭
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction DeletoHometmpl
XduaApiRule DeletoHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

5.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

5.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

5.5. 错误码

6. 打开家庭。

6.1. 调用场景

管理员(Zoon)

  1. 登录http://consolex.xdua.com后,
  2. 根据条件查询家庭,条件是某个被冻结的家庭。
  3. 点击解冻,可以解冻店铺。

6.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ENB
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 神登录后解冻开发者的家庭
XduaApiRoles Admin 只有神才可以解冻家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction EnableHometmpl
XduaApiRule EnableHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

6.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

6.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

6.5. 错误码

7. 描述

详情家庭。

7.1. 调用场景

管理员登录超级控制台后,可以随意查询能看见的所有家庭列表。点击其中一个家庭(不管是不是自己的),就可以点击访问。

7.2. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/hometmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i !表示除了允许匿名家庭之外的所有家庭访问
XduaApiRoles Zoon 只要Zoon才可以访问其它家庭的家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction GetHometmpl
XduaApiRule GetHometmpl
XduaApiHometmplAstate 0 家庭zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 家庭corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 家庭shop.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭 home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭home.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

7.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要修改的家庭ID

7.4. 返回参数

名称 位置 类型 示例 说明
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
home_id string 所属户群的id
home_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 家庭请求时客户端的HometmplAgent
exp int 家庭的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。
vtl int 家庭的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的home计算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部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

7.5. 错误码

8. 私详家庭。

8.1. 调用场景

开发者登录超级控制台后,在家庭列表,选择家庭,点击详情,就可以查看自己的家庭。GIT的默认字段和GET不一样。

8.2. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/hometmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的家庭
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction GetHometmpl
XduaApiRule GetHometmpl
XduaApiHometmplAstate 0 家庭zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 家庭corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 家庭shop.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭 home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 家庭home.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

8.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要修改的家庭ID

8.4. 返回参数

名称 位置 类型 示例 说明
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": {


    },
}

8.5. 错误码

9. 下线家庭。

9.1. 调用场景

开发者登录超级控制台后,可以下线自己创建的家庭。

9.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只能家庭的创建者才能下线自己的家庭
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction OfflineHometmpl
XduaApiRule OfflineHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

9.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

9.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

9.5. 错误码

10. 发布家庭。

10.1. 调用场景

开发者登录超级控制台后,可以下线/发布自己的家庭。这个动作是管理员不能干涉的。

10.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有家庭的创建者自己才能上下线自己的家庭
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction OnlineHometmpl
XduaApiRule OnlineHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

10.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

10.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

10.5. 错误码

11. 私查家庭。

11.1. 调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有家庭。

11.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriHometmpl
URL https://api.xdua.com/hometmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 所有注册家庭均可以使用
XduaApiRoles Zoon 必须是Zoon才可以查询角色
XduaApiResource home
XduaApiKparam where 常量
XduaApiAction QueriHometmpl
XduaApiRule QueriHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

11.3. URL

GET:https://api.xdua.com/hometmpl

11.4. 请求参数

参考标准查询接口请求参数

11.5. 返回参数

参考标准查询接口返回参数

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 家庭最近更新时间

11.6. 错误码

12. 查询家庭。

12.1. 调用场景

开发者登录http://consolex.xdua.com后,可以以God角色查询属于所有家庭。

12.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryHome
URL https://api.xdua.com/home
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册家庭均可以使用
XduaApiRoles God 必须是Zoon才可以查询角色
XduaApiResource home
XduaApiKparam where 常量where
XduaApiAction QueryHome
XduaApiRule QueryHome
XduaApiAstates 0 所有状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

12.3. URL GET:https://api.xdua.com/home

12.4. 请求参数

参考标准查询接口请求参数

12.5. 返回参数

参考标准查询接口返回参数

12.6. fields为@all时返回的参数

result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。

名称 位置 类型 示例 说明
id result.list[] string rYub4wrT 详情的家庭ID
name result.list[] string 家庭的名称
rank result.list[] int 家庭的排序
note result.list[] int 家庭信息的备注
type_id result.list[] string 家庭种类的ID
type_name result.list[] string 家庭种类的名
vila_id result.list[] string 家庭小区的ID
vila_name result.list[] string 家庭小区的名
home_id result.list[] string 家庭家庭的ID
home_name result.list[] string 家庭家庭的名
shop_id result.list[] string 家庭店铺的ID
shop_name 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 辣椒帅 家庭创建者名字
updator_id result.list[] string XiyRvUp3 家庭最近一次更新者ID
updator_name result.list[] string 周海潮 家庭最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 家庭创建时间
ustamp result.list[] string 2020-01-20 02:23:24 家庭最近更新时间

12.7. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

12.8. SDK调用

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "查询家庭";


/*------------------------------------------------------
 * 分页查询制造商Minew的所有家庭,显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{man:"Minew"}    
}

/*------------------------------------------------------
 * 分页查询不是制造商Minew的所有家庭,显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{"man[!]":"Minew"}    
}

/*------------------------------------------------------
 * 分页查询制造商是Minew和xdua.com的所有家庭,显示第1页,每页显示20条
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:2,
    where:{
        man:["Minew","xdua.com"],
    }    
}

/*------------------------------------------------------
 * 分页查询家庭名字是`虚拟网关`
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        name:"虚拟网关",
    }    
}

/*------------------------------------------------------
 * 分页查询家庭名字包含`网关`二字,这是一种模糊查询方式,注意两点
 * 1. 要有`[~]`
 * 2. 字串模糊的地方要有%,`%网关%`表示前后都可能有其它串,`%网关`表示必须以`网关`结尾。
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        "name[~]":"%网关%",
    }    
}



const res_api = await xduaClient.qryHome(query_params)

if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

13. 回收家庭。

13.1. 调用场景

管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的家庭。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的家庭的名字。

13.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i u表示除了允许匿名家庭之外的所有家庭访问
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction RecycleHometmpl
XduaApiRule RecycleHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

13.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的家庭ID

13.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的家庭ID

13.5. 错误码

14. 更新家庭

修改家庭信息。

14.1. 调用场景

开发者登录超级控制台后,可以修改自己创建的家庭。开发者以God角色修改家庭。未来可能开放给专门的家庭/设备运维。

14.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name Sethome
URL https://api.xdua.com/home
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles God 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction UpdateHome
XduaApiRule UpdateHome
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

14.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path String 6tYu82hM 家庭ID
type body String Mats 家庭类型代码,本字段受home_type表的code字段外键约束
man body String Minew 制造商代码,本字段受home_man表的code字段外键约束
model body String CBOX-7 制造商代码,从家庭的包装盒,介绍中获取
name body String 蓝牙网关 家庭的平台系统名字,由录入者自定义
vlot body Integer 3600 家庭的日志存活时间
brief body String 这是一个* 家庭的介绍
cost body Double 45.0 家庭的采购价格或者平摊下来的生产制造价格
earn body Double 60.0 对外销售价格,包含设置人工成本

14.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的家庭ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的家庭名",
        "brief":"新的家庭介绍",    
    }    
}

14.5. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

14.6. SDK调用

为了方便测试SetHome接口。数据库专门提供了一个测试家庭home_id=TeStTeSt。可以对这个家庭的所有属性进行修改,而不用担心损坏数据库。

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "修改家庭";
const home_id ="TeStTeSt"; //要修改的家庭ID

/*----------------------------
 * 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数
 *--------------------------*/
const set_params = {
    type:"Test",        //类别
    model:"Motest3",    //型号
    vlot:360,           //它在日志表里存6分钟数据
    name:"测试家庭",    //名字
    man:"xdua.com",     //家庭生产商
    pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
    brief:"接口测试",   //简介
    earn:65,            //价格
    cost:45,            //成本
}

const res_api = await xduaClient.setHome(home_id,set_params)

if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

15. 修改家庭。

15.1. 调用场景

开发者登录超级控制台后,可以修改自己创建的家庭。修改仅仅限于可以修改的name,brief等字段。

15.2. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetHometmpl
URL https://api.xdua.com/hometmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神家庭,才可以创建家庭
XduaApiAudience ConsoleX 只有home_id为ConsoleX的家庭,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 家庭直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Zoon 只要登录就可以创建家庭
XduaApiResource home
XduaApiKparam id
XduaApiAction UpdateHometmpl
XduaApiRule UpdateHometmpl
XduaApiAstates 0 按序home,zone,corp,shop,home,home,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

15.3. 请求参数

名称 位置 类型 必填 默认值 示例 说明
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码 可选

15.4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的家庭ID
ipdates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的家庭名",
        "brief":"新的家庭介绍",    
    }    
}

15.5. 错误码

results matching ""

    No results matching ""