1. 描述

社角管理主要在http://consoler.{zond_id}.xdua.com下进行。参与角色有Super,Super,Super三个角色。

2. 接口动作

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

3. 资源状态

4. 错误码

参考错误码

5. 描述

创建社角。

6. 调用场景

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

7. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddRoler
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 Super Super可以创建社角
XduaApiResource role
XduaApiKparam name
XduaApiAction CreateRoler
XduaApiRule CreateRoler
XduaApiAstates 0
XduaApiEnable true 接口使能

8. 请求参数

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

9. 返回参数

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

10. 错误码

11. 描述

删除社角。

12. 调用场景

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

13. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelRoler
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 Super Super可以删除社角
XduaApiResource role
XduaApiKparam id
XduaApiAction DeleteRoler
XduaApiRule DeleteRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

14. 请求参数

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

15. 返回参数

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

16. 错误码

17. 描述

关闭社角。

18. 调用场景

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

管理员（Super）

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

19. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisRoler
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 Super 只有神级管理员才可以关闭普通开发者的社角
XduaApiResource role
XduaApiKparam id
XduaApiAction DisableRoler
XduaApiRule DisableRoler
XduaApiAstates 0,0 或者0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

20. 请求参数

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

21. 返回参数

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

22. 错误码

23. 描述

软删社角。

24. 调用场景

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

25. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolRoler
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction DeletoRoler
XduaApiRule DeletoRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

26. 请求参数

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

27. 返回参数

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

28. 错误码

29. 描述

打开社角。

30. 调用场景

管理员（Super）

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

31. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbRoler
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 Super 只有神才可以解冻社角
XduaApiResource role
XduaApiKparam id
XduaApiAction EnableRoler
XduaApiRule EnableRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

32. 请求参数

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

33. 返回参数

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

34. 错误码

35. 描述

详情社角。

36. 调用场景

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

37. 配置参数

参数名 参数值 说明
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 Super 只要Super才可以访问其它用户的社角
XduaApiResource role
XduaApiKparam id
XduaApiAction GetRoler
XduaApiRule GetRoler
XduaApiRolerAstate 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 接口使能

38. 请求参数

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

39. 返回参数

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


    },
}

40. 错误码

41. 描述

私详社角。

42. 调用场景

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

43. 配置参数

参数名 参数值 说明
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction GetRoler
XduaApiRule GetRoler
XduaApiRolerAstate 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 接口使能

44. 请求参数

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

45. 返回参数

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


    },
}

46. 错误码

47. 描述

下线社角。

48. 调用场景

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

49. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffRoler
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction OfflineRoler
XduaApiRule OfflineRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

50. 请求参数

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

51. 返回参数

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

52. 错误码

53. 描述

发布社角。

54. 调用场景

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

55. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubRoler
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction OnlineRoler
XduaApiRule OnlineRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

56. 请求参数

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

57. 返回参数

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

58. 错误码

59. 描述

私查社角。

60. 调用场景

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

61. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriRoler
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 Super 必须是Super才可以查询角色
XduaApiResource role
XduaApiKparam where 常量
XduaApiAction QueriRoler
XduaApiRule QueriRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

62. URL

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

63. 请求参数

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

64. 返回参数

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

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

65. 错误码

66. 描述

查询社角。

67. 调用场景

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

68. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryRoler
URL https://api.xdua.com/rolex
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 Super 必须是Super才可以查询角色
XduaApiResource role
XduaApiKparam where 常量where
XduaApiAction QueryRoler
XduaApiRule QueryRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

69. URL

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

70. 请求参数

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

71. 返回参数

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

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

72. 错误码

73. 描述

回收社角。

74. 调用场景

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

75. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccRoler
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction RecycleRoler
XduaApiRule RecycleRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

76. 请求参数

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

77. 返回参数

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

78. 错误码

79. 描述

修改社角。

80. 调用场景

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

81. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetRoler
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 Super 只要登录就可以创建社角
XduaApiResource role
XduaApiKparam id
XduaApiAction UpdateRoler
XduaApiRule UpdateRoler
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

82. 请求参数

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

83. 返回参数

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

示例

result字段

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

84. 错误码

results matching ""

    No results matching ""