1. 描述

象目管理主要在超级控制台下进行。开发者进入consolex.xdua.com,点击自己的社区，进入社区(触发AddLogon操作)，创建象目。因为验证码的创建仅仅是通过tmpl来进行的。隐藏了各种验证码是T,M,N的区别。所以验证码的创建不再分离,tobjc,mobjc,iobjc的区别。而是直接是objc。也不再区分objcx和objcr，即，也不就验证码是神店铺还是红店铺进行区分。

2. 接口动作

缩名	全名	方法	中文	角色	描述
ADD	Create	POST	创建	Zoon	创建象目
DEL	Delete	DELETE	删除	Zoon	删除象目
SET	Update	PUT	修改	Zoon	修改象目
SIT	Updite	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. 描述

重置象目，使用验证码直接修改象目，在忘记旧象目的情况下使用。

用户注册:固定字段和额外字段。这么设计的原因是不同用户表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段，所以要求额外的自定义字段放在extra里。

6. 调用场景

开发者登录超级控制台后,可以以Zoon象目创建自己的象目。

7. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	AddObjctmpl
Url	https://api.xdua.com/objctmpl
Method	POST
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	ADD
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	需要登录
XduaApiRoles	Zoon	Zoon可以创建象目
XduaApiResource	objc
XduaApiKparam	name
XduaApiAction	CreateObjctmpl
XduaApiRule	CreateObjctmpl
XduaApiAstates	0
XduaApiEnable	true	接口使能

8. 请求参数

名称	位置	类型	必填	默认值	示例	说明
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"

9. 返回参数

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

10. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

错误码	错误码名	可能原因
2001	象目访问过于频繁	同一个电话只能在5分钟后发送象目访问	失败
2002	象目生成失败	在生成验证码入库时发生错误
2003	发送短信验证码失败	通过运营商发送短信验证码错误
2004	发送邮件验证码失败	发送邮件验证码错误

11. 描述

删除象目。

12. 调用场景

根象目在超级控制台登录. 它会让资源永久消失。。

13. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	DelObjctmpl
URL	https://api.xdua.com/objctmpl
Method	DELETE
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	DEL
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	只有资源创建者自己可以访问这个口
XduaApiRoles	Zoon	Zoon可以删除象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	DeleteObjctmpl
XduaApiRule	DeleteObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,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	DisObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	DIS
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖象目,只有这个象目的登录人员才可以访问
XduaApiSubject	i	必须是创建者才可以自闭象目
XduaApiRoles	Admin	只有神级管理员才可以关闭普通开发者的象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	DisableObjctmpl
XduaApiRule	DisableObjctmpl
XduaApiAstates	`0,0` 或者`0`	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

20. 请求参数

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

21. 返回参数

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

22. 错误码

23. 描述

软删象目。

24. 调用场景

开发者登录超级控制台后,可以点击自己的象目，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。

25. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	DolObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	DOL
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	只有创建者自己才能删除自己创建的象目
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	DeletoObjctmpl
XduaApiRule	DeletoObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,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	EnbObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	ENB
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	u	神登录后解冻开发者的象目
XduaApiRoles	Admin	只有神才可以解冻象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	EnableObjctmpl
XduaApiRule	EnableObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,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/objctmpl
Method	GET
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	GET
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	!表示除了允许匿名象目之外的所有象目访问
XduaApiRoles	Zoon	只要Zoon才可以访问其它象目的象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	GetObjctmpl
XduaApiRule	GetObjctmpl
XduaApiObjctmplAstate	0	象目zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate	0	象目corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate	0	象目shop.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目objc.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目 objc.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目objc.state必须是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		角权的描述
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
objc_id	string	所属户群的id
objc_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	象目请求时客户端的ObjctmplAgent
exp	int	象目的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。
vtl	int	象目的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的objc计算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": {


    },
}

40. 错误码

41. 描述

私详象目。

42. 调用场景

开发者登录超级控制台后,在象目列表，选择象目，点击详情，就可以查看自己的象目。GIT的默认字段和GET不一样。

43. 配置参数

参数名	参数值	说明
URL	https://api.xdua.com/objctmpl
Method	GET
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	GIT
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	只有自己才可以访问自己创建的象目
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	GetObjctmpl
XduaApiRule	GetObjctmpl
XduaApiObjctmplAstate	0	象目zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate	0	象目corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate	0	象目shop.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目objc.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目 objc.state必须是0(STATE_ENABLED)
XduaApiObjctmplAstate	0	象目objc.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	辣椒帅	象目创建者名字
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	OffObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	OFF
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	只能象目的创建者才能下线自己的象目
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	OfflineObjctmpl
XduaApiRule	OfflineObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

50. 请求参数

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

51. 返回参数

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

52. 错误码

53. 描述

发布象目。

54. 调用场景

开发者登录超级控制台后,可以下线/发布自己的象目。这个动作是管理员不能干涉的。

55. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	PubObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	PUB
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	只有象目的创建者自己才能上下线自己的象目
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	OnlineObjctmpl
XduaApiRule	OnlineObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

56. 请求参数

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

57. 返回参数

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

58. 错误码

59. 描述

私查象目。

60. 调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有象目。

61. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	QriObjctmpl
URL	https://api.xdua.com/objctmpl
Method	GET
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	QRI
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	所有注册象目均可以使用
XduaApiRoles	Zoon	必须是Zoon才可以查询角色
XduaApiResource	objc
XduaApiKparam	`where`	常量
XduaApiAction	QueriObjctmpl
XduaApiRule	QueriObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

62. URL

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

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	辣椒帅	象目创建者名字
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. 调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有象目。

68. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	QryObjctmpl
URL	https://api.xdua.com/objctmpl
Method	GET
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	QRY
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	u	所有注册象目均可以使用
XduaApiRoles	Admin	必须是Zoon才可以查询角色
XduaApiResource	objc
XduaApiKparam	`where`	常量where
XduaApiAction	QueryObjctmpl
XduaApiRule	QueryObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

69. URL

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

70. 请求参数

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

字段名	位置	类型	说明	描述	可选
apiv	head	string	API版本,默认是1.0.0	1.0.0	可选
Authorization	head	string	客户端保存的鉴权token	Authorization字符串	必选
tabx	query	string	象目表	象目表	可选

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	辣椒帅	象目创建者名字
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	象目最近更新时间

72. 错误码

73. 描述

回收象目。

74. 调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的象目。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的象目的名字。

75. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	RccObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	RCC
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	u表示除了允许匿名象目之外的所有象目访问
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	RecycleObjctmpl
XduaApiRule	RecycleObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

76. 请求参数

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

77. 返回参数

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

78. 错误码

79. 描述

修改象目。

80. 调用场景

开发者登录超级控制台后,可以修改自己创建的象目。修改仅仅限于可以修改的name,brief等字段。

81. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	SetObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	SET
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	i,只有创建者自己才可以修改
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	UpdateObjctmpl
XduaApiRule	UpdateObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,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个字符。

名称	位置	类型	必填	默认值
user_id	path	String	用户m5d,登陆时获得	可选
oldpwd	body	String	旧象目,32位md5码	可选
pwd	body	String	新象目,32位md5码	可选

83. 返回参数

名称	位置	类型	示例	说明
id	result	string	rYub4wrT	修改的象目ID
ipdates	result	json dict		修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的象目名",
        "brief":"新的象目介绍",    
    }    
}

84. 错误码

85. 描述

修改象目。

86. 调用场景

开发者登录超级控制台后,可以修改自己创建的象目。修改仅仅限于可以修改的name,brief等字段。

87. 配置参数

参数意义参考接口参数

参数名	参数值	说明
Name	SetObjctmpl
URL	https://api.xdua.com/objctmpl
Method	PUT
XduaApiHttpSchema	HTTPS	只走HTTPS
XduaApiMethod	SET
XduaApiColor	X	只有持有神象目，才可以创建象目
XduaApiAudience	ConsoleX	只有objc_id为ConsoleX的象目，也就是consolex.xdua.com才可以发起本请求
XduaApiShop	XdUaXduA	象目直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject	i	i,只有创建者自己才可以修改
XduaApiRoles	Zoon	只要登录就可以创建象目
XduaApiResource	objc
XduaApiKparam	id
XduaApiAction	UpdateObjctmpl
XduaApiRule	UpdateObjctmpl
XduaApiAstates	0	按序objc,zone,corp,shop,objc,objc,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable	true	接口使能

88. 请求参数

名称	位置	类型	必填	示例	说明
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码	可选

89. 返回参数

名称	位置	类型	示例	说明
id	result	string	rYub4wrT	修改的象目ID
ipdates	result	json dict		修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的象目名",
        "brief":"新的象目介绍",    
    }    
}