1. 描述

应用管理主要在超级控制台下进行。开发者进入consolex.xdua.com,点击自己的社区,进入社区(触发AddLogon操作),创建应用。

2. 接口动作

缩名 全名 方法 中文 角色 描述
ADD Create POST 创建 Zoon 创建应用
DEL Delete DELETE 删除 Zoon 删除应用
SET Update PUT 修改 Zoon 修改应用
DOL Deleto PUT 软删 Zoon 软删应用
DIS Disable PUT 关闭 Zoon 关闭应用
ENB Enable PUT 打开 Zoon 打开应用
RCC Recycle PUT 回收 Zoon 回收应用
PUB Publish PUT 发布 Zoon 发布应用
OFF Offline PUT 下线 Zoon 下线应用
GET Get GET 详情 Zoon 详情应用
GIT Git GET 私详 Zoon 私详应用
QRY Query GET 查询 Zoon 查询应用
QRI Queri GET 私查 Zoon 私查应用

3. 资源状态

4. 错误码

参考错误码

5. 描述

创建志统。

6. 调用场景

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

创建志统需要用户先登录自己的账户,进入企业,店铺,然后创建。

7. 配置参数

参数意义参考接口参数

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

8. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type_id body String 志统的种类 志统类型ID,本字段受apistt_type表的id字段外键约束
build_id body String 建筑的ID 志统所在的楼栋,如果不知道就填UnknownB
name body String 志统的名字 志统的名字,可以随意设置
addr body String 志统的地址 志统的地址,是唯一设置的。它和shop_id联动确定是唯一的。

9. 返回参数

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

10. 错误码

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

11. SDK调用



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

/*-----------------------------------------------------------
 * 首先在控制台点击企业按钮,进入企业
 *---------------------------------------------------------*/

api_name = "登续到济南分所";
logon_param = {
    id  :   "IctJinan",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}
/*-----------------------------------------------------------
 * 首先在控制台点击店铺按钮,进入店铺
 *---------------------------------------------------------*/
api_name = "登续到商务中心养老院";
logon_param = {
    id  :   "Facility",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}




/*-----------------------------------------------------------
 * 在店铺界面创建志统
 *---------------------------------------------------------*/
const add_params = {
    build_id:"W0wPuXU3",                             //志统所在的楼栋,`商务中心A座`
    type_id:"m5d00001",                             //志统种类ID,表示`养老院护理间`
    name:"一楼107",                                 //志统的名字
    addr:"商务中心养老公寓主楼107",     //志统地址,这个会做全平台唯一性检查
}



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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 删除志统。 # 调用场景 God在[超级控制台](http://consolex.xdua.com)登录. 它会让资源永久消失。但要删除一个志统,你需要把志统对应的所有设备都删除,才能删除志统。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |DelRoom | | |URL |https://api.xdua.com/apistt| | |Method |DELETE | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DEL | | |XduaApiColor |R | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleR | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有资源创建者自己可以访问这个口| |XduaApiRoles |Butler | Butler可以删除志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |DeleteRoom | | |XduaApiRule |DeleteRoom | | |XduaApiAstates |0 | 所有state检查 | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的志统ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的志统ID | # 错误码 错误码来自于error字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html) # SDK调用


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

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 关闭志统。 # 调用场景 神管理员登录[超级控制台](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 |DisRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DIS | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖志统,只有这个志统的登录人员才可以访问| |XduaApiSubject |i | 必须是创建者才可以自闭志统| |XduaApiRoles |Admin | 只有神级管理员才可以关闭普通开发者的志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |DisableRoomtmpl | | |XduaApiRule |DisableRoomtmpl | | |XduaApiAstates |`0,0` 或者`0` | 按序apistt,zone,corp,shop,apistt,apistt,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 |DolRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DOL | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有创建者自己才能删除自己创建的志统| |XduaApiRoles |Zoon | 只要登录就可以创建志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |DeletoRoomtmpl | | |XduaApiRule |DeletoRoomtmpl | | |XduaApiAstates |0 | 按序apistt,zone,corp,shop,apistt,apistt,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 |EnbRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |ENB | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |u | 神登录后解冻开发者的志统| |XduaApiRoles |Admin | 只有神才可以解冻志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |EnableRoomtmpl | | |XduaApiRule |EnableRoomtmpl | | |XduaApiAstates |0 | 按序apistt,zone,corp,shop,apistt,apistt,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/apistttmpl| | |Method |GET | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |GET | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | !表示除了允许匿名志统之外的所有志统访问| |XduaApiRoles |Zoon | 只要Zoon才可以访问其它志统的志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |GetRoomtmpl | | |XduaApiRule |GetRoomtmpl | | |XduaApiRoomtmplAstate |0 | 志统zone.state必须是0(STATE_ENABLED) | |XduaApiCorpAstate |0 | 志统corp.state必须是0(STATE_ENABLED) | |XduaApiShopAstate |0 | 志统shop.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统apistt.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统 apistt.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统apistt.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 | |apistt_id |string |所属户群的id | |apistt_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 |志统请求时客户端的RoomtmplAgent| |exp |int |志统的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的utc时间。| |vtl |int |志统的剩余有效期 validtimelong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的apistt计算vtl为0时,会自动被重置为-1| |ugrp |string |志统持有志统所在的志统群,匿名志统的户群是常量:"xduaxdua"| |role |志统持有志统所在的角色列表,匿名志统的角色列表是常量:"none"| |名称 | 位置 |类型 |示例 |说明 |------- |----- |-----------|------------ |------------ |id |result |ryub4wrt |详情的志统id |name |result.data |志统的名称 |code |志统的执照号 |type |志统的种类 |avatar |志统图标 |brief |志统的描述 |state |1 |志统的状态 |stato |"冻服更新" |志统的状态说明 |expire |0 |志统状态过期时间(unix时间戳) |creator_id |result.list[] |dmtv7tre |社区创建者id |creator_name |辣椒帅 |社区创建者名字 |updator_id |xiyrvup3 |社区最近一次更新者id |updator_name |周海潮 |社区最近一次更新者名字 |cstamp |2020-01-20 02:19:55 |志统创建时间 |ustamp 02:23:24 |志统最近更新时间> [!note] > 志统的使能状态,0:打开 1:关闭. 关闭的志统处于冻结状态,不接受登陆/注册所有操作. #### 返回示例 result部分 ```json { "id":"rYub4wrT", "data": { }, } ``` # 错误码 # 描述 私详志统。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,在志统列表,选择志统,点击详情,就可以查看自己的志统。GIT的默认字段和GET不一样。 # 配置参数 |参数名 |参数值 |说明 | |------ |------ |---- | |URL |https://api.xdua.com/apistttmpl| | |Method |GET | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |GIT | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有自己才可以访问自己创建的志统| |XduaApiRoles |Zoon | 只要登录就可以创建志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |GetRoomtmpl | | |XduaApiRule |GetRoomtmpl | | |XduaApiRoomtmplAstate |0 | 志统zone.state必须是0(STATE_ENABLED) | |XduaApiCorpAstate |0 | 志统corp.state必须是0(STATE_ENABLED) | |XduaApiShopAstate |0 | 志统shop.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统apistt.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统 apistt.state必须是0(STATE_ENABLED) | |XduaApiRoomtmplAstate |0 | 志统apistt.state必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要修改的志统ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------ |------------ | |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部分 ```json { "id":"rYub4wrT", "data": { }, } ``` # 错误码 # 描述 下线志统。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以下线自己创建的志统。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |OffRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |OFF | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只能志统的创建者才能下线自己的志统| |XduaApiRoles |Zoon | 只要登录就可以创建志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |OfflineRoomtmpl | | |XduaApiRule |OfflineRoomtmpl | | |XduaApiAstates |0 | 按序apistt,zone,corp,shop,apistt,apistt,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的志统ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的志统ID | # 错误码 # 描述 发布志统。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以下线/发布自己的志统。这个动作是管理员不能干涉的。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |PubRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |PUB | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有志统的创建者自己才能上下线自己的志统| |XduaApiRoles |Zoon | 只要登录就可以创建志统| |XduaApiResource |apistt | | |XduaApiKparam |id | | |XduaApiAction |OnlineRoomtmpl | | |XduaApiRule |OnlineRoomtmpl | | |XduaApiAstates |0 | 按序apistt,zone,corp,shop,apistt,apistt,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的志统ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的志统ID | # 错误码 # 描述 私查志统。 # 调用场景 开发者登录[http://consolex.xdua.com](http://consolex.xdua.com)后,可以以Zoon角色查询所有志统。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |QriRoomtmpl | | |URL |https://api.xdua.com/apistttmpl| | |Method |GET | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |QRI | | |XduaApiColor |X | 只有持有神志统,才可以创建志统 | |XduaApiAudience |ConsoleX | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 志统直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 所有注册志统均可以使用| |XduaApiRoles |Zoon | 必须是Zoon才可以查询角色| |XduaApiResource |apistt | | |XduaApiKparam |`where` |常量 | |XduaApiAction |QueriRoomtmpl | | |XduaApiRule |QueriRoomtmpl | | |XduaApiAstates |0 | 按序apistt,zone,corp,shop,apistt,apistt,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # URL GET:https://api.xdua.com/apistttmpl # 请求参数 参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html) # 返回参数 参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html) 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 |志统最近更新时间 | # 错误码 # 描述 查询志统。 # 调用场景 开发者登录[http://consolex.xdua.com](http://consolex.xdua.com)后,可以以God角色查询属于所有志统。 # URL GET:https://api.xdua.com/apistt # 请求参数 参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html) # 返回参数 参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html) result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。 |字段 |显示名称 | 位置 |类型 |示例 |说明 | |------- |------- |----- |-----------|------------ |------------ | |id |ID |result.list[] |string |100003 |志统ID | |shop_id |店铺 |result.list[] |string | |志统店铺的ID | |hour |小时 |result.list[] |string | |志统店铺的ID | |api |名称 |result.list[] |string | |志统店铺的ID | |error |返回码 |result.list[] |string | |志统店铺的ID | |res |返回大小 |result.list[] |string | |志统店铺的ID | |lot |均时长 |result.list[] |string | |志统店铺的ID | |req |请求大小 |result.list[] |string | |志统店铺的ID | # 错误码 错误码来自于error字段,通用错误码参考[地球号通用错误码](http://docapi.kernel.xdua.com/api/error.html) # SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})


/*------------------------------------------------------
 * 分页查询小区`Vila0001`下的志统
 * 
 *----------------------------------------------------*/
let query_param = {
    limit:20,
}


const res_api = await xduaClient.qryApistt(query_params)

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

12. 描述

回收志统。

13. 调用场景

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

14. 配置参数

参数意义参考接口参数

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

15. 请求参数

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

16. 返回参数

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

17. 错误码

18. 描述

修改志统信息。本接口是God可以访问的,God几乎可以修改Room的所有属性。在未来,Room的不重要属性可以被其它角色修改。

19. 调用场景

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

20. 配置参数

参数意义参考接口参数

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

21. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path String 6tYu82hM 志统ID
type body String Mats 志统类型代码,本字段受apistt_type表的code字段外键约束
addr body String 店铺地址
name body String 蓝牙网关 店铺名字
build_id body String 12345678 志统所属楼栋的ID

22. 返回参数

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

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的志统名",
        "brief":"新的志统介绍",    
    }    
}

23. 错误码

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

24. SDK调用

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

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

/*----------------------------

  • 运行如下代码
  • 下面的代码是直接可以运行的 --------------------------/ api_name = "修改志统"; const apistt_id ="TeStTeSt"; //要修改的志统ID

/*----------------------------

  • 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Room", //志统新的类型 name:"测试志统", //名字 addr:"志统新的地址", //志统生产商 }

const res_api = await xduaClient.setRoom(apistt_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                   |SetRoomtmpl                  |         |
|URL                    |https://api.xdua.com/apistttmpl|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |SET                      |         |
|XduaApiColor      |X                        | 只有持有神志统,才可以创建志统        |
|XduaApiAudience   |ConsoleX                 | 只有apistt_id为ConsoleX的志统,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 志统直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject    |i                        | i,只有创建者自己才可以修改|
|XduaApiRoles           |Zoon                     | 只要登录就可以创建志统|
|XduaApiResource        |apistt                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |UpdateRoomtmpl               |     |
|XduaApiRule            |UpdateRoomtmpl               |     |
|XduaApiAstates         |0              | 按序apistt,zone,corp,shop,apistt,apistt,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":"新的志统介绍",    
    }    
}

25. 错误码

results matching ""

    No results matching ""