1. 目录

2. 创建家庭

任何用户都可以APP里创建家庭(home)。家庭是房间(room)的集合。家庭和房间在不同场景下有其特殊的应用。家庭可以用作机构的代号。房间可以作为养老院里的各个房间。在地球号世界观里，设备一定是绑定在某个家庭的某个房间里。像海贼王里的罗一样，他的能力是room,就是在空间的意思。 在小米家庭应用中arqhome中，用户先创建家庭，然后设置房间，然后把设备绑定到某个房间上。

调用方式

method: POST url: http://api.svkernel.xdua.com/home Content-Type: application/x-www-form-urlencoded

请求参数

返回参数

[!NOTE|label:如何判断成功?] 只要response.statusCode 是200就是执行成功,其他都算执行失败

错误码

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

调用代码

import axios from "axios";

const options = {
  method: 'POST',
  url: 'http://api.svkernel.xdua.com/home',
  headers: {
    Authorization: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2NjM3NDQ4NjYsIm5iZiI6MTY2Mzc0NDg2NiwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2NjM3NTA4NjYsImF1ZCI6IkNvbnNvbGVFIiwic3ViIjoiRHQ1bXZydEUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiQiIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydEUiLCJhcGkiOiJDcmVhdGVMb2dpbiIsInpvbmUiOiJFbGRyQ2FSRSIsImNvcnAiOiJJY3RKaW5hbiIsInNob3AiOiJGYWNpbGl0eSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJzYXAiOiJTdktlcm5lTCIsImxnbiI6IjI1ME4xQzF1IiwidGlkIjoiQlBRWnp1SEQifQ.ig3wR2iSFAQCPyn1sw4oSRT7YYrtxapmKhmhMkdPJN7TrkPbvdAorFHrSmQGdS5MkGQRs8MsNasrcvxeEAbsiGM0MyL-w5ddjixoSvblSchQBG2QU-3e8gOgML4ZBoN7yIq5fB67r-6IbpTjGlMfmS0bhbbNGkgQDVDqKoPYEIcflsP6FMWOWrktFNv22rp9vYuzde3np0y1EtLmOeeO4JhfYofnZ0KlgG04Ce3-sQ8eCBbjlUl24E1kw9FS-He7tr9yq_TNcCIHCCKyDiStJZkhl1UzzBoGFnbU1UzO6MK4GdOFM5C_hOXpI1QVgArJmzjhASGUZ1yz_PWhSDXYpQ'
  },
  data: {type: '0', name: '焦帅的家', note: ''}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

3. 删除家庭。

调用场景

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

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

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

4. 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

5. 关闭家庭。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

6. 软删家庭。

调用场景

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

请求参数

返回参数

错误码

7. 打开家庭。

调用场景

管理员（Zoon）

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

8. 描述

详情家庭。

调用场景

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

配置参数

请求参数

返回参数

[!note] 家庭的使能状态,0:打开 1:关闭. 关闭的家庭处于冻结状态,不接受登陆/注册所有操作.

返回示例

result部分

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


    },
}

错误码

9. 私详家庭。

调用场景

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

配置参数

请求参数

返回参数

返回示例

result部分

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


    },
}

错误码

10. 下线家庭。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

11. 发布家庭。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

12. 私查家庭。

调用场景

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

配置参数

参数意义参考接口参数

URL

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

请求参数

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

返回参数

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

result.list部分

错误码

13. 查询家庭。

调用方式

method: POST URL GET:https://api.xdua.com/home Content-Type: application/x-www-form-urlencoded

请求参数

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

举例

 data: {
    limit: '10',                        //每次查询返回的行数
    page: '0',                          //第几页
    sort: 'inc:DESC',                   //按时间倒叙
    schema: 'MINE',                     //MINE:查询自己创建的家庭
    where: '{}'                         //常数字符串:'{}'
  }

返回参数

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

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

"list": [
        {
            "note": "在济南的家",
            "name": "焦帅的家",
            "cstamp": "2022-09-21 15:07:41",
            "id": "KdZSf1Mi",
            "type": 0
        },
        {
            "note": "备注",
            "name": "我的家",
            "cstamp": "2022-09-15 12:34:00",
            "id": "15rTsVWR",
            "type": 0
        },
    ]

错误码

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

SDK调用

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'http://api.svkernel.xdua.com/home',
  headers: {
    Authorization: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2NjM3NTE0NTYsIm5iZiI6MTY2Mzc1MTQ1NiwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2NjM3NTc0NTYsImF1ZCI6IkNvbnNvbGVFIiwic3ViIjoiRHQ1bXZydEUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiQiIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydEUiLCJhcGkiOiJDcmVhdGVMb2dpbiIsInpvbmUiOiJFbGRyQ2FSRSIsImNvcnAiOiJJY3RKaW5hbiIsInNob3AiOiJGYWNpbGl0eSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJzYXAiOiJTdktlcm5lTCIsImxnbiI6IjI1ME4xQzF1IiwidGlkIjoiNUNSRkduNUkifQ.CT-sBIMFMY90fYWxmQSoYGXGmEQrJm3aSxF-xjVKycMwYjihhf64xNvNXq4yyKwXAEFXDLXdA1n651-BFyCikjYZOBaypXXmuQYianjlcSgwlN5_-o27RtRF4SRi1f9UF0bn-2Om4oHVecf3-Kwoz8ZRes39BWy9qRHtEfpTwgkoi1uCNzd1UuDGkINU3P_k-wpChyMF3iTRXR4U2xCJW2h1siep-ulJCJewsVhWuDmlpQHqdFBKv9ippGC1j7jMhgrdz5xn6EKohi8COfHpmXLxHlQI33MUFeCUZPmvW33vHLKKE0rwIVHIxlqSIredHK1uGKskH9fDZ-bzqXzHGw'
  },
  data: {
    limit: '10',
    page: '1',
    sort: 'inc:DESC',
    schema: 'MINE',
    where: '{}'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

14. 回收家庭。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

15. 更新家庭

修改家庭信息。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

示例

result字段

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

错误码

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

SDK调用

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

16. 修改家庭。

调用场景

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

配置参数

参数意义参考接口参数

请求参数

返回参数

示例

result字段

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

错误码