1. 描述

店卷管理主要在http://consoler.{zond_id}.xdua.com下进行。参与角色有Shep,Shep,Shep三个角色。

2. 接口动作

缩名 全名 方法 中文 角色 描述
ADD Create POST 创建 Shep 创建店卷
DEL Delete DELETE 删除 Shep 删除店卷
SET Update PUT 修改 Shep 修改店卷
DOL Deleto PUT 软删 Shep 软删店卷
DIS Disable PUT 关闭 Shep 关闭店卷
ENB Enable PUT 打开 Shep 打开店卷
RCC Recycle PUT 回收 Shep 回收店卷
PUB Publish PUT 发布 Shep 发布店卷
OFF Offline PUT 下线 Shep 下线店卷
GET Get GET 详情 Shep 详情店卷
GIT Git GET 私详 Shep 私详店卷
QRY Query GET 查询 Shep 查询店卷
QRI Queri GET 私查 Shep 私查店卷

3. 资源状态

4. 错误码

参考错误码

5. 描述

创建店卷。

6. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以以Shep店卷创建自己的店卷。

7. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddRoueb
Url https://api.xdua.com/rolex
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 需要登录
XduaApiRoles Shep Shep可以创建店卷
XduaApiResource role
XduaApiKparam name
XduaApiAction CreateRoueb
XduaApiRule CreateRoueb
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 Shep 店卷的代号,16个字符以内,小写字母,数字和字母,不能有特殊符号,一旦创建,不可修改
granter body string Shep 授权店卷代号,code标准格式

9. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的店卷ID

10. 错误码

11. 描述

删除店卷。

12. 调用场景

根用户在http://consoler.{zond_id}.xdua.com登录. 它会让资源永久消失。。

13. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelRoueb
URL https://api.xdua.com/rolex
Method DELETE
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DEL
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有资源创建者自己可以访问这个口
XduaApiRoles Shep Shep可以删除店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction DeleteRoueb
XduaApiRule DeleteRoueb
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. 调用场景

神管理员登录http://consoler.{zond_id}.xdua.com后,可以关闭普通开发者的店卷。使得店卷进入DISABLED状态,也只有Shep角色重新打开这个店卷。

管理员(Shep)

  1. 登录http://consoler.{zond_id}.xdua.com后,
  2. 根据条件查询店卷,条件是某个店卷。
  3. 点击冻结,可以关闭店卷。

19. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DIS
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店卷,只有这个店卷的登录人员才可以访问
XduaApiSubject u 必须是创建者才可以自闭店卷
XduaApiRoles Shep 只有神级管理员才可以关闭普通开发者的店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction DisableRoueb
XduaApiRule DisableRoueb
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. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以点击自己的店卷,然后删除掉。如果哪天后悔了,可以联系Shep来恢复。

25. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DOL
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有创建者自己才能删除自己创建的店卷
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction DeletoRoueb
XduaApiRule DeletoRoueb
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. 调用场景

管理员(Shep)

  1. 登录http://consoler.xdua.com后,
  2. 根据条件查询店卷,条件是某个被冻结的店卷。
  3. 点击解冻,可以解冻店铺。

31. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ENB
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 神登录后解冻开发者的店卷
XduaApiRoles Shep 只有神才可以解冻店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction EnableRoueb
XduaApiRule EnableRoueb
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. 调用场景

管理员登录http://consoler.{zond_id}.xdua.com后,可以随意查询能看见的所有店卷列表。点击其中一个店卷(不管是不是自己的),就可以点击访问。

37. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u !表示除了允许匿名用户之外的所有用户访问
XduaApiRoles Shep 只要Shep才可以访问其它用户的店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction GetRoueb
XduaApiRule GetRoueb
XduaApiRouebAstate 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. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,在店卷列表,选择店卷,点击详情,就可以查看自己的店卷。GIT的默认字段和GET不一样。

43. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的店卷
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction GetRoueb
XduaApiRule GetRoueb
XduaApiRouebAstate 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. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以下线自己创建的店卷。

49. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只能店卷的创建者才能下线自己的店卷
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction OfflineRoueb
XduaApiRule OfflineRoueb
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. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以下线/发布自己的店卷。这个动作是管理员不能干涉的。

55. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有店卷的创建者自己才能上下线自己的店卷
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction OnlineRoueb
XduaApiRule OnlineRoueb
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://consoler.xdua.com后,可以以Shep角色查询所有店卷。

61. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriRoueb
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles Shep 必须是Shep才可以查询角色
XduaApiResource role
XduaApiKparam where 常量
XduaApiAction QueriRoueb
XduaApiRule QueriRoueb
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://consoler.xdua.com后,可以以Shep角色查询属于自己名下的所有店卷。

68. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryRoueb
URL https://api.xdua.com/rolex
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles Shep 必须是Shep才可以查询角色
XduaApiResource role
XduaApiKparam where 常量where
XduaApiAction QueryRoueb
XduaApiRule QueryRoueb
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. 描述

回收店卷。

74. 调用场景

管理员应开发者的要求,登录http://consoler.{zond_id}.xdua.com后,查询到某个开发者下面的被删除的店卷。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的店卷的名字。

75. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u u表示除了允许匿名用户之外的所有用户访问
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction RecycleRoueb
XduaApiRule RecycleRoueb
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

76. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要删除的店卷ID

77. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的店卷ID

78. 错误码

79. 描述

修改店卷。

80. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以修改自己创建的店卷。修改仅仅限于可以修改的name,brief等字段。

81. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetRoueb
URL https://api.xdua.com/rolex
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神令牌,才可以创建店卷
XduaApiAudience {zone_console_app_id} 只有app_id为{zone_console_app_id}的应用,也就是consoler.xdua.com才可以发起本请求
XduaApiShop {zone_id} 店卷直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Shep 只要登录就可以创建店卷
XduaApiResource role
XduaApiKparam id
XduaApiAction UpdateRoueb
XduaApiRule UpdateRoueb
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

82. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要修改的店卷ID
name body string 店卷的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符
avatar body string 店卷图标,不超过40个字符。
brief body string 店卷描述,不超过64个字符。

83. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的店卷ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的店卷名",
        "brief":"新的店卷介绍",    
    }    
}

84. 错误码

results matching ""

    No results matching ""