1. 描述
神角管理主要在超级控制台下进行。参与角色有Root,Root,Root三个角色。
2. 接口动作
缩名 | 全名 | 方法 | 中文 | 角色 | 描述 |
---|---|---|---|---|---|
ADD | Create | POST | 创建 | Root | 创建神角 |
DEL | Delete | DELETE | 删除 | Root | 删除神角 |
SET | Update | PUT | 修改 | Root | 修改神角 |
DOL | Deleto | PUT | 软删 | Root | 软删神角 |
DIS | Disable | PUT | 关闭 | Root | 关闭神角 |
ENB | Enable | PUT | 打开 | Root | 打开神角 |
RCC | Recycle | PUT | 回收 | Root | 回收神角 |
PUB | Publish | PUT | 发布 | Root | 发布神角 |
OFF | Offline | PUT | 下线 | Root | 下线神角 |
GET | Get | GET | 详情 | Root | 详情神角 |
GIT | Git | GET | 私详 | Root | 私详神角 |
QRY | Query | GET | 查询 | Root | 查询神角 |
QRI | Queri | GET | 私查 | Root | 私查神角 |
3. 资源状态
4. 错误码
参考错误码
5. 描述
创建神角。
6. 调用场景
开发者登录超级控制台后,可以以Root神角创建自己的神角。
7. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddRolex | |
Url | https://api.xdua.com/rolex | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 需要登录 |
XduaApiRoles | Root | Root可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | name | |
XduaApiAction | CreateRolex | |
XduaApiRule | CreateRolex | |
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 | 是 | Root | 神角的代号,16个字符以内,小写字母,数字和字母,不能有特殊符号,一旦创建,不可修改 | ||
granter | body | string | 是 | Root | 授权神角代号,code标准格式 |
9. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的神角ID |
10. 错误码
11. 描述
删除神角。
12. 调用场景
根用户在超级控制台登录. 它会让资源永久消失。。
13. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelRolex | |
URL | https://api.xdua.com/rolex | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Root | Root可以删除神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DeleteRolex | |
XduaApiRule | DeleteRolex | |
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. 调用场景
神管理员登录超级控制台后,可以关闭普通开发者的神角。使得神角进入DISABLED状态,也只有Root角色重新打开这个神角。
管理员(Root)
- 登录http://consoler.{zond_id}.xdua.com后,
- 根据条件查询神角,条件是某个神角。
- 点击
冻结
,可以关闭神角。
19. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DisRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖神角,只有这个神角的登录人员才可以访问 |
XduaApiSubject | u | 必须是创建者才可以自闭神角 |
XduaApiRoles | Root | 只有神级管理员才可以关闭普通开发者的神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DisableRolex | |
XduaApiRule | DisableRolex | |
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. 调用场景
开发者登录超级控制台后,可以点击自己的神角,然后删除掉。如果哪天后悔了,可以联系Root来恢复。
25. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的神角 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DeletoRolex | |
XduaApiRule | DeletoRolex | |
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. 调用场景
管理员(Root)
- 登录http://consolex.xdua.com后,
- 根据条件查询神角,条件是某个被冻结的神角。
- 点击
解冻
,可以解冻店铺。
31. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | EnbRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的神角 |
XduaApiRoles | Root | 只有神才可以解冻神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | EnableRolex | |
XduaApiRule | EnableRolex | |
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. 调用场景
管理员登录超级控制台后,可以随意查询能看见的所有神角列表。点击其中一个神角(不管是不是自己的),就可以点击访问。
37. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/rolex | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | !表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Root | 只要Root才可以访问其它用户的神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | GetRolex | |
XduaApiRule | GetRolex | |
XduaApiRolexAstate | 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. 调用场景
开发者登录超级控制台后,在神角列表,选择神角,点击详情,就可以查看自己的神角。GIT的默认字段和GET不一样。
43. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/rolex | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的神角 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | GetRolex | |
XduaApiRule | GetRolex | |
XduaApiRolexAstate | 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. 调用场景
开发者登录超级控制台后,可以下线自己创建的神角。
49. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | OffRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能神角的创建者才能下线自己的神角 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | OfflineRolex | |
XduaApiRule | OfflineRolex | |
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. 调用场景
开发者登录超级控制台后,可以下线/发布自己的神角。这个动作是管理员不能干涉的。
55. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | PubRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有神角的创建者自己才能上下线自己的神角 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | OnlineRolex | |
XduaApiRule | OnlineRolex | |
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://consolex.xdua.com后,可以以Root角色查询所有神角。
61. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriRolex | |
URL | https://api.xdua.com/rolex | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | Root | 必须是Root才可以查询角色 |
XduaApiResource | role | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriRolex | |
XduaApiRule | QueriRolex | |
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://consolex.xdua.com后,可以以Root角色查询属于自己名下的所有神角。
68. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryRolex | |
URL | https://api.xdua.com/rolex | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | Root | 必须是Root才可以查询角色 |
XduaApiResource | role | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryRolex | |
XduaApiRule | QueryRolex | |
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. 返回result
{
"limit": 20,
"total": 22,
"sort": {
"inc": "DESC"
},
"count": 20,
"page": 1,
"pages": 2,
"list": [{
"id": "BesterBe",
"cstamp": "2020-01-20 15:18:37",
"name": "B测官",
"state": 0,
"creator_name": "辣椒帅",
"code": "Bester",
"avatar": "http://avatar.xdua.com/role/default.png?x-oss-process=style/avatarp64",
"granter": "Butler",
"brief": "店铺测试官",
"creator_id": "Dt5mvrtU"
},{
"id": "NoneNone",
"cstamp": "2019-03-03 22:14:21",
"name": "民",
"state": 0,
"creator_name": "辣椒帅",
"code": "None",
"avatar": "http://avatar.xdua.com/role/defaultrolenone.png?x-oss-process=style/avatarp64",
"granter": "God",
"brief": "民",
"creator_id": "Dt5mvrtU"
}],
"format": "raw",
"where": {
"zone_id": "XdUaXduA",
"state": 0
},
"offset": 0
}
74. SDK调用
const XduaClient = require('../lib')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE1ODQ5NzUwNDMsIm5iZiI6MTU4NDk3NTA0MywiaXNzIjoieGR1YS5jb20iLCJleHAiOjE5MDAzMzUwNDMsImF1ZCI6IkJyb3dTZGtUIiwic3ViIjoiQW5vTnltdVMiLCJqdGkiOiIxMjM0NTY3OCIsImlwbSI6IioiLCJkdm0iOiIqIiwic2FwIjoiU3ZLZXJuZUwiLCJhcGkiOiJBZGRMb2dpbiIsImNsciI6IlgiLCJvd24iOiJEdDVtdnJ0VSIsInRpZCI6InhzQUZGNmpHIiwiYnVnIjoiREUiLCJsZ24iOiJOdWxsTnVsbCIsInR5cCI6IkwiLCJ0YWciOiJQcmltYXJ5Iiwiem9uZSI6IlhkVWFYZHVBIiwiY29ycCI6IlhkVWFYZHVBIiwic2hvcCI6IlhkVWFYZHVBIiwicm9sZSI6IioiLCJydWxlIjoiKiJ9.b_KQVug-D83hsfzHVoOvyJZUjjnWhr1UiRCLOBcUSFCLfh3ZoP5GE7m98s6H3QsDpYs20hFkFecj0xiyxzQKy5DOq9XbroXffDmBgg5y45WYnW3P8iqB2WQBtBwEU3VAWk_Vx6UwnGmpb_juu7KsFK33rWswFx3odbw7xe2iMdReywc6bYHf0P7s7kNYqYF_n-odiO6UsZd7yeNos8Hn7XtzE2igD7DhTbB0oxqEzVHoMtFcVAdstsLi3aAcJOK2Gp-XhWHSuiGqd9kTPmghk5cmIDcN7KOOZ6y1GQevM2Qc_7tfebP3Ev-bAZEPAyUA77zRrQMrpwJouejR_sNd3g",
})
const loginres = await xduaClient.addToginx({
ustr: '+86-15810419011',
pwd : 'a906449d5769fa7361d7ecc6aa3f6d28',
afs : "ignore"
})
//--------------------------------------------------
let api_name = "查询角色";
query = {
where:{state:0}
}
const res = await xduaClient.qryRolex(query);
console.log(res);
if(res.error == 0){
console.log(api_name+"成功 ");
}else{
console.log(api_name+"失败 "+res.reason);
}
75. 描述
回收神角。
76. 调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的神角。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的神角的名字。
77. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | u表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | RecycleRolex | |
XduaApiRule | RecycleRolex | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
78. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的神角ID |
79. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的神角ID |
80. 错误码
81. 描述
修改神角。
82. 调用场景
开发者登录超级控制台后,可以修改自己创建的神角。修改仅仅限于可以修改的name,brief等字段。
83. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetRolex | |
URL | https://api.xdua.com/rolex | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神令牌,才可以创建神角 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神角直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Root | 只要登录就可以创建神角 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | UpdateRolex | |
XduaApiRule | UpdateRolex | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
84. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的神角ID | |
name | body | string | 否 | 神角的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | ||
avatar | body | string | 否 | 神角图标,不超过40个字符。 | ||
brief | body | string | 否 | 神角描述,不超过64个字符。 |
85. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的神角ID |
updates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的神角名",
"brief":"新的神角介绍",
}
}