---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
jsonString	字符串	必须			集团ID和店铺ID
path	字符串	必须			open_api 路径: doc
openapi_appKey	字符串	可选
openapi_appSecret	字符串	可选
group_id	字符串	必须
brand_id	字符串	必须
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须			集团ID
app_name	字符串	必须			app 名称
app_type	字符串	必须	0		app 类型。电子菜单、 广告机、大屏点餐、电视广告
brand_id	字符串	必须			品牌ID
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.int	字符串	新增数据的ID
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识
bookConfigJson	字符串	可选	{}		json
template_id	字符串	可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识
categoryIndex	整型	必须	0		分类顺序
categoryName	字符串	必须	默认分类0		分类名字
category_id	字符串	可选			分类ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须			集团ID
group_name	字符串	可选			集团名称
brand_id	字符串	可选			品牌ID
brand_name	字符串	可选			品牌名称
brand_logo	字符串	可选			品牌LOGO
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.int	字符串	新增数据的ID
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
divName	字符串	必须			自定义组件名字
screenHotUrl	字符串	可选			组件快照
components	字符串	可选			组件数组
div_id	字符串	必须			自定义组件ID
book_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
file_type	字符串	可选			文件类型
file_group_id	整型	必须	0		文件分组ID 1、App素材 2、菜单菜品素材 3、饰品 4、组件快照 5、模板快照 6、页面快照
brand_id	字符串	必须			品牌ID
file	字符串	必须			要上传的文件，行base64编码后传递，对待上传文件二进制内容进行basse64编码后的数据
file_name	字符串	必须
other_uuid	字符串	必须			用户身份标识
snapshot_id	字符串	可选			快照ID
book_id	字符串	可选			上传page快照的时候必须传

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
pname	字符串	必须			数据 姓名
phone	字符串	必须			数据 电话号码

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	0表示更新新增成功
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
category_id	字符串	必须			分类ID
book_id	字符串	必须			book 标识
title	字符串	可选			pageName
pageIndex	字符串	可选			页面顺序
bgImageUrl	字符串	可选			page的背景图
components	字符串	可选			组件数组
page_id	字符串	必须			页码标识|索引添加失败
pageSnapshot	字符串	可选			页码快照图片地址

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
brand_id	字符串	必须			待删除的ID
other_uuid	字符串	必须
group_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
userName	字符串	必须
shopID	字符串	必须
admin_uuid	字符串	必须
admin_token	字符串	必须
roleId	字符串	可选			1 是集团， 2 是店铺 。空是散户
other_uuid	字符串	可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
file_url	字符串	可选			待删除的文件地址
other_uuid	字符串	必须			用户身份ID
brand_id	字符串	必须			品牌ID
file_id	字符串	可选			图片ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须
role_id	整型	必须	0
admin_uuid	字符串	必须
admin_token	字符串	可选
expiration_time	字符串	可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	可选			懂菜谱集团ID
brand_id	字符串	可选			懂菜谱品牌ID
other_uuid	字符串	可选			用户身份ID
path	字符串	可选			/datatransfer/getitems,/datatransfer/getshops,/datatransfer/getitemcategoryinfo
openapi_appKey	字符串	可选			商龙openAPI-appid
openapi_appSecret	字符串	可选			商龙openAPI-accessid
jsonString	字符串	可选			集团ID和店铺ID{"centerId":"201723","shopId":""}

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份
screenSize	字符串	必须			画布尺寸
brand_id	字符串	必须			品牌ID
client	字符串	可选			是否来自客户的
app_type	字符串	必须			app 类型。电子菜单、 广告机、大屏点餐、电视广告
deviceOrientation	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份
device_id	字符串	必须			设备ID
canvas_size	字符串	必须			画布尺寸
device_info	字符串	必须			设备信息

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份
screenSize	字符串	必须			画布尺寸
bookID	字符串	可选			布局ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
bookInfo	字符串	必须
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须
categoryIds	字符串	必须
pageIds	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
ids	字符串	必须			待删除的文件ID
file_group_id	字符串	可选			待删除的分组ID
brand_id	字符串	必须			品牌ID
other_uuid	字符串	必须			用户身份

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
template_id	字符串	必须
pageIds	字符串	必须
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
contact_name	字符串	可选			客户名称
contact_phone	字符串	可选			客户联系电话
contact_message	字符串	可选			客户留言内容
contact_status	字符串	可选	0		处理状态，0新联系，1已回复
contact_email	字符串	可选			客户的邮箱
role_id	整型	必须	1		角色ID
other_uuid	字符串	必须			用户的uuid

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book标识
navbarConfigJson	字符串	可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识
components	字符串	可选			组件数组

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须
group_id	字符串	必须
shop_id	字符串	可选
brand_id	字符串	必须
switch_json	字符串	必须			map to jsonString

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须
group_id	字符串	必须
brand_id	字符串	必须
config_json	字符串	必须
saas_type	整型	必须			saas 服务商标识

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须			集团ID
brand_name	字符串	可选			品牌名称
brand_logo	字符串	可选			品牌LOGO
other_uuid	字符串	必须			用户身份
brand_id	字符串	必须			品牌ID
region	字符串	可选			区域名称
brand_des	字符串	可选			品牌描述

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识
components	字符串	可选			组件数组
cover_mark	整型	可选	0		标记

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须			集团ID
shop_id	字符串	必须			店铺ID
other_uuid	字符串	必须			用户身份标识
brand_id	字符串	可选			品牌ID
user_disable	整型	可选	0		是否禁用 （软删除）

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	可选			集团ID
group_name	字符串	可选			集团名称
corporate_name	字符串	可选			公司名称
saas_server	字符串	必须			saas服务商

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
not_check_brand	布尔型	可选	false		是否校验品牌，创建品牌的时候传不校验
other_uuid	字符串	必须
group_id	字符串	必须
brand_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_Id	字符串	必须			待删除的book 标识

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.deleted_rows	整型	返回更新的条数，0表示没有无删除，正数表示删除的条数，false表示删除失败
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
category_id	字符串	必须			待删除的分类 ID|索引添加失败
book_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			待删除的book 标识
brand_id	字符串	必须			店铺ID
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.deleted_rows	整型	返回更新的条数，0表示没有无删除，正数表示删除的条数，false表示删除失败
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			待删除的book 标识
template_id	字符串	必须			待删除的模版ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			待删除的book 标识
div_id	字符串	必须			待删除的自定义组件ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须			待删除的集团ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
category_id	字符串	必须			待删除的分类ID
book_id	字符串	必须			待删除的book 标识
page_id	字符串	必须			待删除的页码标识|索引添加失败

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.deleted_rows	整型	返回更新的条数，0表示没有无删除，正数表示删除的条数，false表示删除失败
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
template_id	字符串	可选
screenSize	字符串	可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
parentTemplateId	字符串	必须			从这个模版中克隆
other_uuid	字符串	必须
adapterScreenSizes	字符串	必须			要适配的尺寸,字符串逗号隔开

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
template_id	字符串	必须
cmd	整型	必须
other_uuid	字符串	必须
other_ screen_sizes	字符串	可选
snapshot_url	字符串	可选			模版封面，当cmd == 100 的时候生效

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
template_id	字符串	必须			模版ID
page_id	字符串	必须			模版页面ID
name	字符串	可选	默认页面		名称
pageSnapshot	字符串	可选			页面截图
patternStyle	整型	可选	0		页面布局风格
components	字符串	可选			组件数组
bgImageUrl	字符串	可选
index	字符串	可选
other_uuid	字符串	必须			用户身份

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
associationShops	字符串	可选			关联的店铺ID
bookName	字符串	必须			book名称
screenSize	字符串	必须	1920X1080		屏幕尺寸
iconUrl	字符串	可选			book图标
launchImageUrl	字符串	可选			app启动图
brand_id	字符串	必须			品牌ID
other_uuid	字符串	必须			用户身份
book_id	字符串	可选			bookID
app_type	整型	可选	0		应用类型
style	整型	可选			模版风格
template_id	字符串	可选			模版ID
templateConfigJson	字符串	可选			通过模版自动创建分类

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
group_id	字符串	必须
other_uuid	字符串	必须		最大：10000
brand_id	字符串	必须			appKey

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			app导航配置表数据ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.item	对象	成功时返回数据详情，失败时返回null
data.item.book_id	字符串	book标识
data.item.nav_bar_background_image_url	字符串	导航背景图片
data.item.nav_bar_background_color	字符串	导航背景色
data.item.separator_color	字符串	分割线颜色
data.item.indicator_color	字符串	指示器颜色
data.item.run_spacing	整型	分类间的间距
data.item.item_height	整型	按钮的高度
data.item.content_margin	整型	边距
data.item.radius	整型	nav边框圆角
data.item.item_radius	字符串	子项按钮边框圆角
data.item.unselected_label_color	字符串	子项未选中文字颜色
data.item.label_color	字符串	子项文本选中颜色
data.item.unselected_item_background_color	字符串	子项未选中背景颜色
data.item.item_background_color	字符串	子项选中背景颜色
data.item.unselected_item_background_image	字符串	子项未选中背景图片
data.item.item_background_image	字符串	子项选中背景图片
data.item.lable_font_size	整型	文字大小
data.item.font_family	字符串	字体名称
data.item.unselected_labe_font_size	整型	未选中子项字体大小
data.item.font_weight	字符串	fontWeight
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			app框架表数据ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.item	对象	成功时返回数据详情，失败时返回null
data.item.book_id	字符串	book标识
data.item.components	字符串	组件数组
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
brand_id	字符串	必须			品牌ID
other_uuid	字符串	必须			用户身份
screenSize	字符串	可选			屏幕尺寸
client	整型	可选	0		是否来自客户的
app_type	整型	可选	0		app 类型。电子菜单、 广告机、大屏点餐、电视广告

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
id	整型	可选			友情链接表数据ID
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：10000	分页数量
url	字符串	可选			url链接
target	字符串	可选	0		跳转方式，0_blank，1_self，2_parent，3_top，4framename
group_id	字符串	可选	0		分组ID
listorder	字符串	可选	50		排序
friend_name	字符串	可选			名称

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items	字符串	数据列表，失败时返回空数组
data.total	整型	总数
data.items[].url	字符串	url链接
data.items[].target	字符串	跳转方式，0_blank，1_self，2_parent，3_top，4framename
data.items[].group_id	字符串	分组ID
data.items[].listorder	字符串	排序
data.items[].friend_name	字符串	名称
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
id	整型	可选			合作方数据ID
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：10000	分页数量
coorperators_name	字符串	可选			名称
image	字符串	可选			图像
link	字符串	可选			链接
created_at	字符串	可选			created_at
updated_at	字符串	可选			updated_at
deleted_at	字符串	可选			deleted_at

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items	字符串	数据列表，失败时返回空数组
data.total	整型	总数
data.items[].coorperators_name	字符串	名称
data.items[].image	字符串	图像
data.items[].link	字符串	链接
data.items[].created_at	字符串	created_at
data.items[].updated_at	字符串	updated_at
data.items[].deleted_at	字符串	deleted_at
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
brand_id	字符串	可选
other_uuid	字符串	必须
group_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			封面管理表数据ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.item	对象	成功时返回数据详情，失败时返回null
data.item.book_id	字符串	book标识
data.item.components	字符串	组件数组
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须
device_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
app_type	整型	必须	0		应用类型，电子菜单传0
orientation	整型	必须	0		0 横向，1 纵向

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.item	对象	成功时返回数据详情，失败时返回null
data.item.app_type	整型	应用类型
data.item.landscape_fashion_size	字符串	流行的画布尺寸
data.item.portrait_fashion_size	字符串	竖屏流行的尺寸
data.item.h_canvas_sizes	字符串	横屏画的布尺寸列表
data.item.v_canvas_sizes	字符串	竖屏的画布尺寸列表
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
admin_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items	字符串	数据列表，失败时返回空数组
data.total	整型	总数
data.items[].pname	字符串	姓名
data.items[].phone	字符串	电话号码
data.items[].state	整型	状态
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份
brand_id	字符串	必须			品牌ID
screenSize	字符串	必须			当前画布尺寸
template_id	字符串	必须			模版ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items	字符串	数据列表，失败时返回空数组
data.total	整型	总数
data.items[].contact_name	字符串	客户名称
data.items[].contact_phone	字符串	客户联系电话
data.items[].contact_message	字符串	客户留言内容
data.items[].contact_status	字符串	处理状态，0新联系，1已回复
data.items[].contact_email	字符串	客户的邮箱
data.items[].role	字符串	用户角色
data.items[].role_id	整型	角色ID
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
id	整型	必须	1		站点表数据ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.item	对象	成功时返回数据详情，失败时返回null
data.item.logo	字符串	LOGO
data.item.domain	字符串	站点绑定域名
data.item.sort	字符串	排序越小越靠前
data.item.title	字符串	站点标题
data.item.keywords	字符串	站点关键词
data.item.description	字符串	站点描述
data.item.theme	字符串	模板名称
data.item.copyright	字符串	版权信息
data.item.icp	字符串	ICP备案号
data.item.create_at	字符串	创建时间
data.item.update_at	字符串	更新时间
data.item.user_count	字符串	用户数量
data.item.page_count	字符串	页码数量
data.item.book_count	字符串	菜单数量
data.item.banner_img_url	字符串	网站header图
data.item.img01	字符串	展位01
data.item.img02	字符串	展位
data.item.video_url	字符串	视频地址
data.item.legal_declaration	字符串	法律声明
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			book 标识

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
file_group_id	字符串	可选			文件分组 ID
other_uuid	字符串	必须			用户身份ID
brand_id	字符串	必须			品牌ID
book_id	字符串	必须			哪本菜单的数据

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items	字符串	数据列表，失败时返回空数组
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须			要分享的菜单ID
to_shop_id	字符串	必须			目标店铺的ID
other_uuid	字符串	必须			用户身份标识

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
other_uuid	字符串	必须			用户身份
book_id	字符串	必须			菜单 ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
emp_lst	字符串JSON格式	必须			[{"empName":"aa","nickName":"naaa"},{"empName":"bb","nickName":"nbbb"}]
brand_id	字符串	必须
other_uuid	字符串	必须
group_id	字符串	必须			集团ID
region	字符串	可选			区域
saas_type	整型	必须			0、哗啦啦、1 天才、2、待续

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

---

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中： 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。 使用静态签名，点击获取我的静态签名 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。 定制签名支持专属签名算法定制开发
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
book_id	字符串	必须
association_shops	字符串	必须
other_uuid	字符串	必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单