1. 描述

企业管理主要在http://consoler.{zond_id}.xdua.com下进行。参与角色有Super,Admin,Zoon三个角色。

2. 接口动作

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

3. 资源状态

4. 错误码

参考错误码

5. 描述

创建企业。 登录用户都可以创建企业,但一家企业只能属于一家用户。只有在户群平台登录，获取红令牌后，就可以以角色none创建企业。企业创建必须只能自己创建自己的，不能替别人创建。

6. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以以Zoon角色创建自己的企业。

7. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddCorp
Url https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam name
XduaApiAction CreateCorp
XduaApiRule CreateCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

8. 请求参数

名称 位置 类型 必填 默认值 示例 说明
avatar body string 否 企业图标，不超过40个字符。
brief body string 否 企业简介，不超过64个字符。
code body string 是 12100000400012342E 营业执照号
name body string 是 中国科学院计算技术研究所 企业的名称。必须与营业执照一致。

[!note] 企业创建时遵从简单第一步原则，创建只需要企业名和企业执照号两个属性就可以创建企业。剩下通过setcorp来完善。

9. 返回参数

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

10. 错误码

11. 描述

删除企业。

12. 调用场景

根用户在http://consoler.{zond_id}.xdua.com登录，可以永久删除任何处于软删除状态的企业。这个权限不给Admin，是因为这个是权限非常高的操作，它会让所有资源消失。。

13. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelCorp
URL https://api.xdua.com/zone
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 Super 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction DeleteCorp
XduaApiRule DeleteCorp
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状态，也只有Admin角色重新打开这个企业。

19. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisCorp
URL https://api.xdua.com/zone
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 Admin 只有神级管理员才可以关闭普通开发者的企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction DisableCorp
XduaApiRule DisableCorp
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后,可以点击自己的企业，然后删除掉。如果哪天后悔了，可以联系Admin来恢复。

25. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolCorp
URL https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction DeletoCorp
XduaApiRule DeletoCorp
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. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbCorp
URL https://api.xdua.com/zone
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 Admin 只有神才可以解冻企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction EnableCorp
XduaApiRule EnableCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

31. 请求参数

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

32. 返回参数

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

33. 错误码

34. 描述

详情企业。

35. 调用场景

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

36. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/zone
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 Admin 只要Admin才可以访问其它用户的企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction GetCorp
XduaApiRule GetCorp
XduaApiCorpAstate 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 接口使能

37. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的企业ID

38. 返回参数

名称 位置 类型 示例 说明
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": {


    },
}

39. 错误码

40. 描述

私详企业。

41. 调用场景

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

42. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction GetCorp
XduaApiRule GetCorp
XduaApiCorpAstate 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 接口使能

43. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的企业ID

44. 返回参数

名称 位置 类型 示例 说明
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": {


    },
}

45. 错误码

46. 描述

下线企业。

47. 调用场景

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

48. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffCorp
URL https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction OfflineCorp
XduaApiRule OfflineCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

49. 请求参数

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

50. 返回参数

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

51. 错误码

52. 描述

发布企业。

53. 调用场景

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

54. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubCorp
URL https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction OnlineCorp
XduaApiRule OnlineCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

55. 请求参数

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

56. 返回参数

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

57. 错误码

58. 描述

私查企业。

59. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以以None角色查询所有社区。

60. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriCorp
URL https://api.xdua.com/zone
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 Admin 必须是Admin才可以查询角色
XduaApiResource zone
XduaApiKparam where 常量
XduaApiAction QueriCorp
XduaApiRule QueriCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

61. URL

GET:https://api.xdua.com/zone

62. 请求参数

参考标准查询接口请求参数

63. 返回参数

参考标准查询接口返回参数

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 企业最近更新时间

64. 错误码

65. 描述

查询企业。

66. 调用场景

开发者登录http://consoler.{zond_id}.xdua.com后,可以以God角色查询所有社区。

67. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryCorp
URL https://api.xdua.com/zone
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 Admin 必须是Admin才可以查询角色
XduaApiResource zone
XduaApiKparam where 常量where
XduaApiAction QueryCorp
XduaApiRule QueryCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

68. URL

GET:https://api.xdua.com/zone

69. 请求参数

参考标准查询接口请求参数

70. 返回参数

参考标准查询接口返回参数

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 企业最近更新时间

71. 错误码

72. 描述

回收企业。

73. 调用场景

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

74. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccCorp
URL https://api.xdua.com/zone
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 Admin 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction RecycleCorp
XduaApiRule RecycleCorp
XduaApiAstates 0 按序app,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. 描述

修改企业。 修改企业。默认企业是不可以修改的。企业的属性只能由企业的创建者和相应的被授权角色可以修改。但是企业的enabled还有控制属性是可以本户群的红神或者拥有相应权限才可以。

79. 调用场景

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

80. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetCorp
URL https://api.xdua.com/zone
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 Zoon 只要登录就可以创建企业
XduaApiResource zone
XduaApiKparam id
XduaApiAction UpdateCorp
XduaApiRule UpdateCorp
XduaApiAstates 0 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

81. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的企业ID
code body string 否 企业代号 企业营业执照号
type body string 否 事业单位 企业种类
name body string 否 企业名称 企业名称，不小于32个字符
brief body String 否 华天逸键是一家专注老人健康的企业。 企业的简介。
avatar body string 否 e10adc3949ba59abbe56e057f20f883e.jpg 企业头像，不小于40个字符

82. 返回参数

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

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的企业名",
        "brief":"新的企业介绍",    
    }    
}

83. 错误码

results matching ""

    No results matching ""