YesApi接口文档 | 果创云_数据库API_500+免费接口(原名:小白接口)

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Captcha/Create

接口路径(旧)：http://api.yesapi.net/?s=App.Captcha.Create

接口描述：生成一个新的验证码，可在小白开放平台进行相关参数配置。返回时可选择直接输出验证码图片，也可以选择返回数据。请注意，需要保管好captcha_id（直接输出图片时通过COOKIE返回），以便校验时核对。

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
return_format	枚举类型	可选	output	范围：output/data	验证码返回格式，output表示直接输出验证码图片，data表示返回base64后的验证码图片数据

客户端请求示例

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

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 101 创建新的验证码接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Captcha.Create`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  生成一个新的验证码，可在小白开放平台进行相关参数配置。返回时可选择直接输出验证码图片，也可以选择返回数据。请注意，需要保管好captcha_id（直接输出图片时通过COOKIE返回），以便校验时核对。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Captcha.Create` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| return_format | enum | 可选 | 验证码返回格式，output表示直接输出验证码图片，data表示返回base64后的验证码图片数据 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.captcha_id | string | 验证码唯一ID，用于校验时核对（return_format=data时返回此字段）|
| data.captcha_img | string | 验证码图片base64后的数据（return_format=data时返回此字段）|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Captcha.Create&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参数错误"
}
```

接口返回

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

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Captcha/Verify

接口路径(旧)：http://api.yesapi.net/?s=App.Captcha.Verify

接口描述：对用户输入的验证码进行核对，最多只能校验一次，失败后需要刷新验证码并重新验证

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
captcha_id	字符串	必须		最小：6	验证码唯一ID，通过App.Captcha.Create接口返回
captcha_code	字符串	必须		最小：2；最大：10	待校验的验证码

客户端请求示例

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

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 102 校对验证码接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Captcha.Verify`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  对用户输入的验证码进行核对，最多只能校验一次，失败后需要刷新验证码并重新验证
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Captcha.Verify` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| captcha_id | string | 必填 | 验证码唯一ID，通过App.Captcha.Create接口返回 |
| captcha_code | string | 必填 | 待校验的验证码 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示验证通过，1表示验证码已过期，或不存在，2表示验证码错误，需要刷新重试|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Captcha.Verify&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参数错误"
}
```

接口返回

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

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Captcha/Create4

接口路径(旧)：http://api.yesapi.net/?s=App.Captcha.Create4

接口描述：生成四位图片验证码，支持多种组合，例如：纯数字、纯字母或数字和字母的组合

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
cap_type	整型	可选	0		验证码的字符集类型，0纯数字，1纯小写字母，2纯大写字母，3数字+小写字母，4数字+大写字母，5大小写字母，6数字+大小写字母
cap_width	整型	可选	150		验证码图片宽度，单位：px
cap_height	整型	可选	40		验证码图片高度，单位：px

客户端请求示例

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

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 103 生成四位图片验证码接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Captcha.Create4`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  生成四位图片验证码，支持多种组合，例如：纯数字、纯字母或数字和字母的组合
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Captcha.Create4` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| cap_type | int | 可选 | 验证码的字符集类型，0纯数字，1纯小写字母，2纯大写字母，3数字+小写字母，4数字+大写字母，5大小写字母，6数字+大小写字母 |
| cap_width | int | 可选 | 验证码图片宽度，单位：px |
| cap_height | int | 可选 | 验证码图片高度，单位：px |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示生成成功|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.img_url | string | 验证码图片地址，例如：http://cd7.yesapi.net/CEE4B8A091578B252AC4C92FB4E893C3_20220428173857_955e98d069e35b12fd331e53033d91e0.jpg|
| data.code | string | 验证码字符串，如：7691|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Captcha.Create4&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参数错误"
}
```

{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "img_url": "http://cd7.yesapi.net/CEE4B8A091578B252AC4C92FB4E893C3_20220428173857_955e98d069e35b12fd331e53033d91e0.jpg",
        "code": "7961"
    },
    "msg": "V3.3.0 YesApi App.Captcha.Create4 2022-04-28 17:38:57 hn1"
}

接口返回

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

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Captcha/Create6

接口路径(旧)：http://api.yesapi.net/?s=App.Captcha.Create6

接口描述：生成六位图片验证码，支持多种组合，例如：纯数字、纯字母或数字和字母的组合

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
cap_type	整型	可选	0		验证码的字符集类型，0纯数字，1纯小写字母，2纯大写字母，3数字+小写字母，4数字+大写字母，5大小写字母，6数字+大小写字母
cap_width	整型	可选	150		验证码图片宽度，单位：px
cap_height	整型	可选	40		验证码图片高度，单位：px

客户端请求示例

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

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 104 生成六位图片验证码接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Captcha.Create6`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  生成六位图片验证码，支持多种组合，例如：纯数字、纯字母或数字和字母的组合
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Captcha.Create6` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| cap_type | int | 可选 | 验证码的字符集类型，0纯数字，1纯小写字母，2纯大写字母，3数字+小写字母，4数字+大写字母，5大小写字母，6数字+大小写字母 |
| cap_width | int | 可选 | 验证码图片宽度，单位：px |
| cap_height | int | 可选 | 验证码图片高度，单位：px |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示生成成功|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.img_url | string | 验证码图片地址，例如：http://cd7.yesapi.net/CEE4B8A091578B252AC4C92FB4E893C3_20220428174318_ddd1b745b77feb2e6b8629605b134652.jpg|
| data.code | string | 验证码字符串，如：254866|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Captcha.Create6&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参数错误"
}
```

{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "img_url": "http://cd7.yesapi.net/CEE4B8A091578B252AC4C92FB4E893C3_20220428174318_ddd1b745b77feb2e6b8629605b134652.jpg",
        "code": "254866"
    },
    "msg": "V3.3.0 YesApi App.Captcha.Create6 2022-04-28 17:43:18 hn1"
}

接口返回

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

101 创建新的验证码接口

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

102 校对验证码接口

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

103 生成四位图片验证码接口

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

104 生成六位图片验证码接口

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

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

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

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

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