1. 描述

创建店授。

2. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以以Shep店授创建自己的店授。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddUsrob
Url https://api.xdua.com/rolex
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 需要登录
XduaApiRoles Shep Shep可以创建店授
XduaApiResource role
XduaApiKparam name
XduaApiAction CreateUsrob
XduaApiRule CreateUsrob
XduaApiAstates 0
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
shop_id body String 是 在哪个户群创建店授 ugrp的代号
name body string 是 健康手环 店授的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 店授图标，不超过40个字符。
brief body string 否 店授描述，不超过64个字符。
code body string 是 Shep 店授的代号,16个字符以内,小写字母,数字和字母，不能有特殊符号，一旦创建，不可修改
granter body string 是 Shep 授权店授代号,code标准格式

5. 返回参数

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

6. 错误码

7. 描述

删除店授。

8. 调用场景

根用户在http://consoler.{zond_id}.xdua.com登录. 它会让资源永久消失。。

9. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelUsrob
URL https://api.xdua.com/rolex
Method DELETE
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DEL
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有资源创建者自己可以访问这个口
XduaApiRoles Shep Shep可以删除店授
XduaApiResource role
XduaApiKparam id
XduaApiAction DeleteUsrob
XduaApiRule DeleteUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

10. 请求参数

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

11. 返回参数

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

12. 错误码

13. 描述

关闭店授。

14. 调用场景

神管理员登录http://consoler.{zond_id}.xdua.com后,可以关闭普通开发者的店授。使得店授进入DISABLED状态，也只有Shep角色重新打开这个店授。

管理员（Shep）

  1. 登录http://consoler.{zond_id}.xdua.com后,
  2. 根据条件查询店授，条件是某个店授。
  3. 点击冻结，可以关闭店授。

15. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DIS
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店授,只有这个店授的登录人员才可以访问
XduaApiSubject u 必须是创建者才可以自闭店授
XduaApiRoles Shep 只有神级管理员才可以关闭普通开发者的店授
XduaApiResource role
XduaApiKparam id
XduaApiAction DisableUsrob
XduaApiRule DisableUsrob
XduaApiAstates 0,0 或者0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

16. 请求参数

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

17. 返回参数

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

18. 错误码

19. 描述

软删店授。

20. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以点击自己的店授，然后删除掉。如果哪天后悔了，可以联系Shep来恢复。

21. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DOL
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有创建者自己才能删除自己创建的店授
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction DeletoUsrob
XduaApiRule DeletoUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

22. 请求参数

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

23. 返回参数

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

24. 错误码

25. 描述

打开店授。

26. 调用场景

管理员（Shep）

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

27. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ENB
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 神登录后解冻开发者的店授
XduaApiRoles Shep 只有神才可以解冻店授
XduaApiResource role
XduaApiKparam id
XduaApiAction EnableUsrob
XduaApiRule EnableUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

28. 请求参数

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

29. 返回参数

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

30. 错误码

31. 描述

详情店授。

32. 调用场景

管理员登录http://consoler.{zond_id}.xdua.com后,可以随意查询能看见的所有店授列表。点击其中一个店授（不管是不是自己的），就可以点击访问。

33. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u !表示除了允许匿名用户之外的所有用户访问
XduaApiRoles Shep 只要Shep才可以访问其它用户的店授
XduaApiResource role
XduaApiKparam id
XduaApiAction GetUsrob
XduaApiRule GetUsrob
XduaApiUsrobAstate 0 令牌zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 令牌corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 令牌shop.state必须是0(STATE_ENABLED)
XduaApiUserAstate 0 令牌user.state必须是0(STATE_ENABLED)
XduaApiAppAstate 0 令牌 app.state必须是0(STATE_ENABLED)
XduaApiTokenAstate 0 令牌token.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

34. 请求参数

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

35. 返回参数

名称 位置 类型 示例 说明
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 辣椒帅 店授创建者名字
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 店授最近更新时间

返回示例

result部分

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


    },
}

36. 错误码

37. 描述

私详店授。

38. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,在店授列表，选择店授，点击详情，就可以查看自己的店授。GIT的默认字段和GET不一样。

39. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的店授
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction GetUsrob
XduaApiRule GetUsrob
XduaApiUsrobAstate 0 令牌zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 令牌corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 令牌shop.state必须是0(STATE_ENABLED)
XduaApiUserAstate 0 令牌user.state必须是0(STATE_ENABLED)
XduaApiAppAstate 0 令牌 app.state必须是0(STATE_ENABLED)
XduaApiTokenAstate 0 令牌token.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

40. 请求参数

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

41. 返回参数

名称 位置 类型 示例 说明
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 辣椒帅 店授创建者名字
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 店授最近更新时间

返回示例

result部分

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


    },
}

42. 错误码

43. 描述

下线店授。

44. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以下线自己创建的店授。

45. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只能店授的创建者才能下线自己的店授
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction OfflineUsrob
XduaApiRule OfflineUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

46. 请求参数

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

47. 返回参数

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

48. 错误码

49. 描述

发布店授。

50. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以下线/发布自己的店授。这个动作是管理员不能干涉的。

51. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有店授的创建者自己才能上下线自己的店授
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction OnlineUsrob
XduaApiRule OnlineUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

52. 请求参数

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

53. 返回参数

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

54. 错误码

55. 描述

私查店授。

56. 调用场景

开发者登录http://consoler.xdua.com后,可以以Shep角色查询所有店授。

57. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriUsrob
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles Shep 必须是Shep才可以查询角色
XduaApiResource role
XduaApiKparam where 常量
XduaApiAction QueriUsrob
XduaApiRule QueriUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

58. URL

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

59. 请求参数

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

60. 返回参数

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

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 辣椒帅 店授创建者名字
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 店授最近更新时间

61. 错误码

62. 描述

查询店授。

63. 调用场景

开发者登录http://consoler.xdua.com后,可以以Butler角色查询属于自己名下的所有店授。

64. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryUsrob
URL https://api.xdua.com/usro
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles Butler 必须是Shep才可以查询角色
XduaApiResource usro
XduaApiKparam where 常量where
XduaApiAction QueryUsrob
XduaApiRule QueryUsro
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

65. URL

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

66. 请求参数

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

67. 返回参数

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

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 辣椒帅 店授创建者名字
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 店授最近更新时间

68. 错误码

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

69. SDK调用

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

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

let query_param = {
    limit:20,
    page:1,
    where:{"name[~]":"%卧室%"}    
}

/*---------------------------------------
 * 查询`Facility`这个养老院的所有注册员工
 *-------------------------------------*/

let query_param = {
    limit:20,
    page:1,
    where:{shop_id  :   "Facility"}    
}
/*---------------------------------------
 * 查询`Facility`这个养老院的所有老人
 *-------------------------------------*/

let query_param = {
    limit:20,
    page:1,
    where:{shop_id  :   "Facility",role_code:"Caree"}    
}


const res_api = await xduaClient.qryUsrob(query_param)

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

70. 描述

回收店授。

71. 调用场景

管理员应开发者的要求，登录http://consoler.{zond_id}.xdua.com后,查询到某个开发者下面的被删除的店授。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的店授的名字。

72. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u u表示除了允许匿名用户之外的所有用户访问
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction RecycleUsrob
XduaApiRule RecycleUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

73. 请求参数

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

74. 返回参数

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

75. 错误码

76. 描述

修改店授。

77. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以修改自己创建的店授。修改仅仅限于可以修改的name,brief等字段。

78. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetUsrob
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神令牌，才可以创建店授
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用，也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店授直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Shep 只要登录就可以创建店授
XduaApiResource role
XduaApiKparam id
XduaApiAction UpdateUsrob
XduaApiRule UpdateUsrob
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

79. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的店授ID
name body string 否 店授的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 店授图标，不超过40个字符。
brief body string 否 店授描述，不超过64个字符。

80. 返回参数

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

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的店授名",
        "brief":"新的店授介绍",    
    }    
}

81. 错误码

results matching ""

    No results matching ""