1. 描述
创建小区。
2. 调用场景
开发者登录超级控制台后,可以以Zoon小区创建自己的小区。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddVila | |
Url | https://api.xdua.com/vila | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRoles | Zoon | Zoon可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | name | |
XduaApiAction | CreateVila | |
XduaApiRule | CreateVila | |
XduaApiAvilas | 0 | |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
name | body | string | 是 | 健康手环 | 小区的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | |
avatar | body | string | 否 | 小区图标,不超过40个字符。 | ||
brief | body | string | 否 | 小区描述,不超过64个字符。 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的小区ID |
6. 错误码
7. 描述
删除小区。
8. 调用场景
根用户在超级控制台登录. 它会让资源永久消失。。
9. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelVila | |
URL | https://api.xdua.com/vila | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Zoon | Zoon可以删除小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | DeleteVila | |
XduaApiRule | DeleteVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,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 | DisVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖小区,只有这个小区的登录人员才可以访问 |
XduaApiSubject | i | 必须是创建者才可以自闭小区 |
XduaApiRoles | Admin | 只有神级管理员才可以关闭普通开发者的小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | DisableVila | |
XduaApiRule | DisableVila | |
XduaApiAvilas | 0,0 或者0 |
按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
16. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的小区ID |
17. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的小区ID |
18. 错误码
19. 描述
软删小区。
20. 调用场景
开发者登录超级控制台后,可以点击自己的小区,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
21. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的小区 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | DeletoVila | |
XduaApiRule | DeletoVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,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 | EnbVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的小区 |
XduaApiRoles | Admin | 只有神才可以解冻小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | EnableVila | |
XduaApiRule | EnableVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,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/vila | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | !表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要Zoon才可以访问其它用户的小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | GetVila | |
XduaApiRule | GetVila | |
XduaApiVilaAvila | 0 | 令牌zone.vila必须是0(STATE_ENABLED) |
XduaApiCorpAvila | 0 | 令牌corp.vila必须是0(STATE_ENABLED) |
XduaApiShopAvila | 0 | 令牌shop.vila必须是0(STATE_ENABLED) |
XduaApiUserAvila | 0 | 令牌user.vila必须是0(STATE_ENABLED) |
XduaApiVilaAvila | 0 | 令牌 vila.vila必须是0(STATE_ENABLED) |
XduaApiTokenAvila | 0 | 令牌token.vila必须是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 | 角权的描述 | |
vila | 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 |
vila_id | string | 所属户群的id |
vila_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": {
},
}
36. 错误码
37. 描述
私详小区。
38. 调用场景
开发者登录超级控制台后,在小区列表,选择小区,点击详情,就可以查看自己的小区。GIT的默认字段和GET不一样。
39. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/vila | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的小区 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | GetVila | |
XduaApiRule | GetVila | |
XduaApiVilaAvila | 0 | 令牌zone.vila必须是0(STATE_ENABLED) |
XduaApiCorpAvila | 0 | 令牌corp.vila必须是0(STATE_ENABLED) |
XduaApiShopAvila | 0 | 令牌shop.vila必须是0(STATE_ENABLED) |
XduaApiUserAvila | 0 | 令牌user.vila必须是0(STATE_ENABLED) |
XduaApiVilaAvila | 0 | 令牌 vila.vila必须是0(STATE_ENABLED) |
XduaApiTokenAvila | 0 | 令牌token.vila必须是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 | 小区的描述 | |
vila | 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 | OffVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能小区的创建者才能下线自己的小区 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | OfflineVila | |
XduaApiRule | OfflineVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
46. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的小区ID |
47. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的小区ID |
48. 错误码
49. 描述
发布小区。
50. 调用场景
开发者登录超级控制台后,可以下线/发布自己的小区。这个动作是管理员不能干涉的。
51. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | PubVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有小区的创建者自己才能上下线自己的小区 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | OnlineVila | |
XduaApiRule | OnlineVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
52. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的小区ID |
53. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的小区ID |
54. 错误码
55. 描述
私查小区。
56. 调用场景
开发者登录http://developer.xdua.com后,可以以Zoon角色查询属于自己名下的所有小区。
57. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriVila | |
URL | https://api.xdua.com/vila | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 所有注册用户均可以使用 |
XduaApiRoles | Zoon | 必须是Zoon才可以查询角色 |
XduaApiResource | vila | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriVila | |
XduaApiRule | QueriVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,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 | 小区的描述 | |
vila | 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. SDK调用
const api_param = {
limit:5
}
let api_res = await xduaClient.addLoginr(api_param)
管理员登录超级控制台后,可以以God角色查询平台上所有小区。
64. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryVila | |
URL | https://api.xdua.com/vila | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | God | 必须是God才可以查询角色 |
XduaApiResource | vila | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryVila | |
XduaApiRule | QueryVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
65. 请求参数
66. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的小区ID |
name | result.list[] | string | 小区的名称 | |
avatar | result.list[] | string | 小区图标 | |
brief | result.list[] | string | 小区的描述 | |
vila | 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 | 小区的描述 | |
vila | 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 | 小区最近更新时间 |
67. 错误码
68. 描述
回收小区。
69. 调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的小区。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的小区的名字。
70. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | u表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | RecycleVila | |
XduaApiRule | RecycleVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
71. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的小区ID |
72. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的小区ID |
73. 错误码
74. 描述
修改小区。
75. 调用场景
开发者登录超级控制台后,可以修改自己创建的小区。修改仅仅限于可以修改的name,brief等字段。
76. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetVila | |
URL | https://api.xdua.com/vila | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神令牌,才可以创建小区 |
XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Zoon | 只要登录就可以创建小区 |
XduaApiResource | vila | |
XduaApiKparam | id | |
XduaApiAction | UpdateVila | |
XduaApiRule | UpdateVila | |
XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
77. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
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:打开|可选|
78. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的小区ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的小区名",
"brief":"新的小区介绍",
}
}
79. 错误码
80. 描述
修改应用。
81. 调用场景
开发者登录超级控制台后,可以修改自己创建的应用。修改仅仅限于可以修改的name,brief等字段。
82. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
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 | |
XduaApiAvilas | 0 | 按序devl,zone,corp,shop,devl,devl,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
83. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
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码 | 可选 |
84. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的应用ID |
ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的应用名",
"brief":"新的应用介绍",
}
}