• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 数据统计模块 剩余流量
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 配置模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • API开发
    • 接口源码库 推荐
    • 接口DIY (低代码开发)
  • 登录
  • 注册



YesApi 接口文档

CreateTemporaryUrl 分享二维码用来检测超时时间的 v1.8

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateTemporaryUrl

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateTemporaryUrl

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
shopId字符串必须
menuId字符串可选
screenSize字符串可选
expireHours字符串可选
baseUrl字符串可选
userUuid字符串可选
userToken字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 CreateTemporaryUrl 分享二维码用来检测超时时间的 v1.8】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateTemporaryUrl`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateTemporaryUrl` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| shopId | string | 必填 |  |
| menuId | string | 可选 |  |
| screenSize | string | 可选 |  |
| expireHours | string | 可选 |  |
| baseUrl | string | 可选 |  |
| userUuid | string | 可选 |  |
| userToken | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateTemporaryUrl&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

Resto Open Api v1.27

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ARestoOpenAPI

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ARestoOpenAPI

接口描述: Resto Open Api v1.27

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
path字符串必须/api/v1/bo/shop/queryShopList
jsonString字符串可选{"corporationId":530028100}
group_id字符串可选懂菜谱集团ID
brand_id字符串可选懂菜谱品牌ID
other_uuid字符串可选用户身份ID
area字符串可选区域编码。CN,SEA,US,EU,UAT
openapi_appKey字符串可选
openapi_appSecret字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 Resto Open Api v1.27】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARestoOpenAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   Resto Open Api v1.27
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ARestoOpenAPI` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| path | string | 必填 | /api/v1/bo/shop/queryShopList |
| jsonString | string | 可选 | {"corporationId":530028100} |
| group_id | string | 可选 | 懂菜谱集团ID |
| brand_id | string | 可选 | 懂菜谱品牌ID |
| other_uuid | string | 可选 | 用户身份ID |
| area | string | 可选 | 区域编码。CN,SEA,US,EU,UAT |
| openapi_appKey | string | 可选 |  |
| openapi_appSecret | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARestoOpenAPI&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

VerifyTemporaryUrl 验证临时QR的时效 v1.6

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AVerifyTemporaryUrl

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AVerifyTemporaryUrl

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
tempId字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 VerifyTemporaryUrl 验证临时QR的时效 v1.6】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AVerifyTemporaryUrl`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AVerifyTemporaryUrl` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| tempId | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AVerifyTemporaryUrl&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

halal open api v1.16

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AHualalaOpenAPI

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AHualalaOpenAPI

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
jsonString字符串必须集团ID和店铺ID
path字符串必须open_api 路径: doc
openapi_appKey字符串可选
openapi_appSecret字符串可选
group_id字符串必须
brand_id字符串必须
other_uuid字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 halal open api v1.16】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AHualalaOpenAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AHualalaOpenAPI` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| jsonString | string | 必填 | 集团ID和店铺ID |
| path | string | 必填 | open_api 路径: doc  |
| openapi_appKey | string | 可选 |  |
| openapi_appSecret | string | 可选 |  |
| group_id | string | 必填 |  |
| brand_id | string | 必填 |  |
| other_uuid | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AHualalaOpenAPI&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

test v1.4

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AFindTest

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AFindTest

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 test v1.4】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AFindTest`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AFindTest` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| book_id | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AFindTest&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

七牛获取token v1.11

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AQniuGetToken

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AQniuGetToken

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
insert_only整型可选1
key_prefix字符串可选
key字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 七牛获取token v1.11】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AQniuGetToken`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AQniuGetToken` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| insert_only | int | 可选 |  |
| key_prefix | string | 可选 |  |
| key | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AQniuGetToken&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

七牛资源上报 v1.4

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AAReportQiniuUpload

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AAReportQiniuUpload

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
file_type字符串可选文件类型
file_group_id整型必须文件分组ID 1、App素材 2、菜单菜品素材 3、饰品 4、组件快照 5、模板快照 6、页面快照
brand_id字符串必须品牌ID
other_uuid字符串必须用户身份标识
files字符串JSON格式可选
book_id字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 七牛资源上报 v1.4】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAReportQiniuUpload`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AAReportQiniuUpload` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| file_type | string | 可选 | 文件类型 |
| file_group_id | int | 必填 | 文件分组ID
 1、App素材
 2、菜单菜品素材
 3、饰品
 4、组件快照
 5、模板快照
 6、页面快照  |
| brand_id | string | 必填 | 品牌ID |
| other_uuid | string | 必填 | 用户身份标识 |
| files | array | 可选 |  |
| book_id | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAReportQiniuUpload&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

上报CRM菜单记录 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AUploadFoodFile

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AUploadFoodFile

接口描述: 上报自由的菜单记录(ArtMenu Food CRM)

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须
brand_id字符串必须
shop_id字符串可选
file_name字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 上报CRM菜单记录 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUploadFoodFile`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   上报自由的菜单记录(ArtMenu Food CRM)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AUploadFoodFile` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 |  |
| brand_id | string | 必填 |  |
| shop_id | string | 可选 |  |
| file_name | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUploadFoodFile&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

上报七牛云上传结果并创建版本记录 v1.4

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AReportUpload

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AReportUpload

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
key字符串可选
hash字符串可选
fsize整型可选
version_name字符串可选
version_code整型可选
package_name字符串可选
platform字符串可选
release_notes字符串可选
force_update字符串可选
min_version_code字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 上报七牛云上传结果并创建版本记录 v1.4】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AReportUpload`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AReportUpload` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 可选 |  |
| hash | string | 可选 |  |
| fsize | int | 可选 |  |
| version_name | string | 可选 |  |
| version_code | int | 可选 |  |
| package_name | string | 可选 |  |
| platform | string | 可选 |  |
| release_notes | string | 可选 |  |
| force_update | string | 可选 |  |
| min_version_code | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AReportUpload&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

上报日志元数据 v1.9

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AReportLogUpload

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AReportLogUpload

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
shop_id字符串可选
shop_name字符串可选
user_id字符串可选
user_name字符串可选
file_url字符串可选
file_size整型可选
file_name字符串可选
log_start_date字符串可选
log_end_date字符串可选
log_count整型可选
error_count整型可选
warning_count整型可选
info_count整型可选
app_name字符串可选
app_version字符串可选
platform字符串可选
device_model字符串可选
upload_time字符串可选
remark字符串可选
storage_type字符串可选
storage_bucket字符串可选
storage_region字符串可选
device_id字符串可选
device_full_info字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 上报日志元数据 v1.9】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AReportLogUpload`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AReportLogUpload` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| shop_id | string | 可选 |  |
| shop_name | string | 可选 |  |
| user_id | string | 可选 |  |
| user_name | string | 可选 |  |
| file_url | string | 可选 |  |
| file_size | int | 可选 |  |
| file_name | string | 可选 |  |
| log_start_date | string | 可选 |  |
| log_end_date | string | 可选 |  |
| log_count | int | 可选 |  |
| error_count | int | 可选 |  |
| warning_count | int | 可选 |  |
| info_count | int | 可选 |  |
| app_name | string | 可选 |  |
| app_version | string | 可选 |  |
| platform | string | 可选 |  |
| device_model | string | 可选 |  |
| upload_time | string | 可选 |  |
| remark | string | 可选 |  |
| storage_type | string | 可选 |  |
| storage_bucket | string | 可选 |  |
| storage_region | string | 可选 |  |
| device_id | string | 可选 |  |
| device_full_info | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AReportLogUpload&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建App表 v1.14

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateApp

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateApp

接口描述: 在品牌中创建APP

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
group_id字符串必须集团ID
app_name字符串必须app 名称
app_type字符串必须0app 类型。电子菜单、 广告机、大屏点餐、电视广告
brand_id字符串必须品牌ID
other_uuid字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建App表 v1.14】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateApp`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   在品牌中创建APP
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateApp` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| group_id | string | 必填 | 集团ID |
| app_name | string | 必填 | app 名称 |
| app_type | string | 必填 | app 类型。电子菜单、 广告机、大屏点餐、电视广告 |
| brand_id | string | 必填 | 品牌ID |
| other_uuid | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.int | string | 新增数据的ID|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateApp&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建book 配置项 v1.54

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateBookconfig

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateBookconfig

接口描述: 创建book 配置项新数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串必须book 标识
bookConfigJson字符串可选{}json
template_id字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建book 配置项 v1.54】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateBookconfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建book 配置项新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateBookconfig` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| book_id | string | 必填 | book 标识 |
| bookConfigJson | string | 可选 | json |
| template_id | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateBookconfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建代理 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateAgent

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateAgent

接口描述: 请在这 \n 创建代理 \n @desc 创建一个新的代理 \n \n 接口名称: SVIP.Ssongjie_MyApi.ACreateAgent \n \n 请求参数: \n - agent_name: 代理名称(必填) \n - agent_id: 代理业务ID(可选) \n - region_code: 区域代码(可选) \n - region_name: 区域名称(可选) \n - parent_region: 上级区域(可选) \n - contact_name: 联系人姓名(可选) \n - contact_phone: 联系电话(可选) \n - contact_email: 联系邮箱(可选) \n - contact_address: 联系地址(可选) \n - other_uuid: 关联的用户UUID(可选) \n - remark: 备注(可选) \n \n 返回数据: \n { \n "err_code": 0, \n "err_msg": "创建成功", \n "uuid": "生成的UUID", \n "agent_name": "代理名称" \n } \n 里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
agent_name字符串可选
region_code字符串可选
region_name字符串可选
parent_region字符串可选
contact_name字符串可选
contact_email字符串可选
contact_phone字符串可选
contact_address字符串可选
other_uuid字符串可选
remark字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建代理 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateAgent`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这
\n  创建代理
\n  @desc 创建一个新的代理
\n  
\n  接口名称: SVIP.Ssongjie_MyApi.ACreateAgent
\n  
\n  请求参数:
\n  - agent_name: 代理名称(必填)
\n  - agent_id: 代理业务ID(可选)
\n  - region_code: 区域代码(可选)
\n  - region_name: 区域名称(可选)
\n  - parent_region: 上级区域(可选)
\n  - contact_name: 联系人姓名(可选)
\n  - contact_phone: 联系电话(可选)
\n  - contact_email: 联系邮箱(可选)
\n  - contact_address: 联系地址(可选)
\n  - other_uuid: 关联的用户UUID(可选)
\n  - remark: 备注(可选)
\n  
\n  返回数据:
\n  {
\n    "err_code": 0,
\n    "err_msg": "创建成功",
\n    "uuid": "生成的UUID",
\n    "agent_name": "代理名称"
\n  }
\n 里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateAgent` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| agent_name | string | 可选 |  |
| region_code | string | 可选 |  |
| region_name | string | 可选 |  |
| parent_region | string | 可选 |  |
| contact_name | string | 可选 |  |
| contact_email | string | 可选 |  |
| contact_phone | string | 可选 |  |
| contact_address | string | 可选 |  |
| other_uuid | string | 可选 |  |
| remark | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateAgent&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建分类信息表 v1.35

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateCategoryinfo

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateCategoryinfo

接口描述: 创建分类信息表新数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串必须book 标识
categoryIndex整型必须0分类顺序
categoryName字符串必须默认分类0分类名字
category_id字符串可选分类ID

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建分类信息表 v1.35】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateCategoryinfo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建分类信息表新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateCategoryinfo` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| book_id | string | 必填 | book 标识 |
| categoryIndex | int | 必填 | 分类顺序 |
| categoryName | string | 必填 | 分类名字 |
| category_id | string | 可选 | 分类ID |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateCategoryinfo&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建品牌表 v1.35

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateBrandinfo

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateBrandinfo

接口描述: 创建品牌表新数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
group_id字符串必须集团ID
group_name字符串可选集团名称
brand_id字符串可选品牌ID
brand_name字符串可选品牌名称
brand_logo字符串可选品牌LOGO
other_uuid字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建品牌表 v1.35】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateBrandinfo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建品牌表新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateBrandinfo` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| group_id | string | 必填 | 集团ID |
| group_name | string | 可选 | 集团名称 |
| brand_id | string | 可选 | 品牌ID |
| brand_name | string | 可选 | 品牌名称 |
| brand_logo | string | 可选 | 品牌LOGO |
| other_uuid | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.int | string | 新增数据的ID|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateBrandinfo&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建广告模版 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateAdvertisementTemplate

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateAdvertisementTemplate

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须用户UUID
brand_id字符串必须品牌ID(必须是 '88888888')
templateName字符串必须模版名称
screenSize字符串必须画布尺寸(格式:宽度X高度)
app_type整型必须1应用类型(固定为 1,表示广告机)

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建广告模版 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateAdvertisementTemplate`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateAdvertisementTemplate` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 | 用户UUID |
| brand_id | string | 必填 | 品牌ID(必须是 '88888888')	 |
| templateName | string | 必填 | 模版名称 |
| screenSize | string | 必填 | 画布尺寸(格式:宽度X高度) |
| app_type | int | 必填 | 应用类型(固定为 1,表示广告机)	
  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateAdvertisementTemplate&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建新版本(管理后台) v1.2

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateVersion

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateVersion

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
version_name字符串可选
version_code整型可选
package_name字符串可选
channel字符串可选
platform字符串可选
download_url字符串可选
file_size整型可选
md5字符串可选
release_notes字符串可选
force_update整型可选
min_version_code整型可选
enable_gray_release字符串可选
storage_type字符串可选
version_status字符串可选
release_time字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建新版本(管理后台) v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateVersion`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateVersion` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| version_name | string | 可选 |  |
| version_code | int | 可选 |  |
| package_name | string | 可选 |  |
| channel | string | 可选 |  |
| platform | string | 可选 |  |
| download_url | string | 可选 |  |
| file_size | int | 可选 |  |
| md5 | string | 可选 |  |
| release_notes | string | 可选 |  |
| force_update | int | 可选 |  |
| min_version_code | int | 可选 |  |
| enable_gray_release | string | 可选 |  |
| storage_type | string | 可选 |  |
| version_status | string | 可选 |  |
| release_time | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateVersion&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建自定义组件 v1.18

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateDivinfo

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateDivinfo

接口描述: 创建自定义组件新数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
divName字符串必须自定义组件名字
screenHotUrl字符串可选组件快照
components字符串可选组件数组
div_id字符串必须自定义组件ID
book_id字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建自定义组件 v1.18】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateDivinfo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建自定义组件新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateDivinfo` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| divName | string | 必填 | 自定义组件名字 |
| screenHotUrl | string | 可选 | 组件快照 |
| components | string | 可选 | 组件数组 |
| div_id | string | 必填 | 自定义组件ID |
| book_id | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateDivinfo&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建资源素材 v1.100

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AUploadImage

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AUploadImage

接口描述: 创建资源素材新数据,创建除快照类型的图片

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
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 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建资源素材 v1.100】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUploadImage`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建资源素材新数据,创建除快照类型的图片
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AUploadImage` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| file_type | string | 可选 | 文件类型 |
| file_group_id | int | 必填 | 文件分组ID
 1、App素材
 2、菜单菜品素材
 3、饰品
 4、组件快照
 5、模板快照
 6、页面快照  |
| brand_id | string | 必填 | 品牌ID |
| file | string | 必填 | 要上传的文件,行base64编码后传递,对待上传文件二进制内容进行basse64编码后的数据 |
| file_name | string | 必填 |  |
| other_uuid | string | 必填 | 用户身份标识 |
| snapshot_id | string | 可选 | 快照ID |
| book_id | string | 可选 | 上传page快照的时候必须传 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUploadImage&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建集团 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateGroup

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateGroup

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
group_name字符串可选
corporate_name字符串可选
other_uuid字符串可选
user_disable字符串可选
add_time字符串可选
update_time字符串可选
saas_server字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建集团 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateGroup`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateGroup` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| group_name | string | 可选 |  |
| corporate_name | string | 可选 |  |
| other_uuid | string | 可选 |  |
| user_disable | string | 可选 |  |
| add_time | string | 可选 |  |
| update_time | string | 可选 |  |
| saas_server | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateGroup&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建非重复数据意向用户 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AFreeUpdateIntendedUsers

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AFreeUpdateIntendedUsers

接口描述: 创建非重复意向用户数据,数据存在时则更新否则新增数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
pname字符串必须数据 姓名
phone字符串必须数据 电话号码

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建非重复数据意向用户 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AFreeUpdateIntendedUsers`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建非重复意向用户数据,数据存在时则更新否则新增数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AFreeUpdateIntendedUsers` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| pname | string | 必填 | 数据 姓名 |
| phone | string | 必填 | 数据 电话号码 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 0表示更新新增成功|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AFreeUpdateIntendedUsers&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

创建页码信息表 v1.16

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreatePageinfo

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreatePageinfo

接口描述: 创建页码信息表新数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
category_id字符串必须分类ID
book_id字符串必须book 标识
title字符串可选pageName
pageIndex字符串可选页面顺序
bgImageUrl字符串可选page的背景图
components字符串可选组件数组
page_id字符串必须页码标识|索引添加失败
pageSnapshot字符串可选页码快照图片地址

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 创建页码信息表 v1.16】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreatePageinfo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建页码信息表新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreatePageinfo` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| category_id | string | 必填 | 分类ID |
| book_id | string | 必填 | book 标识 |
| title | string | 可选 | pageName |
| pageIndex | string | 可选 | 页面顺序 |
| bgImageUrl | string | 可选 | page的背景图 |
| components | string | 可选 | 组件数组 |
| page_id | string | 必填 | 页码标识|索引添加失败 |
| pageSnapshot | string | 可选 | 页码快照图片地址 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreatePageinfo&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除七牛云文件 v1.3

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteQiniuFile

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteQiniuFile

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
key字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除七牛云文件 v1.3】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteQiniuFile`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteQiniuFile` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteQiniuFile&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除代理 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteAgent

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteAgent

接口描述: 删除代理

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
id字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除代理 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteAgent`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   删除代理
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteAgent` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteAgent&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除品牌表 v1.13

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteBrandinfo

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteBrandinfo

接口描述: 根据ID,删除品牌表数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
brand_id字符串必须待删除的ID
other_uuid字符串必须
group_id字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除品牌表 v1.13】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteBrandinfo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据ID,删除品牌表数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteBrandinfo` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| brand_id | string | 必填 | 待删除的ID |
| other_uuid | string | 必填 |  |
| group_id | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteBrandinfo&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除店铺 v1.11

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AAdminDeleteStore

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AAdminDeleteStore

接口描述: 删除店铺

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
userName字符串必须
shopID字符串必须
admin_uuid字符串必须
admin_token字符串必须
roleId字符串可选1 是集团, 2 是店铺 。空是散户
other_uuid字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除店铺 v1.11】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminDeleteStore`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   删除店铺
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AAdminDeleteStore` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| userName | string | 必填 |  |
| shopID | string | 必填 |  |
| admin_uuid | string | 必填 |  |
| admin_token | string | 必填 |  |
| roleId | string | 可选 | 1 是集团, 2 是店铺 。空是散户 |
| other_uuid | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminDeleteStore&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除快照 v1.23

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteSnapshot

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteSnapshot

接口描述: 根据url删除图片

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
file_url字符串可选待删除的文件地址
other_uuid字符串必须用户身份ID
brand_id字符串必须品牌ID
file_id字符串可选图片ID
my_sdk布尔型可选false是否使用自己的七牛sdk
file_key字符串可选是否使用自己的七牛sdk必传

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除快照 v1.23】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteSnapshot`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据url删除图片
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteSnapshot` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| file_url | string | 可选 | 待删除的文件地址 |
| other_uuid | string | 必填 | 用户身份ID |
| brand_id | string | 必填 | 品牌ID |
| file_id | string | 可选 | 图片ID |
| my_sdk | boolean | 可选 | 是否使用自己的七牛sdk |
| file_key | string | 可选 | 是否使用自己的七牛sdk必传 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteSnapshot&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除无用的截图资源 v1.11

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteUselessResourceImages

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteUselessResourceImages

接口描述: 制作菜单的时候有可能会生成很多截图快照,保留真实删除无用

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除无用的截图资源 v1.11】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteUselessResourceImages`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   制作菜单的时候有可能会生成很多截图快照,保留真实删除无用
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteUselessResourceImages` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteUselessResourceImages&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除日志记录(物理删除) v1.0

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteLog

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteLog

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
id字符串可选
delete_file字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除日志记录(物理删除) v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteLog`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteLog` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | string | 可选 |  |
| delete_file | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteLog&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除灰度发布目标(管理后台) v1.0

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteGrayReleaseTarget

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteGrayReleaseTarget

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除灰度发布目标(管理后台) v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteGrayReleaseTarget`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteGrayReleaseTarget` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteGrayReleaseTarget&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

删除版本(管理后台) v1.2

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ADeleteVersion

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ADeleteVersion

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
id整型可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 删除版本(管理后台) v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteVersion`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ADeleteVersion` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | int | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ADeleteVersion&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

处理会员请求 v1.51

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AHandleUserChange

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AHandleUserChange

接口描述: 1、会员身份变更、2、删除记录、3、邮件通知

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须
role_id整型必须0
admin_uuid字符串必须
admin_token字符串可选
expiration_time字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 处理会员请求 v1.51】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AHandleUserChange`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   1、会员身份变更、2、删除记录、3、邮件通知
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AHandleUserChange` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 |  |
| role_id | int | 必填 |  |
| admin_uuid | string | 必填 |  |
| admin_token | string | 可选 |  |
| expiration_time | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AHandleUserChange&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

天财商龙 open api v1.13

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ASLOpenAPI

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ASLOpenAPI

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
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 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 天财商龙 open api v1.13】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ASLOpenAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ASLOpenAPI` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| group_id | string | 可选 | 懂菜谱集团ID |
| brand_id | string | 可选 | 懂菜谱品牌ID |
| other_uuid | string | 可选 | 用户身份ID |
| path | string | 可选 | /datatransfer/getitems,/datatransfer/getshops,/datatransfer/getitemcategoryinfo |
| openapi_appKey | string | 可选 | 商龙openAPI-appid |
| openapi_appSecret | string | 可选 | 商龙openAPI-accessid |
| jsonString | string | 可选 | 集团ID和店铺ID{"centerId":"201723","shopId":""} |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ASLOpenAPI&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

客户更具画布尺寸获取可用的模版 v1.5

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AGetTemplateList

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AGetTemplateList

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须用户身份
screenSize字符串必须画布尺寸
brand_id字符串必须品牌ID
client字符串可选是否来自客户的
app_type字符串必须app 类型。电子菜单、 广告机、大屏点餐、电视广告
deviceOrientation字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 客户更具画布尺寸获取可用的模版 v1.5】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetTemplateList`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AGetTemplateList` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 | 用户身份 |
| screenSize | string | 必填 | 画布尺寸 |
| brand_id | string | 必填 | 品牌ID |
| client | string | 可选 | 是否来自客户的 |
| app_type | string | 必填 | app 类型。电子菜单、 广告机、大屏点餐、电视广告 |
| deviceOrientation | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetTemplateList&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

客户端APP布局版本检查 v1.8

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AMyScaffoldCheckUpdate

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AMyScaffoldCheckUpdate

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须
bookID字符串必须
cachedVersion字符串必须
cachedShopConfigVersion字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 客户端APP布局版本检查 v1.8】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AMyScaffoldCheckUpdate`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AMyScaffoldCheckUpdate` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 |  |
| bookID | string | 必填 |  |
| cachedVersion | string | 必填 |  |
| cachedShopConfigVersion | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AMyScaffoldCheckUpdate&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

客户端上报 v1.4

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AClientReport

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AClientReport

接口描述: 信息报,用户统计

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须用户身份
device_id字符串必须设备ID
canvas_size字符串必须画布尺寸
device_info字符串必须设备信息

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 客户端上报 v1.4】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AClientReport`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   信息报,用户统计
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AClientReport` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 | 用户身份 |
| device_id | string | 必填 | 设备ID |
| canvas_size | string | 必填 | 画布尺寸 |
| device_info | string | 必填 | 设备信息 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AClientReport&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

客户端获取App布局脚手架 v1.26

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AScaffold

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AScaffold

接口描述: 客户端获取脚手架,内容包括:店铺配置信息、封面布局、master布局、导航配置

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须用户身份
screenSize字符串必须画布尺寸
bookID字符串可选布局ID

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 客户端获取App布局脚手架 v1.26】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AScaffold`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   客户端获取脚手架,内容包括:店铺配置信息、封面布局、master布局、导航配置
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AScaffold` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 | 用户身份 |
| screenSize | string | 必填 | 画布尺寸 |
| bookID | string | 可选 | 布局ID |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AScaffold&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

将已撤销的授权码恢复为未使用状态 v1.0

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ARestoreLicenseCode

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ARestoreLicenseCode

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
code_id字符串可选
reason字符串可选
operator_id字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 将已撤销的授权码恢复为未使用状态 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARestoreLicenseCode`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ARestoreLicenseCode` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| code_id | string | 可选 |  |
| reason | string | 可选 |  |
| operator_id | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARestoreLicenseCode&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

快速复制一个菜单 v1.32

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACopyBook

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACopyBook

接口描述: 快速从一个菜单复制一个出来

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
bookInfo字符串必须
other_uuid字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 快速复制一个菜单 v1.32】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACopyBook`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   快速从一个菜单复制一个出来
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACopyBook` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| bookInfo | string | 必填 |  |
| other_uuid | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACopyBook&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量删除分类和页码 v1.36

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ABatchDeleteCP

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ABatchDeleteCP

接口描述: 保存数据,把已经删除的分类和页码批量删除

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串必须
categoryIds字符串必须
pageIds字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量删除分类和页码 v1.36】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleteCP`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   保存数据,把已经删除的分类和页码批量删除
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ABatchDeleteCP` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| book_id | string | 必填 |  |
| categoryIds | string | 必填 |  |
| pageIds | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleteCP&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量删除图片 v1.14

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ABatchDeleateImgSource

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ABatchDeleateImgSource

接口描述: 要传图片id,多个图片用逗号分开

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
ids字符串必须待删除的文件ID
file_group_id字符串可选待删除的分组ID
brand_id字符串必须品牌ID
other_uuid字符串必须用户身份

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量删除图片 v1.14】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleateImgSource`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   要传图片id,多个图片用逗号分开
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ABatchDeleateImgSource` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| ids | string | 必填 | 待删除的文件ID |
| file_group_id | string | 可选 | 待删除的分组ID |
| brand_id | string | 必填 | 品牌ID |
| other_uuid | string | 必填 | 用户身份 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleateImgSource&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量删除模版页面 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ABatchDeleteTemplatePage

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ABatchDeleteTemplatePage

接口描述: 保存数据,把已经删除的模版页面删除

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
template_id字符串必须
pageIds字符串必须
other_uuid字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量删除模版页面 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleteTemplatePage`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   保存数据,把已经删除的模版页面删除
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ABatchDeleteTemplatePage` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| template_id | string | 必填 |  |
| pageIds | string | 必填 |  |
| other_uuid | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ABatchDeleteTemplatePage&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量生成授权码接口 v1.15

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AABatchCreateLicenseCodes

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AABatchCreateLicenseCodes

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
subject字符串必须
ttl字符串必须
count字符串必须
subject_id字符串必须
created_by字符串必须
created_ip字符串必须
subject_name字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量生成授权码接口 v1.15】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AABatchCreateLicenseCodes`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AABatchCreateLicenseCodes` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| subject | string | 必填 |  |
| ttl | string | 必填 |  |
| count | string | 必填 |  |
| subject_id | string | 必填 |  |
| created_by | string | 必填 |  |
| created_ip | string | 必填 |  |
| subject_name | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AABatchCreateLicenseCodes&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量获取品牌信息 v1.7

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AGetBrandInfoBatch

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AGetBrandInfoBatch

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
brand_ids字符串可选
page字符串可选
perpage字符串可选
other_uuid字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量获取品牌信息 v1.7】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetBrandInfoBatch`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AGetBrandInfoBatch` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| brand_ids | string | 可选 |  |
| page | string | 可选 |  |
| perpage | string | 可选 |  |
| other_uuid | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetBrandInfoBatch&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

批量获取店铺信息 v1.0

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AGetShopInfoBatch

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AGetShopInfoBatch

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
shop_ids字符串可选
page字符串可选
perpage字符串可选
other_uuid字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 批量获取店铺信息 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetShopInfoBatch`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AGetShopInfoBatch` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| shop_ids | string | 可选 |  |
| page | string | 可选 |  |
| perpage | string | 可选 |  |
| other_uuid | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AGetShopInfoBatch&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

授权码激活 v1.12

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AAdminUseLicenseCode

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AAdminUseLicenseCode

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
code字符串可选
target_id字符串可选
operator_id字符串可选
remark字符串可选
target_type字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 授权码激活 v1.12】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminUseLicenseCode`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AAdminUseLicenseCode` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| code | string | 可选 |  |
| target_id | string | 可选 |  |
| operator_id | string | 可选 |  |
| remark | string | 可选 |  |
| target_type | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminUseLicenseCode&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

提交角色变更接口 v1.17

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ACreateUserChange

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ACreateUserChange

接口描述: 新注册用户,普通会员申请成为集团用户,提交后有人员审核,审核通过走变更角色接口,邮箱通知

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
contact_name字符串可选客户名称
contact_phone字符串可选客户联系电话
contact_message字符串可选客户留言内容
contact_status字符串可选0处理状态,0新联系,1已回复
contact_email字符串可选客户的邮箱
role_id整型必须1角色ID
other_uuid字符串必须用户的uuid

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 提交角色变更接口 v1.17】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateUserChange`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   新注册用户,普通会员申请成为集团用户,提交后有人员审核,审核通过走变更角色接口,邮箱通知
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ACreateUserChange` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| contact_name | string | 可选 | 客户名称 |
| contact_phone | string | 可选 | 客户联系电话 |
| contact_message | string | 可选 | 客户留言内容 |
| contact_status | string | 可选 | 处理状态,0新联系,1已回复 |
| contact_email | string | 可选 | 客户的邮箱 |
| role_id | int | 必填 | 角色ID |
| other_uuid | string | 必填 | 用户的uuid |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ACreateUserChange&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

撤销单个授权码 v1.2

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/ARevokeLicenseCode

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.ARevokeLicenseCode

接口描述: 只能撤销未使用(issued)的授权码 \n已使用的授权码无法撤销(需要用取消授权接口) \n记录撤销原因

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
code_id字符串可选
reason字符串可选
operator_id字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 撤销单个授权码 v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARevokeLicenseCode`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   只能撤销未使用(issued)的授权码
\n已使用的授权码无法撤销(需要用取消授权接口)
\n记录撤销原因
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.ARevokeLicenseCode` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| code_id | string | 可选 |  |
| reason | string | 可选 |  |
| operator_id | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.ARevokeLicenseCode&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

撤销已激活的店铺授权,已使用的授权码状态不恢复 v1.1

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AAdminRevokeLicenseActivation

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AAdminRevokeLicenseActivation

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
shop_id字符串可选
remark字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 撤销已激活的店铺授权,已使用的授权码状态不恢复 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminRevokeLicenseActivation`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AAdminRevokeLicenseActivation` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| shop_id | string | 可选 |  |
| remark | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAdminRevokeLicenseActivation&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

新建接口 v1.0

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AAGetLicenseCodePlain

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AAGetLicenseCodePlain

接口描述: 请在这里填写接口的功能说明

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
code_id字符串必须

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 新建接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAGetLicenseCodePlain`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   请在这里填写接口的功能说明
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AAGetLicenseCodePlain` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| code_id | string | 必填 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AAGetLicenseCodePlain&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

更新app导航配置表 v1.6

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AUpdateAppNavBarConfig

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AUpdateAppNavBarConfig

接口描述: 更新app导航配置表数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串必须book标识
navbarConfigJson字符串可选

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 更新app导航配置表 v1.6】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUpdateAppNavBarConfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   更新app导航配置表数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AUpdateAppNavBarConfig` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| book_id | string | 必填 | book标识 |
| navbarConfigJson | string | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUpdateAppNavBarConfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
null

接口返回

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

YesApi 接口文档

更新app框架表 v1.8

接口路径(新):http://hn.api.yesapi.net/api/SVIP/SID82719_MyApi/AUpdateMaster

接口路径(旧):http://hn.api.yesapi.net/?s=SVIP.SID82719_MyApi.AUpdateMaster

接口描述: 更新app框架表数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. 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"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
book_id字符串必须book 标识
components字符串可选组件数组

客户端请求示例

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

AI提示词HTTP通用示例
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 更新app框架表 v1.8】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.SID82719_MyApi.AUpdateMaster`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   更新app框架表数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.SID82719_MyApi.AUpdateMaster` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         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,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|----