1. 描述
重置象志,使用验证码直接修改象志,在忘记旧象志的情况下使用。
用户注册:固定字段和额外字段。这么设计的原因是不同用户表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段,所以要求额外的自定义字段放在extra里。
2. 调用场景
开发者登录超级控制台后,可以以Zoon象志创建自己的象志。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddObjl | |
Url | https://api.xdua.com/objl | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRoles | Zoon | Zoon可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | name | |
XduaApiAction | CreateObjl | |
XduaApiRule | CreateObjl | |
XduaApiAstates | 0 | |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
addr | body | String | 是 | 无 | foo@bar.com | 验证码地址,电话或者邮箱,格式是+86-1581041901,邮箱是jiaosit@gmail.com格式. | 必选 |
tmpl | body | String | 是 | 无 | SMS_244723 | 验证码模板 |
[!note|label:如何两个参数维护整个接口] 验证码的模板在数据库里附带了足够多的信息,帮助做验证码鉴权。所以在创建验证码接口,一个tmpl就足够了。
"inc" | "name" | "code" | "brief" | "sign" | "app_id" | "sap_id" | "shop_id" | "action" | "state" | "stato" | "expire" | "valot" | "delay" | "cstamp" | "ustamp" |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
"2" | "地球号注册短信验证" | "SMS_25335288" | "地球号注册短信验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
"3" | "地球号登录短信验证" | "SMS_186395741" | "地球号登录短信验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
"4" | "地球号改密短信验证" | "SMS_186360831" | "地球号改密短信验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
"5" | "地球号注册邮件验证" | "DMS_VFC4USEREG" | "地球号注册邮件验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
"6" | "地球号改密邮件验证" | "DMS_VFC4CHGPWD" | "地球号改密邮件验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
"7" | "地球号设密邮件验证" | "DMS_VFC4RSTPWD" | "地球号设密邮件验证模板" | "地球号" | "ConsoleX" | "SvKerneL" | "XdUaXduA" | "CreateLoginx" | "0" | "AutoGenerated" | "0" | "900" | "60" | "2020-03-18 18:52:25" | "2020-03-23 03:47:55" |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的象志ID |
6. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
错误码 | 错误码名 | 可能原因 | |
---|---|---|---|
2001 | 象志访问过于频繁 | 同一个电话只能在5分钟后发送象志访问 | 失败 |
2002 | 象志生成失败 | 在生成验证码入库时发生错误 | |
2003 | 发送短信验证码失败 | 通过运营商发送短信验证码错误 | |
2004 | 发送邮件验证码失败 | 发送邮件验证码错误 |
7. 描述
删除象志。
8. 调用场景
根象志在超级控制台登录. 它会让资源永久消失。。
9. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelObjl | |
URL | https://api.xdua.com/objl | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Zoon | Zoon可以删除象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | DeleteObjl | |
XduaApiRule | DeleteObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
10. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
11. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
12. 错误码
13. 描述
关闭象志。
14. 调用场景
神管理员登录超级控制台后,可以关闭普通开发者的象志。使得象志进入DISABLED状态,也只有Zoon角色重新打开这个象志。
管理员(Zoon)
- 登录http://consoler.{zond_id}.xdua.com后,
- 根据条件查询象志,条件是某个象志。
- 点击
冻结
,可以关闭象志。
15. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DisObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖象志,只有这个象志的登录人员才可以访问 |
XduaApiSubject | i | 必须是创建者才可以自闭象志 |
XduaApiRoles | Admin | 只有神级管理员才可以关闭普通开发者的象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | DisableObjl | |
XduaApiRule | DisableObjl | |
XduaApiAstates | 0,0 或者0 |
按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
16. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
17. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
18. 错误码
19. 描述
软删象志。
20. 调用场景
开发者登录超级控制台后,可以点击自己的象志,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
21. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的象志 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | DeletoObjl | |
XduaApiRule | DeletoObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
22. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
23. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
24. 错误码
25. 描述
打开象志。
26. 调用场景
管理员(Zoon)
- 登录http://consolex.xdua.com后,
- 根据条件查询象志,条件是某个被冻结的象志。
- 点击
解冻
,可以解冻店铺。
27. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | EnbObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的象志 |
XduaApiRoles | Admin | 只有神才可以解冻象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | EnableObjl | |
XduaApiRule | EnableObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
28. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
29. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
30. 错误码
31. 描述
详情象志。
32. 调用场景
管理员登录超级控制台后,可以随意查询能看见的所有象志列表。点击其中一个象志(不管是不是自己的),就可以点击访问。
33. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/objl | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | !表示除了允许匿名象志之外的所有象志访问 |
XduaApiRoles | Zoon | 只要Zoon才可以访问其它象志的象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | GetObjl | |
XduaApiRule | GetObjl | |
XduaApiObjlAstate | 0 | 象志zone.state必须是0(STATE_ENABLED) |
XduaApiCorpAstate | 0 | 象志corp.state必须是0(STATE_ENABLED) |
XduaApiShopAstate | 0 | 象志shop.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志objl.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志 objl.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志objl.state必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
34. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的象志ID |
35. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
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 |
objl_id | string | 所属户群的id |
objl_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 | 象志请求时客户端的ObjlAgent |
exp | int | 象志的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。 |
vtl | int | 象志的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的objl计算vtl为0时,会自动被重置为-1 |
ugrp | string | 象志持有象志所在的象志群,匿名象志的户群是常量:"XdUaXduA" |
role | string | 象志持有象志所在的角色列表,匿名象志的角色列表是常量:"none" |
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
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 | 辣椒帅 | 社区创建者名字 |
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 | 象志最近更新时间 |
[!note] 象志的使能状态,0:打开 1:关闭. 关闭的象志处于冻结状态,不接受登陆/注册所有操作.
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
36. 错误码
37. 描述
私详象志。
38. 调用场景
开发者登录超级控制台后,在象志列表,选择象志,点击详情,就可以查看自己的象志。GIT的默认字段和GET不一样。
39. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/objl | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的象志 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | GetObjl | |
XduaApiRule | GetObjl | |
XduaApiObjlAstate | 0 | 象志zone.state必须是0(STATE_ENABLED) |
XduaApiCorpAstate | 0 | 象志corp.state必须是0(STATE_ENABLED) |
XduaApiShopAstate | 0 | 象志shop.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志objl.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志 objl.state必须是0(STATE_ENABLED) |
XduaApiObjlAstate | 0 | 象志objl.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 | 辣椒帅 | 象志创建者名字 |
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": {
},
}
42. 错误码
43. 描述
下线象志。
44. 调用场景
开发者登录超级控制台后,可以下线自己创建的象志。
45. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | OffObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能象志的创建者才能下线自己的象志 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | OfflineObjl | |
XduaApiRule | OfflineObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
46. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
47. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
48. 错误码
49. 描述
发布象志。
50. 调用场景
开发者登录超级控制台后,可以下线/发布自己的象志。这个动作是管理员不能干涉的。
51. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | PubObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有象志的创建者自己才能上下线自己的象志 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | OnlineObjl | |
XduaApiRule | OnlineObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
52. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的象志ID |
53. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的象志ID |
54. 错误码
55. 描述
私查象志。
56. 调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有象志。
57. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriObjl | |
URL | https://api.xdua.com/objl | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 所有注册象志均可以使用 |
XduaApiRoles | Zoon | 必须是Zoon才可以查询角色 |
XduaApiResource | objl | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriObjl | |
XduaApiRule | QueriObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
58. URL
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 | 辣椒帅 | 象志创建者名字 |
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 | 象志最近更新时间 |
61. 错误码
62. 描述
查询象志。
63. 调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有象志。
64. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryObjl | |
URL | https://api.xdua.com/objl | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册象志均可以使用 |
XduaApiRoles | Admin | 必须是Zoon才可以查询角色 |
XduaApiResource | objl | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryObjl | |
XduaApiRule | QueryObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
65. URL
66. 请求参数
字段名 | 位置 | 类型 | 说明 | 描述 | 可选 |
---|---|---|---|---|---|
apiv | head | string | API版本,默认是1.0.0 | 1.0.0 | 可选 |
Authorization | head | string | 客户端保存的鉴权token | Authorization字符串 | 必选 |
tabx | query | string | 象志表 | 象志表 | 可选 |
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 | 辣椒帅 | 象志创建者名字 |
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 | 象志最近更新时间 |
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 | 象志最近更新时间 |
68. 错误码
69. 描述
回收象志。
70. 调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的象志。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的象志的名字。
71. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | u表示除了允许匿名象志之外的所有象志访问 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | RecycleObjl | |
XduaApiRule | RecycleObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,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 | SetObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | UpdateObjl | |
XduaApiRule | UpdateObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,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个字符。 |
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
user_id | path | String | 用户m5d,登陆时获得 | 可选 | ||
oldpwd | body | String | 旧象志,32位md5码 | 可选 | ||
pwd | body | String | 新象志,32位md5码 | 可选 |
79. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的象志ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的象志名",
"brief":"新的象志介绍",
}
}
80. 错误码
81. 描述
修改象志。
82. 调用场景
开发者登录超级控制台后,可以修改自己创建的象志。修改仅仅限于可以修改的name,brief等字段。
83. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetObjl | |
URL | https://api.xdua.com/objl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神象志,才可以创建象志 |
XduaApiAudience | ConsoleX | 只有objl_id为ConsoleX的象志,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 象志直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建象志 |
XduaApiResource | objl | |
XduaApiKparam | id | |
XduaApiAction | UpdateObjl | |
XduaApiRule | UpdateObjl | |
XduaApiAstates | 0 | 按序objl,zone,corp,shop,objl,objl,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个字符。 |
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
user_id | path | String | 用户m5d,登陆时获得 | 可选 | ||
oldpwd | body | String | 旧象志,32位md5码 | 可选 | ||
pwd | body | String | 新象志,32位md5码 | 可选 |
85. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的象志ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的象志名",
"brief":"新的象志介绍",
}
}