1. 描述
应用管理主要在超级控制台下进行。开发者进入consolex.xdua.com,点击自己的社区,进入社区(触发AddLogon操作),创建应用。
2. 接口动作
缩名 | 全名 | 方法 | 中文 | 角色 | 描述 |
---|---|---|---|---|---|
ADD | Create | POST | 创建 | Zoon | 创建应用 |
DEL | Delete | DELETE | 删除 | Zoon | 删除应用 |
SET | Update | PUT | 修改 | Zoon | 修改应用 |
DOL | Deleto | PUT | 软删 | Zoon | 软删应用 |
DIS | Disable | PUT | 关闭 | Zoon | 关闭应用 |
ENB | Enable | PUT | 打开 | Zoon | 打开应用 |
RCC | Recycle | PUT | 回收 | Zoon | 回收应用 |
PUB | Publish | PUT | 发布 | Zoon | 发布应用 |
OFF | Offline | PUT | 下线 | Zoon | 下线应用 |
GET | Get | GET | 详情 | Zoon | 详情应用 |
GIT | Git | GET | 私详 | Zoon | 私详应用 |
QRY | Query | GET | 查询 | Zoon | 查询应用 |
QRI | Queri | GET | 私查 | Zoon | 私查应用 |
3. 资源状态
4. 错误码
参考错误码
5. 描述
创建城市。
6. 调用场景
开发者登录超级控制台后,可以以Zoon城市创建自己的城市。
7. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddState | |
Url | https://api.xdua.com/city | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRoles | Zoon | Zoon可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | name | |
XduaApiAction | CreateState | |
XduaApiRule | CreateState | |
XduaApiAcitys | 0 | |
XduaApiEnable | true | 接口使能 |
8. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
name | body | string | 是 | 健康手环 | 城市的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | |
avatar | body | string | 否 | 城市图标,不超过40个字符。 | ||
brief | body | string | 否 | 城市描述,不超过64个字符。 |
9. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的城市ID |
10. 错误码
11. 描述
删除城市。
12. 调用场景
根用户在超级控制台登录. 它会让资源永久消失。。
13. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelState | |
URL | https://api.xdua.com/city | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Zoon | Zoon可以删除城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | DeleteState | |
XduaApiRule | DeleteState | |
XduaApiAcitys | 0 | 按序city,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状态,也只有Zoon角色重新打开这个城市。
管理员(Zoon)
- 登录http://consoler.{zond_id}.xdua.com后,
- 根据条件查询城市,条件是某个城市。
- 点击
冻结
,可以关闭城市。
19. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DisState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖城市,只有这个城市的登录人员才可以访问 |
XduaApiSubject | i | 必须是创建者才可以自闭城市 |
XduaApiRoles | Admin | 只有神级管理员才可以关闭普通开发者的城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | DisableState | |
XduaApiRule | DisableState | |
XduaApiAcitys | 0,0 或者0 |
按序city,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. 调用场景
开发者登录超级控制台后,可以点击自己的城市,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
25. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的城市 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | DeletoState | |
XduaApiRule | DeletoState | |
XduaApiAcitys | 0 | 按序city,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. 调用场景
管理员(Zoon)
- 登录http://consolex.xdua.com后,
- 根据条件查询城市,条件是某个被冻结的城市。
- 点击
解冻
,可以解冻店铺。
31. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | EnbState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的城市 |
XduaApiRoles | Admin | 只有神才可以解冻城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | EnableState | |
XduaApiRule | EnableState | |
XduaApiAcitys | 0 | 按序city,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/city | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | !表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要Zoon才可以访问其它用户的城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | GetState | |
XduaApiRule | GetState | |
XduaApiStateAcity | 0 | 令牌zone.city必须是0(STATE_ENABLED) |
XduaApiCorpAcity | 0 | 令牌corp.city必须是0(STATE_ENABLED) |
XduaApiShopAcity | 0 | 令牌shop.city必须是0(STATE_ENABLED) |
XduaApiUserAcity | 0 | 令牌user.city必须是0(STATE_ENABLED) |
XduaApiStateAcity | 0 | 令牌 city.city必须是0(STATE_ENABLED) |
XduaApiTokenAcity | 0 | 令牌token.city必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
38. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的城市ID |
39. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
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 | 角权的描述 | |
city | 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 |
city_id | string | 所属户群的id |
city_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 | 更新的时间戳字符串 |
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
40. 错误码
41. 描述
私详城市。
42. 调用场景
开发者登录超级控制台后,在城市列表,选择城市,点击详情,就可以查看自己的城市。GIT的默认字段和GET不一样。
43. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/city | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的城市 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | GetState | |
XduaApiRule | GetState | |
XduaApiStateAcity | 0 | 令牌zone.city必须是0(STATE_ENABLED) |
XduaApiCorpAcity | 0 | 令牌corp.city必须是0(STATE_ENABLED) |
XduaApiShopAcity | 0 | 令牌shop.city必须是0(STATE_ENABLED) |
XduaApiUserAcity | 0 | 令牌user.city必须是0(STATE_ENABLED) |
XduaApiStateAcity | 0 | 令牌 city.city必须是0(STATE_ENABLED) |
XduaApiTokenAcity | 0 | 令牌token.city必须是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 | 城市的描述 | |
city | 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": {
},
}
46. 错误码
47. 描述
下线城市。
48. 调用场景
开发者登录超级控制台后,可以下线自己创建的城市。
49. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | OffState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能城市的创建者才能下线自己的城市 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | OfflineState | |
XduaApiRule | OfflineState | |
XduaApiAcitys | 0 | 按序city,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 | PubState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有城市的创建者自己才能上下线自己的城市 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | OnlineState | |
XduaApiRule | OnlineState | |
XduaApiAcitys | 0 | 按序city,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://developer.xdua.com后,可以以Zoon角色查询属于自己名下的所有城市。
61. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriState | |
URL | https://api.xdua.com/city | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 所有注册用户均可以使用 |
XduaApiRoles | Zoon | 必须是Zoon才可以查询角色 |
XduaApiResource | city | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriState | |
XduaApiRule | QueriState | |
XduaApiAcitys | 0 | 按序city,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
62. URL
63. 请求参数
64. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的城市ID |
name | result.list[] | string | 城市的名称 | |
avatar | result.list[] | string | 城市图标 | |
brief | result.list[] | string | 城市的描述 | |
city | 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 | 城市最近更新时间 |
65. 错误码
66. 描述
查询城市。
67. SDK调用
const api_param = {
limit:5
}
let api_res = await xduaClient.addLoginr(api_param)
管理员登录超级控制台后,可以以God角色查询平台上所有城市。
68. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryState | |
URL | https://api.xdua.com/city | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | God | 必须是God才可以查询角色 |
XduaApiResource | city | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryState | |
XduaApiRule | QueryState | |
XduaApiAcitys | 0 | 按序city,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
69. 请求参数
70. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的城市ID |
name | result.list[] | string | 城市的名称 | |
avatar | result.list[] | string | 城市图标 | |
brief | result.list[] | string | 城市的描述 | |
city | 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 | 城市的描述 | |
city | 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 | 城市最近更新时间 |
71. 错误码
72. 描述
回收城市。
73. 调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的城市。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的城市的名字。
74. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | u表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | RecycleState | |
XduaApiRule | RecycleState | |
XduaApiAcitys | 0 | 按序city,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
75. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的城市ID |
76. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的城市ID |
77. 错误码
78. 描述
修改城市。
79. 调用场景
开发者登录超级控制台后,可以修改自己创建的城市。修改仅仅限于可以修改的name,brief等字段。
80. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetState | |
URL | https://api.xdua.com/city | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建城市 |
XduaApiResource | city | |
XduaApiKparam | id | |
XduaApiAction | UpdateState | |
XduaApiRule | UpdateState | |
XduaApiAcitys | 0 | 按序city,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
81. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
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:打开|可选|
82. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的城市ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的城市名",
"brief":"新的城市介绍",
}
}
83. 错误码
84. 描述
修改应用。
85. 调用场景
开发者登录超级控制台后,可以修改自己创建的应用。修改仅仅限于可以修改的name,brief等字段。
86. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetDevltmpl | |
URL | https://api.xdua.com/devltmpl | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神应用,才可以创建应用 |
XduaApiAudience | ConsoleX | 只有devl_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 应用直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建应用 |
XduaApiResource | devl | |
XduaApiKparam | id | |
XduaApiAction | UpdateDevltmpl | |
XduaApiRule | UpdateDevltmpl | |
XduaApiAcitys | 0 | 按序devl,zone,corp,shop,devl,devl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
87. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
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码 | 可选 |
88. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的应用ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的应用名",
"brief":"新的应用介绍",
}
}