1. 描述

创建套房。

2. 调用场景

开发者登录超级控制台后,可以以God角色创建自己的套房。套房创建目前只能由God进行。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddHome
Url https://api.xdua.com/home
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神套房，才可以创建套房
XduaApiAudience ConsoleX 只有home_id为ConsoleX的套房，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 套房直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 需要登录
XduaApiRole God 目前地球号只允许God添加套房,未来这个功能会让给一个专门维护套房和设备录入的角色。
XduaApiResource home
XduaApiKparam pkey 在阿里云物联网平台创建的套房的ProductKey
XduaApiAction CreateHome
XduaApiRule CreateHome
XduaApiAstates 0 所有的资源都要确认state是0
XduaApiEnable true 接口使能

4. 请求参数

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

5. 返回参数

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

6. 错误码

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

7. SDK调用




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

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
const add_params = {
    type:"Test",        //类别
    model:"Motest2",    //型号,Motest这个词取自Model Test合词
    vlot:360,           //本套房对应的所有设备的数据在日志表里存6分钟数据
    name:"测试套房",    //名字
    man:"xdua.com",     //套房生产商,地球号团队制作的硬件的生产商是xuda.com
    pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
    brief:"接口测试",   //简介
    cost:45,            //采购或者生产这个硬件的成本
    earn:60,            //对外销售价格
}

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""