1. 描述

创建社区。

2. 调用场景

开发者登录超级控制台后,以Root角色发起操作。

[NOTE|label:为什么不用None角色创建社区] 社区Zone的创建属于非常谨慎的资源，不应该由开发者自行创建。以后可以在后台配置这个动作可以让给None角色。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddZone
Url https://api.xdua.com/zone
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神令牌，才可以创建社区
XduaApiAudience ConsoleX 只有app_id为ConsoleX的应用，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 社区直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 需要登录
XduaApiRoles None 只要登录就可以创建社区
XduaApiResource zone
XduaApiKparam name
XduaApiAction CreateZone
XduaApiRule CreateZone
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. 请求参数

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

5. 返回参数

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

6. 错误码

7. SDK调用

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

//运行如下代码
api_param = {}
let res = await xduaClient.addZone()
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

8. 描述

删除社区。

9. 调用场景

根用户在超级控制台登录，可以永久删除任何处于软删除状态的社区。这个权限不给God，是因为这个是权限非常高的操作，它会让所有资源消失。。

10. 配置参数

参数意义参考接口参数

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

11. 请求参数

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

12. 返回参数

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

13. 错误码

14. 描述

关闭社区。

15. 调用场景

神管理员登录超级控制台后,可以关闭普通开发者的社区。使得社区进入DISABLED状态，也只有God角色重新打开这个社区。

管理员（God）

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

16. 配置参数

参数意义参考接口参数

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

17. 请求参数

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

18. 返回参数

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

19. 错误码

20. 描述

软删社区。

21. 调用场景

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

22. 配置参数

参数意义参考接口参数

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

23. 请求参数

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

24. 返回参数

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

25. 错误码

26. 描述

打开社区。

27. 调用场景

管理员（God）

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

28. 配置参数

参数意义参考接口参数

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

29. 请求参数

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

30. 返回参数

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

31. 错误码

32. 描述

详情社区。

33. 调用场景

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

34. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/zone
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神令牌，才可以创建社区
XduaApiAudience ConsoleX 只有app_id为ConsoleX的应用，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 社区直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u !表示除了允许匿名用户之外的所有用户访问
XduaApiRoles God 只要God才可以访问其它用户的社区
XduaApiResource zone
XduaApiKparam id
XduaApiAction GetZone
XduaApiRule GetZone
XduaApiZoneAstate 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 接口使能

35. 请求参数

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

36. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的社区ID
name result.data string 社区的名称
avatar result.data string 社区图标,如果加载失败，可以选用默认图片http://avatar.xdua.com/zone/default.webp
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 周海潮 社区最近一次更新者名字
userc result.list[] string 0 本社区的用户数
corpc result.list[] string 0 本社区的企业数
shopc result.list[] string 0 本社区的店铺数
rulec result.list[] string 0 本社区的权限数
rouec result.list[] string 0 本社区的角权数
rolec result.list[] string 0 本社区的角色数
usroc result.list[] string 0 本社区的授权数
cstamp result.data string 2020-01-20 02:19:55 社区创建时间
ustamp result.data string 2020-01-20 02:23:24 社区最近更新时间

返回示例

result部分

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


    },
}

37. 错误码

38. 描述

私详社区。

39. 调用场景

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

40. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/zone
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神令牌，才可以创建社区
XduaApiAudience ConsoleX 只有app_id为ConsoleX的应用，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 社区直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的社区
XduaApiRoles None 只要登录就可以创建社区
XduaApiResource zone
XduaApiKparam id
XduaApiAction GetZone
XduaApiRule GetZone
XduaApiZoneAstate 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 接口使能

41. 请求参数

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

42. 返回参数

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


    },
}

43. 错误码

44. 描述

下线社区。

45. 调用场景

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

46. 配置参数

参数意义参考接口参数

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

47. 请求参数

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

48. 返回参数

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

49. 错误码

50. 描述

发布社区。

51. 调用场景

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

52. 配置参数

参数意义参考接口参数

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

53. 请求参数

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

54. 返回参数

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

55. 错误码

56. 描述

私查社区。

57. 调用场景

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

58. 配置参数

参数意义参考接口参数

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

59. URL

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

60. 请求参数

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

61. 返回参数

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

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 社区最近更新时间

62. 错误码

63. 描述

查询社区。

64. SDK调用

const query = {limit:10}
const resp = await xduaClient.qryZone(query);

65. 调用场景

开发者登录http://consolex.xdua.com后,可以以God角色查询平台下所有社区。

66. 配置参数

参数意义参考接口参数

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

67. URL

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

68. 请求参数

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

69. 返回参数

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

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 社区最近更新时间

70. 错误码

71. 描述

回收社区。

72. 调用场景

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

73. 配置参数

参数意义参考接口参数

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

74. 请求参数

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

75. 返回参数

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

76. 错误码

77. 描述

修改社区。

78. 调用场景

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

79. 配置参数

参数意义参考接口参数

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

80. 请求参数

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

81. 返回参数

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

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的社区名",
        "brief":"新的社区介绍",    
    }    
}

82. 错误码

results matching ""

    No results matching ""