1. 描述
创建应用令牌。
2. 调用场景
开发者登录超级控制台后,显示自己的APP列表,进入某个APP,然后可以Super角色创建自己的令牌。
接下来说明一下创建令牌的场景顺序:
- 登录 http://consolex.xdua.com
- 在
应用管理->应用管理
菜单下查看开发者自己创建的所有应用。 - 在相关应用的"令牌列表"里点击,页面跳到
应用管理->令牌管理
页面,并看到这个应用下的所有令牌 - 点击右上角
创建令牌
,开始创建令牌。
3. URL
POST: http://api.kernel.xdua.com/token
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
typ | body | string | 是 | L | 令牌种类,L=登录令牌 | |
aud | body | string | 是 | ConsoleE |
令牌应用ID,这个令牌用于哪个应用ID | |
sap | body | string | 是 | SvKerneL |
服务应用ID,这个令牌用于访问那个服务 | |
jti | body | string | 是 | 12345678 | 令牌防重放字串。一个<=8个字符(数字或字母)的魔法数字。用于跟踪令牌使用。 | |
ipm | body | string | 是 | * | 令牌IP白名单,如果填* ,表示所有ip来源都可以。 |
|
dvm | body | string | 是 | * | 令牌设备白名单,如果填* ,表示所有设备都可以。 |
|
tag | body | string | 是 | * | 令牌标签,用户自己定义。 | |
api | body | string | 是 | * | 令牌能用于哪个接口,* | |
bug | body | string | 是 | * | 返回所有调试信息. | |
shop | body | string | 是 | EldrCaRE |
令牌活跃的店铺 | |
role | body | string | 是 | * | 令牌持有的角色。填"*",表示这个令牌能获取的最大角色集合。 | |
rule | body | string | 是 | * | 令牌持有的权限。填"*",表示这个令牌能持有它能获取的最大权限集合。 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的令牌ID |
6. 错误码
7. 示例
在consolex控制台创建admin.manhu.cn的登录令牌
这里创建的令牌是登录令牌
,也就是目前唯一需要创建的令牌。页面需要如下填写:
名称 | 值 | 描述 |
---|---|---|
typ | L |
这是一个登录令牌 |
aud | 应用id | 要创建登录令牌的应用的id,在控制台,我们是从应用列表 点击相关的应用才进来的,所以天然带应用ID. |
sap | SvKerneL |
要访问的服务APP,*表示所有 |
jti | 12345678 |
令牌防重放字符串,目前写成常数字符串12345678 |
ipm | * |
本令牌不限ip |
dvm | * |
本令牌不限设备 |
tag | Primary |
常数 |
api | * |
本令牌不限接口 |
bug | * |
本令牌执行结果返回所有调试信息 |
shop | EldrCaRE |
慢护通所在社区 |
role | * |
本令牌不限制角色 |
rule | * |
不令牌不限制权限 |
const api_param = {
typ : "L",
aud : "AdmManHu",
sap : "SvKerneL",
jti : "12345678",
ipm : "*",
dvm : "*",
tag : "Primary",
api : "*",
bug :"*",
shop :"EldrCaRE",
role :"*",
rule :"*"
}
res2 = await xduaClient.addToken(api_param)
if(res2.error == 0){
console.log(api_name+"成功");
console.log(res2);
}else{
console.log(res2);
console.log(api_name+"失败 "+res2.reason);
}
//返回的数据格式
{
status: 200,
apid: '9EFAC845-2AC5-47BE-98A3-48E1B334FCF4',
apis: 'AddToken',
error: 0,
result: { id: 'C19MMasL' },
debug: [],
message: 'message',
reason: 'success'
}
8. 描述
删除令牌。
9. 调用场景
根用户在超级控制台登录. 它会让资源永久消失。。
10. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelToken | |
URL | https://api.xdua.com/token | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Zoon | Zoon可以删除令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | DeleteToken | |
XduaApiRule | DeleteToken | |
XduaApiAstates | 0 | 按序token,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状态,也只有Zoon角色重新打开这个令牌。
管理员(Zoon)
- 登录http://consoler.{zond_id}.xdua.com后,
- 根据条件查询令牌,条件是某个令牌。
- 点击
冻结
,可以关闭令牌。
16. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DisToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖令牌,只有这个令牌的登录人员才可以访问 |
XduaApiSubject | i | 必须是创建者才可以自闭令牌 |
XduaApiRoles | Admin | 只有神级管理员才可以关闭普通开发者的令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | DisableToken | |
XduaApiRule | DisableToken | |
XduaApiAstates | 0,0 或者0 |
按序token,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. 调用场景
开发者登录超级控制台后,可以点击自己的令牌,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
22. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的令牌 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | DeletoToken | |
XduaApiRule | DeletoToken | |
XduaApiAstates | 0 | 按序token,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. 调用场景
管理员(Zoon)
- 登录http://consolex.xdua.com后,
- 根据条件查询令牌,条件是某个被冻结的令牌。
- 点击
解冻
,可以解冻店铺。
28. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | EnbToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的令牌 |
XduaApiRoles | Admin | 只有神才可以解冻令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | EnableToken | |
XduaApiRule | EnableToken | |
XduaApiAstates | 0 | 按序token,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/token | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | !表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要Zoon才可以访问其它用户的令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | GetToken | |
XduaApiRule | GetToken | |
XduaApiTokenAstate | 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) |
XduaApiTokenAstate | 0 | 令牌 token.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 | 角权的名称 | |
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 |
token_id | string | 所属户群的id |
token_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 | 令牌请求时客户端的UserAgent |
exp | int | 令牌的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。 |
vtl | int | 令牌的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的token计算vtl为0时,会自动被重置为-1 |
ugrp | string | 令牌持有用户所在的用户群,匿名用户的户群是常量:"XdUaXduA" |
role | string | 令牌持有用户所在的角色列表,匿名用户的角色列表是常量:"none" |
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
37. 错误码
38. 描述
私详令牌。
39. 调用场景
开发者登录超级控制台后,在令牌列表,选择令牌,点击详情,就可以查看自己的令牌。GIT的默认字段和GET不一样。
40. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/token | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的令牌 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | GetToken | |
XduaApiRule | GetToken | |
XduaApiTokenAstate | 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) |
XduaApiTokenAstate | 0 | 令牌 token.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 | 辣椒帅 | 令牌创建者名字 |
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部分
{
"id":"rYub4wrT",
"data": {
},
}
43. 错误码
44. 描述
下线令牌。
45. 调用场景
开发者登录超级控制台后,可以下线自己创建的令牌。
46. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | OffToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能令牌的创建者才能下线自己的令牌 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | OfflineToken | |
XduaApiRule | OfflineToken | |
XduaApiAstates | 0 | 按序token,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 | PubToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有令牌的创建者自己才能上下线自己的令牌 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | OnlineToken | |
XduaApiRule | OnlineToken | |
XduaApiAstates | 0 | 按序token,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后,可以以Zoon角色查询所有令牌。
58. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriToken | |
URL | https://api.xdua.com/token | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 所有注册用户均可以使用 |
XduaApiRoles | Zoon | 必须是Zoon才可以查询角色 |
XduaApiResource | token | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriToken | |
XduaApiRule | QueriToken | |
XduaApiAstates | 0 | 按序token,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
59. URL
GET:https://api.xdua.com/token
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 | 辣椒帅 | 令牌创建者名字 |
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 | 令牌最近更新时间 |
62. 错误码
63. 描述
查询令牌。
64. 调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有令牌。
65. URL
GET:https://api.xdua.com/token
66. 请求参数
67. 返回参数
result.list部分
[!note|label=字段解析] 直接按照字段解析
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的令牌ID |
note | 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 | 令牌最近更新时间 |
68. 错误码
69. 描述
回收令牌。
70. 调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的令牌。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的令牌的名字。
71. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | u表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | RecycleToken | |
XduaApiRule | RecycleToken | |
XduaApiAstates | 0 | 按序token,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
72. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的令牌ID |
73. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的令牌ID |
74. 错误码
75. 描述
修改令牌。
76. 调用场景
开发者登录超级控制台后,可以修改自己创建的令牌。修改仅仅限于可以修改的name,brief等字段。
77. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetToken | |
URL | https://api.xdua.com/token | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神令牌,才可以创建令牌 |
XduaApiAudience | ConsoleX | 只有token_id为ConsoleX的令牌,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 令牌直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建令牌 |
XduaApiResource | token | |
XduaApiKparam | id | |
XduaApiAction | UpdateToken | |
XduaApiRule | UpdateToken | |
XduaApiAstates | 0 | 按序token,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
78. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的令牌ID | |
name | body | string | 否 | 令牌的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | ||
avatar | body | string | 否 | 令牌图标,不超过40个字符。 | ||
brief | body | string | 否 | 令牌描述,不超过64个字符。 |
|secret |path|string|生成新的secret的kid|后端会用kid连同后台生成的随机数共同生成新的secret|必须 | |igrp |body|string|令牌绑定的户群名|examp_ugrp|可选| |name |body|string|令牌的名字|令牌名字|可选| |brief |body|String|令牌的介绍|令牌简介|可选| |avatar |body|string|令牌的图标url|http://开头的图片地址|可选| |enabled|body|String|使能|0:关闭 1:打开|可选|
79. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的令牌ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的令牌名",
"brief":"新的令牌介绍",
}
}