• 小白接口
  • 我的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 接口文档

CURL-GET请求接口 v1.0

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

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

接口描述: 如果需要通过curl请求 非80443 端口,请先提交工单 申请开放端口

接口参数 若无特殊说明,接口参数同时支持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接入。


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

## 接口基本信息
- **功能描述**:   如果需要通过curl请求 非80443 端口,请先提交工单 申请开放端口
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACurlGetApi` |
| 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.Sdogstar_MyApi.ACurlGetApi&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 接口文档

CURL-POST请求接口 v1.0

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

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

接口描述: 如果需要通过curl请求 非80443 端口,请先提交工单 申请开放端口

接口参数 若无特殊说明,接口参数同时支持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接入。


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

## 接口基本信息
- **功能描述**:   如果需要通过curl请求 非80443 端口,请先提交工单 申请开放端口
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou1012` |
| 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.Sdogstar_MyApi.AJieKou1012&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 接口文档

Discuz经典加密方法接口 v1.0

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

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

接口描述: PHP针对需要加密或解密的字符串,进行ENCODE加密 DECODE 解密

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
string字符串必须最小:1需要加密或解密的字符串
operation字符串可选ENCODE操作类型 ENCODE加密 DECODE 解密

客户端请求示例

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

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


# 【 Discuz经典加密方法接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADiscuzEncryptionApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP针对需要加密或解密的字符串,进行ENCODE加密 DECODE 解密
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ADiscuzEncryptionApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| string | string | 必填 | 需要加密或解密的字符串 |
| operation | string | 可选 | 操作类型 ENCODE加密 DECODE 解密 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADiscuzEncryptionApi&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": "3c04q3CyugOF5F2Yfgg1FAkhJ2Ym6vIvzz6Jds7MHrkFbaU",
    "msg": ""
}

接口返回

返回字段类型说明
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 接口文档

Hello Wolrd示例接口 v1.19

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

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

接口描述: 入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
name字符串必须开发者随便一个名字参数

客户端请求示例

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

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


# 【 Hello Wolrd示例接口 v1.19】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAppHelloWorld`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:    入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AAppHelloWorld` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| name | string | 必填 | 随便一个名字参数 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| 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时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAppHelloWorld&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表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

JSON参数接收及调试 v1.32

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

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

接口描述: 客户端3种传递JSON参数的方式:原始数据、JSON、或用逗号分割

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
arr字符串可选
arr_json字符串JSON格式可选
arr_ex字符串用,分割可选

客户端请求示例

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

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


# 【 JSON参数接收及调试 v1.32】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJsontest`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   客户端3种传递JSON参数的方式:原始数据、JSON、或用逗号分割
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJsontest` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| arr | array | 可选 |  |
| arr_json | array | 可选 |  |
| arr_ex | array | 可选 |  |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJsontest&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 接口文档

JWT加密解密 v1.0

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

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

接口描述: 调用JWT进行加密和解密,从而实现自己的业务逻辑

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
name字符串必须要加密的账号名

客户端请求示例

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

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


# 【 JWT加密解密 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJWTDemo`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   调用JWT进行加密和解密,从而实现自己的业务逻辑
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJWTDemo` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| name | string | 必填 | 要加密的账号名 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJWTDemo&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.jwt字符串加密后的JWTtoken
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

PHP Curl Post请求 v1.0

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

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

接口描述: 发送POST请求,设置超时等

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 PHP Curl Post请求 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.APHPCurlPost`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   发送POST请求,设置超时等
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.APHPCurlPost` |
| 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.Sdogstar_MyApi.APHPCurlPost&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 接口文档

PHP 冒泡排序算法接口 v1.0

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

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

接口描述: 对需要排序的数组从后往前(逆序)进行多遍的扫描,当发现相邻的两个数值的次序与排序要求的规则不一致时,就将这两个数值进行交换。这样比较小(大)的数值就将逐渐从后面向前面移动

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
arr字符串用,分割必须待排序的数据,如:8,4,2,5,7

客户端请求示例

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

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


# 【 PHP 冒泡排序算法接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ABubbleSortApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   对需要排序的数组从后往前(逆序)进行多遍的扫描,当发现相邻的两个数值的次序与排序要求的规则不一致时,就将这两个数值进行交换。这样比较小(大)的数值就将逐渐从后面向前面移动
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ABubbleSortApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| arr | array | 必填 | 待排序的数据,如:8,4,2,5,7 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ABubbleSortApi&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 接口文档

PHP 快速排序接口 v1.0

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

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

接口描述: 在数组中挑出一个元素(多为第一个)作为标尺,扫描一遍数组将比标尺小的元素排在标尺之前,将所有比标尺大的元素排在标尺之后,通过递归将各子序列分别划分为更小的序列直到所有的序列顺序一致

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
arr字符串用,分割必须待排序的数据,如:8,3,7,1

客户端请求示例

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

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


# 【 PHP 快速排序接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AQuickSortApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   在数组中挑出一个元素(多为第一个)作为标尺,扫描一遍数组将比标尺小的元素排在标尺之前,将所有比标尺大的元素排在标尺之后,通过递归将各子序列分别划分为更小的序列直到所有的序列顺序一致
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AQuickSortApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| arr | array | 必填 | 待排序的数据,如:8,3,7,1 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AQuickSortApi&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 接口文档

PHP 求两个已知经纬度之间的距离,单位为米 v1.0

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

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

接口描述: PHP 求两个已知经纬度之间的距离,单位为米

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
lng1浮点型必须
lat1浮点型必须
lng2浮点型必须
lat2浮点型必须

客户端请求示例

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

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


# 【 PHP 求两个已知经纬度之间的距离,单位为米 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetDistanceApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 求两个已知经纬度之间的距离,单位为米
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetDistanceApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| lng1 | float | 必填 |  |
| lat1 | float | 必填 |  |
| lng2 | float | 必填 |  |
| lat2 | float | 必填 |  |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetDistanceApi&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.distance浮点型距离,单位米
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

PHP判断IP是否属于某个网段接口 v1.0

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

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

接口描述: 示例:判断192.168.1.127是否在 (192.168.1.1--192.168.1.255)的范围里面

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 PHP判断IP是否属于某个网段接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJieKou1017`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   示例:判断192.168.1.127是否在 (192.168.1.1--192.168.1.255)的范围里面
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou1017` |
| 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.Sdogstar_MyApi.AJieKou1017&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 接口文档

XML转JSON数组 v1.0

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

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

接口描述: XML解析,转换为数组,或JSON格式

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 XML转JSON数组 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AXML2JSON`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   XML解析,转换为数组,或JSON格式
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AXML2JSON` |
| 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.Sdogstar_MyApi.AXML2JSON&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 接口文档

base64解码接口 v1.0

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

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

接口描述: 对传上来的数据进行base64解码

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
encode_data字符串必须YWJjbase64编码的数据

客户端请求示例

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

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


# 【 base64解码接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ABase64DecodeAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   对传上来的数据进行base64解码
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ABase64DecodeAPI` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| encode_data | string | 必填 | base64编码的数据 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ABase64DecodeAPI&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 接口文档

php访问url路径,get请求 v1.0

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

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

接口描述: 原始的方式,进行PHP Curl GET请求访问

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 php访问url路径,get请求 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.APHPCUrlGet`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   原始的方式,进行PHP Curl GET请求访问
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.APHPCUrlGet` |
| 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.Sdogstar_MyApi.APHPCUrlGet&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/Sdogstar_MyApi/AMakeContentSummaryApi

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

接口描述: 根据文章内容,从内容中取出简介。

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
content字符串必须最小:1传入的内容
length整型可选200最小:5
b_pure布尔型可选false是否过滤所有标签,还是只保留

和

客户端请求示例

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

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


# 【 从内容中取出简介 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AMakeContentSummaryApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据文章内容,从内容中取出简介。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AMakeContentSummaryApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| content | string | 必填 | 传入的内容 |
| length | int | 可选 |  |
| b_pure | boolean | 可选 | 是否过滤所有标签,还是只保留和 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AMakeContentSummaryApi&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/Sdogstar_MyApi/AQWorkWeixinBotSend

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

接口描述: 发送实时消息通知到企业微信群

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AQWorkWeixinBotSend`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   发送实时消息通知到企业微信群
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AQWorkWeixinBotSend` |
| 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.Sdogstar_MyApi.AQWorkWeixinBotSend&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/Sdogstar_MyApi/ALunarApi

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

接口描述: 基于 fengLunar,进行各种农历 节气 节日等操作,有:将阴历转换为阳历,判断是否是闰年,获取干支纪年,根据阴历年获取生肖,获取阳历月份的天数,获取阴历每月的天数的数组,获取农历每年的天数,获取闰月,计算阴历日期与正月初一相隔的天数,计算2个阳历日期之间的天数,节气通用算法,根据节气获取季节等

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.ALunarApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   基于 fengLunar,进行各种农历 节气 节日等操作,有:将阴历转换为阳历,判断是否是闰年,获取干支纪年,根据阴历年获取生肖,获取阳历月份的天数,获取阴历每月的天数的数组,获取农历每年的天数,获取闰月,计算阴历日期与正月初一相隔的天数,计算2个阳历日期之间的天数,节气通用算法,根据节气获取季节等
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ALunarApi` |
| 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.Sdogstar_MyApi.ALunarApi&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/Sdogstar_MyApi/ACreateOkayapiArticleDataApi

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

接口描述: 示例:创建博客文章,可存放CMS内容新数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
article_title字符串必须文章标题
article_sub_title字符串可选文章副标题
article_author字符串可选文章作者
article_content字符串必须文章内容,支持HTML格式
article_post_time字符串可选文章发表时间
article_view_times字符串可选0文章阅读量

客户端请求示例

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

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


# 【 创建一条新数据到我的表单 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACreateOkayapiArticleDataApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   示例:创建博客文章,可存放CMS内容新数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACreateOkayapiArticleDataApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| article_title | string | 必填 | 文章标题 |
| article_sub_title | string | 可选 | 文章副标题 |
| article_author | string | 可选 | 文章作者 |
| article_content | string | 必填 | 文章内容,支持HTML格式 |
| article_post_time | string | 可选 | 文章发表时间 |
| article_view_times | 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.Sdogstar_MyApi.ACreateOkayapiArticleDataApi&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": "",
        "id": "1"
    },
    "msg": ""
}

接口返回

返回字段类型说明
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 接口文档

创建小程序订单2⚠️ v1.0

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

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

接口描述: 创建小程序订单2⚠️新数据

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
order_img字符串可选封面照片
order_good_id字符串必须商品id
order_goods_num字符串可选购买数量
order_identify字符串可选用户唯一标识
order_mobile字符串可选购买者联系方式
order_remark字符串可选订单备注
order_goods字符串可选购买内容与规格参数
order_price字符串可选商品单价(单位元)
order_location字符串可选订单送货地址
order_status字符串可选订单状态(0表示取消订单)
order_time字符串可选下单时间
order_number字符串可选订单号(流水号,唯一)
order_buyer字符串可选购买者
num整型可选数字
atsp字符串可选atsp
order_desc字符串可选订单描述
color字符串可选颜色

客户端请求示例

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

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


# 【 创建小程序订单2⚠️ v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACreateYesapiteaorder`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   创建小程序订单2⚠️新数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACreateYesapiteaorder` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| order_img | string | 可选 | 封面照片 |
| order_good_id | string | 必填 | 商品id |
| order_goods_num | string | 可选 | 购买数量 |
| order_identify | string | 可选 | 用户唯一标识 |
| order_mobile | string | 可选 | 购买者联系方式 |
| order_remark | string | 可选 | 订单备注 |
| order_goods | string | 可选 | 购买内容与规格参数 |
| order_price | string | 可选 | 商品单价(单位元) |
| order_location | string | 可选 | 订单送货地址 |
| order_status | string | 可选 | 订单状态(0表示取消订单) |
| order_time | string | 可选 | 下单时间 |
| order_number | string | 可选 | 订单号(流水号,唯一) |
| order_buyer | string | 可选 | 购买者 |
| num | int | 可选 | 数字 |
| atsp | string | 可选 | atsp |
| order_desc | string | 可选 | 订单描述 |
| color | 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.Sdogstar_MyApi.ACreateYesapiteaorder&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.13

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

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

接口描述: 演示添加一条新数据到表单,使用前请先安装okayapi_course表单

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
course_id字符串可选课程编号
course_name字符串可选课程名
course_url字符串可选课程链接
course_desc字符串可选课程描述
course_instructor字符串可选课程讲师
course_thumbnail字符串可选课程封面缩略图地址
course_start_time字符串可选1970-01-01 00:00:00课程开始时间
course_end_time字符串可选2100-01-01 00:00:00课程结束时间

客户端请求示例

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

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


# 【 创建课程新数据 v1.13】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACreateOkayapicourse`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示添加一条新数据到表单,使用前请先安装okayapi_course表单
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACreateOkayapicourse` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| course_id | string | 可选 | 课程编号 |
| course_name | string | 可选 | 课程名 |
| course_url | string | 可选 | 课程链接 |
| course_desc | string | 可选 | 课程描述 |
| course_instructor | string | 可选 | 课程讲师 |
| course_thumbnail | string | 可选 | 课程封面缩略图地址 |
| course_start_time | string | 可选 | 课程开始时间 |
| course_end_time | 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.Sdogstar_MyApi.ACreateOkayapicourse&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 接口文档

判断IP是否在某个网络内接口 v1.0

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

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

接口描述: 根据CIDR 格式判断,例如 判断192.168.1.127 是否在 192.168.1.112 IP段内

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 判断IP是否在某个网络内接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AIPInNetwork`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据CIDR 格式判断,例如 判断192.168.1.127 是否在 192.168.1.112 IP段内
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AIPInNetwork` |
| 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.Sdogstar_MyApi.AIPInNetwork&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/Sdogstar_MyApi/AIsMoblie

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

接口描述: 是否手机客户端请求

接口参数 若无特殊说明,接口参数同时支持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.3】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AIsMoblie`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   是否手机客户端请求
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AIsMoblie` |
| 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.Sdogstar_MyApi.AIsMoblie&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/Sdogstar_MyApi/AJieKou1110Raw

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

接口描述: 通过 YESAPI_SANDBOX 可以进行判断,布尔值

接口参数 若无特殊说明,接口参数同时支持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.5】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJieKou1110Raw`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   通过 YESAPI_SANDBOX 可以进行判断,布尔值
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou1110Raw` |
| 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.Sdogstar_MyApi.AJieKou1110Raw&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/Sdogstar_MyApi/AFriendDateTimeApi

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

接口描述: PHP 把时间字符串,格式化成最近的友好显示,计算距离现在的时间,例如:刚刚、x秒前、x小时前,明天、后天等

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
datetime字符串可选任意有效的时间字符串,如:2024-11-11

客户端请求示例

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

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


# 【 友好格式化日期时间显示接口 v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AFriendDateTimeApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 把时间字符串,格式化成最近的友好显示,计算距离现在的时间,例如:刚刚、x秒前、x小时前,明天、后天等
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AFriendDateTimeApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| datetime | string | 可选 | 任意有效的时间字符串,如:2024-11-11 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AFriendDateTimeApi&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": "刚刚",
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ADingtalkRobotSend

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

接口描述: 发送钉钉群消息

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.ADingtalkRobotSend`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   发送钉钉群消息
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ADingtalkRobotSend` |
| 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.Sdogstar_MyApi.ADingtalkRobotSend&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/Sdogstar_MyApi/AFeishuBotSend

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

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

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AFeishuBotSend`
**请求方式**: POST/GET

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

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AFeishuBotSend` |
| 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.Sdogstar_MyApi.AFeishuBotSend&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/Sdogstar_MyApi/AJieKouDBDemo0518

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

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

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AJieKouDBDemo0518`
**请求方式**: POST/GET

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

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKouDBDemo0518` |
| 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.Sdogstar_MyApi.AJieKouDBDemo0518&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/Sdogstar_MyApi/AFreeUpdateOkayapiArticleApi

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

接口描述: 演示:创建非重复博客文章,数据存在时则更新否则新增数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
article_title字符串必须数据 文章标题
article_sub_title字符串可选数据 文章副标题
article_author字符串可选数据 文章作者
article_content字符串必须数据 文章内容,支持HTML格式
article_post_time字符串可选数据 文章发表时间
article_view_times字符串可选数据 文章阅读量

客户端请求示例

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

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


# 【 如何创建非重复的表单数据 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AFreeUpdateOkayapiArticleApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:创建非重复博客文章,数据存在时则更新否则新增数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AFreeUpdateOkayapiArticleApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| article_title | string | 必填 | 数据 文章标题 |
| article_sub_title | string | 可选 | 数据 文章副标题 |
| article_author | string | 可选 | 数据 文章作者 |
| article_content | string | 必填 | 数据 文章内容,支持HTML格式 |
| article_post_time | string | 可选 | 数据 文章发表时间 |
| article_view_times | 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.Sdogstar_MyApi.AFreeUpdateOkayapiArticleApi&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.0

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

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

接口描述: 演示:根据ID,删除博客文章数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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整型必须待删除的ID

客户端请求示例

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

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


# 【 如何删除表单数据 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADeleteOkayapiArticleApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:根据ID,删除博客文章数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ADeleteOkayapiArticleApi` |
| 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 | 必填 | 待删除的ID |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADeleteOkayapiArticleApi&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": "",
        "deleted": 0
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

如何根据条件删除表单数据 v1.0

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

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

接口描述: 演示:根据条件删除博客文章,删除全部符合条件的数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
article_title字符串必须最小:1待删除的文章标题
article_content字符串必须最小:1待删除的文章内容,支持HTML格式

客户端请求示例

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

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


# 【 如何根据条件删除表单数据 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AFreeDeleteOkayapiArticleDataApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:根据条件删除博客文章,删除全部符合条件的数据。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AFreeDeleteOkayapiArticleDataApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| article_title | string | 必填 | 待删除的文章标题 |
| article_content | string | 必填 | 待删除的文章内容,支持HTML格式 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AFreeDeleteOkayapiArticleDataApi&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.deleted_rows整型返回更新的条数,0表示没有无删除,正数表示删除的条数,false表示删除失败
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

如获获取表单数据列表 v1.0

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

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

接口描述: 演示:根据搜索条件(例如搜索 文章标题),分页获取我的数据列表。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
page整型可选1最小:1第几页
perpage整型可选10最小:1;最大:10000分页数量
article_title字符串可选文章标题

客户端请求示例

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

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


# 【 如获获取表单数据列表 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AListOkayapiArticleDataApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:根据搜索条件(例如搜索 文章标题),分页获取我的数据列表。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AListOkayapiArticleDataApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| article_title | string | 可选 | 文章标题 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.items | array | 数据列表,失败时返回空数组|
| data.total | int | 总数|
| data.items[].article_title | string | 文章标题|
| data.items[].article_sub_title | string | 文章副标题|
| data.items[].article_author | string | 文章作者|
| data.items[].article_content | string | 文章内容,支持HTML格式|
| data.items[].article_post_time | string | 文章发表时间|
| data.items[].article_view_times | string | 文章阅读量|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AListOkayapiArticleDataApi&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.items字符串数据列表,失败时返回空数组
data.total整型总数
data.items[].article_title字符串文章标题
data.items[].article_sub_title字符串文章副标题
data.items[].article_author字符串文章作者
data.items[].article_content字符串文章内容,支持HTML格式
data.items[].article_post_time字符串文章发表时间
data.items[].article_view_times字符串文章阅读量
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

常用实用函数演示接口 v1.0

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

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

接口描述: 获取时间、JSON解码编码、Md5等

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.ACommonFunctionApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   获取时间、JSON解码编码、Md5等
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACommonFunctionApi` |
| 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.Sdogstar_MyApi.ACommonFunctionApi&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/Sdogstar_MyApi/AAppCommonBannerWordCheck0305

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

接口描述: 根据传递的文本进行敏感词的检测,如果存在敏感词会将包含敏感词通过数组返回

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
content字符串必须最小:1待检测的文本

客户端请求示例

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

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


# 【  敏感词检测接口 v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAppCommonBannerWordCheck0305`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:    根据传递的文本进行敏感词的检测,如果存在敏感词会将包含敏感词通过数组返回
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AAppCommonBannerWordCheck0305` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| content | string | 必填 | 待检测的文本 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAppCommonBannerWordCheck0305&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没有,1有敏感词
data.sensitiveWord字符串包含的敏感词
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

数据脱敏接口 v1.0

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

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

接口描述: PHP 数据脱敏 支持指定类型及自定义规则脱敏,支持:1姓名,2出生日期,3手机号,4身份证,5银行卡号,6电子邮箱

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
string字符串必须最小:1待脱敏的字符串
type整型必须脱敏类型,1姓名、2出生日期、3手机号、4身份证、5银行卡号、6电子邮箱

客户端请求示例

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

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


# 【 数据脱敏接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADataMaskingAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 数据脱敏 支持指定类型及自定义规则脱敏,支持:1姓名,2出生日期,3手机号,4身份证,5银行卡号,6电子邮箱
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ADataMaskingAPI` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| string | string | 必填 | 待脱敏的字符串 |
| type | int | 必填 | 脱敏类型,1姓名、2出生日期、3手机号、4身份证、5银行卡号、6电子邮箱 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ADataMaskingAPI&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": "+86138****8000",
    "msg": ""
}

接口返回

返回字段类型说明
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 接口文档

数组转xml v1.0

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

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

接口描述: PHP 数组转xml

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 数组转xml v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AArrayToXml`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 数组转xml
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AArrayToXml` |
| 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.Sdogstar_MyApi.AArrayToXml&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/Sdogstar_MyApi/AJieKou0407

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

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

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
hanzi字符串必须汉字

客户端请求示例

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

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


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

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

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou0407` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| hanzi | string | 必填 | 汉字 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJieKou0407&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/Sdogstar_MyApi/AJieKou0727

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

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

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AJieKou0727`
**请求方式**: POST/GET

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

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou0727` |
| 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.Sdogstar_MyApi.AJieKou0727&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/Sdogstar_MyApi/AJieKou0617

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

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

接口参数 若无特殊说明,接口参数同时支持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.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJieKou0617`
**请求方式**: POST/GET

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

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou0617` |
| 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.Sdogstar_MyApi.AJieKou0617&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/Sdogstar_MyApi/AUpdateOkayapiArticleDataApi

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

接口描述: 演示:更新博客文章,。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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整型必须待更新的数据ID
article_title字符串必须文章标题
article_sub_title字符串可选文章副标题
article_author字符串可选文章作者
article_content字符串必须文章内容,支持HTML格式
article_post_time字符串可选文章发表时间
article_view_times字符串可选0文章阅读量

客户端请求示例

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

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


# 【 更新表单数据 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AUpdateOkayapiArticleDataApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:更新博客文章,。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AUpdateOkayapiArticleDataApi` |
| 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 | 必填 | 待更新的数据ID |
| article_title | string | 必填 | 文章标题 |
| article_sub_title | string | 可选 | 文章副标题 |
| article_author | string | 可选 | 文章作者 |
| article_content | string | 必填 | 文章内容,支持HTML格式 |
| article_post_time | string | 可选 | 文章发表时间 |
| article_view_times | string | 可选 | 文章阅读量 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AUpdateOkayapiArticleDataApi&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": "",
        "updated": 1
    },
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ACacheDemoApi

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

接口描述: 使用缓存,可以避免重复查询数据库。尤其是在统计总数、关联多张表查询一条数据时,可以考虑和结合使用缓存来提升你的接口访问速度和性能。

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.ACacheDemoApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   使用缓存,可以避免重复查询数据库。尤其是在统计总数、关联多张表查询一条数据时,可以考虑和结合使用缓存来提升你的接口访问速度和性能。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACacheDemoApi` |
| 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.Sdogstar_MyApi.ACacheDemoApi&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/Sdogstar_MyApi/AServerLoggerApi

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

接口描述: 日志纪录后,可以到开放平台查看日志。在测试环境调试时,日记【不会】写入到正式数据库,只会显示在调试日志。

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AServerLoggerApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   日志纪录后,可以到开放平台查看日志。在测试环境调试时,日记【不会】写入到正式数据库,只会显示在调试日志。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AServerLoggerApi` |
| 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.Sdogstar_MyApi.AServerLoggerApi&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/Sdogstar_MyApi/AByteFormatApi

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

接口描述: 格式化成人类容易阅读的单位,例如100000返回 97.66 KB

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
size字符串必须最小:0单位:byte 字节

客户端请求示例

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

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


# 【 格式化字节单位接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AByteFormatApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   格式化成人类容易阅读的单位,例如100000返回 97.66 KB
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AByteFormatApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| size | string | 必填 | 单位:byte 字节 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AByteFormatApi&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": "97.66 KB",
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ACheckPwdStrong

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

接口描述: 检测密码强度, 1~3 较弱 4~6 一般 6~10 强

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
password字符串必须密码

客户端请求示例

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

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


# 【 检测密码强度接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACheckPwdStrong`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:    检测密码强度, 1~3  较弱    4~6  一般    6~10 强
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACheckPwdStrong` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| password | string | 必填 | 密码 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACheckPwdStrong&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": {
        "score": 2
    },
    "msg": "",
    "_t": 1728720003,
    "_auth": "455621bd1e6f21b9d2416120584d7f0e"
}

接口返回

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

YesApi 接口文档

汉字转拼音接口 v1.0

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

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

接口描述: 支持:将一段汉字串内容转成拼音,获取拼音首字母,姓名转拼音

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.APinyinApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   支持:将一段汉字串内容转成拼音,获取拼音首字母,姓名转拼音
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.APinyinApi` |
| 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.Sdogstar_MyApi.APinyinApi&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/Sdogstar_MyApi/AGetOkayapiArticleDataApi

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

接口描述: 演示:根据ID,获取博客文章数据详情。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)

接口参数 若无特殊说明,接口参数同时支持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整型必须博客文章,可存放CMS内容数据ID

客户端请求示例

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

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


# 【 演示获取一条表单数据 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetOkayapiArticleDataApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示:根据ID,获取博客文章数据详情。请先安装此表:https:open.yesapi.cntablelistokayapi_article.html (调试时先同步到测试库)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetOkayapiArticleDataApi` |
| 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 | 必填 | 博客文章,可存放CMS内容数据ID |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.item | object | 成功时返回数据详情,失败时返回null|
| data.item.article_title | string | 文章标题|
| data.item.article_sub_title | string | 文章副标题|
| data.item.article_author | string | 文章作者|
| data.item.article_content | string | 文章内容,支持HTML格式|
| data.item.article_post_time | string | 文章发表时间|
| data.item.article_view_times | string | 文章阅读量|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetOkayapiArticleDataApi&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": "",
        "item": {
            "id": 1,
            "uuid": "",
            "add_time": "2024-10-14 11:24:18",
            "update_time": "2024-10-14 11:29:02",
            "ext_data": null,
            "article_title": "222",
            "article_sub_title": null,
            "article_author": null,
            "article_content": "4444",
            "article_post_time": null,
            "article_view_times": 0
        }
    },
    "msg": ""
}

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.item对象成功时返回数据详情,失败时返回null
data.item.article_title字符串文章标题
data.item.article_sub_title字符串文章副标题
data.item.article_author字符串文章作者
data.item.article_content字符串文章内容,支持HTML格式
data.item.article_post_time字符串文章发表时间
data.item.article_view_times字符串文章阅读量
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

生成唯一订单号接口 v1.0

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

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

接口描述: 生成唯一订单号

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AGetOrderSN`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   生成唯一订单号
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetOrderSN` |
| 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.Sdogstar_MyApi.AGetOrderSN&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": "2410127481543431",
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ASetTokenJieKou

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

接口描述: 返回随机指定长度随机字符串

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
lenth整型可选20最小:6字符串长度

客户端请求示例

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

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


# 【 生成随机字符串(字母+数字)接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ASetTokenJieKou`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   返回随机指定长度随机字符串
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ASetTokenJieKou` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| lenth | int | 可选 | 字符串长度 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ASetTokenJieKou&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": "9ENO3QYaHana44Acfb4I",
    "msg": "",
    "_t": 1728721352,
    "_auth": "413f65f5d99c1849581d571478942ba7"
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ARandomPhoneAPI

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

接口描述: 生成随机11位手机号码,例如用于生成测试数据

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
operator整型可选运营商类型(默认随机;0,移动;1,联通;2,电信)

客户端请求示例

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

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


# 【 生成随机手机号码接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ARandomPhoneAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   生成随机11位手机号码,例如用于生成测试数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ARandomPhoneAPI` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| operator | int | 可选 | 运营商类型(默认随机;0,移动;1,联通;2,电信) |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ARandomPhoneAPI&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": {
        "phone": "18099888093"
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

生成随机身份证号接口 v1.0

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

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

接口描述: PHP 生成随机身份证号,可用于生成模拟测试数据

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.ARandomCardId`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 生成随机身份证号,可用于生成模拟测试数据
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ARandomCardId` |
| 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 | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.ID | string | 随机身份证号码|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ARandomCardId&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": {
        "ID": "510132200811171229"
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

腾讯云发送短信接口 php v1.0

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

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

接口描述: 要在PHP中使用腾讯云短信服务发送短信,你需要先在腾讯云注册账号,创建短信应用,获取App ID、App Key和短信签名以及模板ID。以下是一个简单的示例代码,展示了如何使用腾讯云短信服务SDK发送短信的接口。发布后,即可正式使用。所用的官方Github类库:https:github.comqcloudsmsqcloudsms_php,参考文档:腾讯云 发送短信相关接口:https:cloud.tencent.comdocumentproduct38255981,以及腾讯云控制台-短信:https:console.cloud.tencent.comsmsv2 。

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
phone字符串用,分割必须最小:1手机号,不用带+86区号

客户端请求示例

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

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


# 【 腾讯云发送短信接口 php v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AQcloudsmsphpApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   要在PHP中使用腾讯云短信服务发送短信,你需要先在腾讯云注册账号,创建短信应用,获取App ID、App Key和短信签名以及模板ID。以下是一个简单的示例代码,展示了如何使用腾讯云短信服务SDK发送短信的接口。发布后,即可正式使用。所用的官方Github类库:https:github.comqcloudsmsqcloudsms_php,参考文档:腾讯云 发送短信相关接口:https:cloud.tencent.comdocumentproduct38255981,以及腾讯云控制台-短信:https:console.cloud.tencent.comsmsv2 。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AQcloudsmsphpApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| phone | array | 必填 | 手机号,不用带+86区号 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AQcloudsmsphpApi&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/Sdogstar_MyApi/AJieKou1107File

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

接口描述: 演示文件上传到接口的获取

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
upload_filefile必须

客户端请求示例

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

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


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

## 接口基本信息
- **功能描述**:   演示文件上传到接口的获取
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKou1107File` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| upload_file | file | 必填 |  |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AJieKou1107File&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/Sdogstar_MyApi/AJieKouCaoLiaoDataPush

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

接口描述: 通过草料二维码的数据推送API接口,自动同步写入到自己的SQLServer数据库表或MySQL数据库表。提供完整的步骤、接口源代码、推送示例数据、推送日记和免费接口。亲测有效。

接口参数 若无特殊说明,接口参数同时支持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.Sdogstar_MyApi.AJieKouCaoLiaoDataPush`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   通过草料二维码的数据推送API接口,自动同步写入到自己的SQLServer数据库表或MySQL数据库表。提供完整的步骤、接口源代码、推送示例数据、推送日记和免费接口。亲测有效。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AJieKouCaoLiaoDataPush` |
| 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.Sdogstar_MyApi.AJieKouCaoLiaoDataPush&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.8

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

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

接口描述: 功能更强大,用数据库方式对会员进行操作(开发前,需要手动同步一次系统表到测试环境)

接口参数 若无特殊说明,接口参数同时支持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.8】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AMyMemberList`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   功能更强大,用数据库方式对会员进行操作(开发前,需要手动同步一次系统表到测试环境)
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AMyMemberList` |
| 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.Sdogstar_MyApi.AMyMemberList&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/Sdogstar_MyApi/AGetCityFirstCharsApi

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

接口描述: PHP 获取城市地址首字母,如 广州 返回 G

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
city字符串必须广州城市名,如:广州

客户端请求示例

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

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


# 【 获取城市地址首字母接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetCityFirstCharsApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 获取城市地址首字母,如 广州 返回  G
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetCityFirstCharsApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| city | string | 必填 | 城市名,如:广州 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetCityFirstCharsApi&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 接口文档

获取客户端IP地址接口 v1.0

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

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

接口描述: 获取客户端IP,返回例如:120.120.120.120

接口参数 若无特殊说明,接口参数同时支持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接入。


# 【 获取客户端IP地址接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetClientIPApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   获取客户端IP,返回例如:120.120.120.120
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetClientIPApi` |
| 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.Sdogstar_MyApi.AGetClientIPApi&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/Sdogstar_MyApi/AGetYesapiteaorder

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

接口描述: 根据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表示不允许。
id整型必须小程序订单数据ID

客户端请求示例

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

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


# 【 获取小程序订单数据 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetYesapiteaorder`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据ID,获取小程序订单数据详情
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetYesapiteaorder` |
| 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 | 必填 | 小程序订单数据ID |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.item | object | 成功时返回数据详情,失败时返回null|
| data.item.order_img | string | 封面照片|
| data.item.order_good_id | string | 商品id|
| data.item.order_goods_num | string | 购买数量|
| data.item.order_identify | string | 用户唯一标识|
| data.item.order_mobile | string | 购买者联系方式|
| data.item.order_remark | string | 订单备注|
| data.item.order_goods | string | 购买内容与规格参数|
| data.item.order_price | string | 商品单价(单位元)|
| data.item.order_location | string | 订单送货地址|
| data.item.order_status | string | 订单状态(0表示取消订单)|
| data.item.order_time | string | 下单时间|
| data.item.order_number | string | 订单号(流水号,唯一)|
| data.item.order_buyer | string | 购买者|
| data.item.num | int | 数字|
| data.item.atsp | string | atsp|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetYesapiteaorder&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.item对象成功时返回数据详情,失败时返回null
data.item.order_img字符串封面照片
data.item.order_good_id字符串商品id
data.item.order_goods_num字符串购买数量
data.item.order_identify字符串用户唯一标识
data.item.order_mobile字符串购买者联系方式
data.item.order_remark字符串订单备注
data.item.order_goods字符串购买内容与规格参数
data.item.order_price字符串商品单价(单位元)
data.item.order_location字符串订单送货地址
data.item.order_status字符串订单状态(0表示取消订单)
data.item.order_time字符串下单时间
data.item.order_number字符串订单号(流水号,唯一)
data.item.order_buyer字符串购买者
data.item.num整型数字
data.item.atsp字符串atsp
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

获取小程序订单数据 v1.6

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

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

接口描述: 演示 根据ID,获取xxx表单的具体数据详情,顺便演示中文开发接口的代码。

接口参数 若无特殊说明,接口参数同时支持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整型必须小程序订单数据ID

客户端请求示例

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

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


# 【 获取小程序订单数据 v1.6】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AHuoQuYesapiteaorder`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示 根据ID,获取xxx表单的具体数据详情,顺便演示中文开发接口的代码。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AHuoQuYesapiteaorder` |
| 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 | 必填 | 小程序订单数据ID |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.tiao_mu | object | 成功时返回数据详情,失败时返回null|
| data.tiao_mu.order_img | string | 封面照片|
| data.tiao_mu.order_good_id | string | 商品id|
| data.tiao_mu.order_goods_num | string | 购买数量|
| data.tiao_mu.order_identify | string | 用户唯一标识|
| data.tiao_mu.order_mobile | string | 购买者联系方式|
| data.tiao_mu.order_remark | string | 订单备注|
| data.tiao_mu.order_goods | string | 购买内容与规格参数|
| data.tiao_mu.order_price | string | 商品单价(单位元)|
| data.tiao_mu.order_location | string | 订单送货地址|
| data.tiao_mu.order_status | string | 订单状态(0表示取消订单)|
| data.tiao_mu.order_time | string | 下单时间|
| data.tiao_mu.order_number | string | 订单号(流水号,唯一)|
| data.tiao_mu.order_buyer | string | 购买者|
| data.tiao_mu.num | int | 数字|
| data.tiao_mu.atsp | string | atsp|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AHuoQuYesapiteaorder&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.tiao_mu对象成功时返回数据详情,失败时返回null
data.tiao_mu.order_img字符串封面照片
data.tiao_mu.order_good_id字符串商品id
data.tiao_mu.order_goods_num字符串购买数量
data.tiao_mu.order_identify字符串用户唯一标识
data.tiao_mu.order_mobile字符串购买者联系方式
data.tiao_mu.order_remark字符串订单备注
data.tiao_mu.order_goods字符串购买内容与规格参数
data.tiao_mu.order_price字符串商品单价(单位元)
data.tiao_mu.order_location字符串订单送货地址
data.tiao_mu.order_status字符串订单状态(0表示取消订单)
data.tiao_mu.order_time字符串下单时间
data.tiao_mu.order_number字符串订单号(流水号,唯一)
data.tiao_mu.order_buyer字符串购买者
data.tiao_mu.num整型数字
data.tiao_mu.atsp字符串atsp
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

获取文章表单的总数 v1.60

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

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

接口描述: 演示获取表单数据,article可改成你自己任意的表单名。

接口参数 若无特殊说明,接口参数同时支持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.60】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AArticleTotal`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   演示获取表单数据,article可改成你自己任意的表单名。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AArticleTotal` |
| 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 | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.total | string | 表单总数|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AArticleTotal&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.total字符串表单总数
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

获取汉字首字母大写接口 v1.1

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

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

接口描述: PHP 获取汉字首字母大写,例如 果创云 返回 GCY,又如 张三 返回 ZS

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
string字符串必须汉字,如:果创云

客户端请求示例

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

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


# 【 获取汉字首字母大写接口 v1.1】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetFirstCharApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 获取汉字首字母大写,例如 果创云 返回 GCY,又如 张三 返回 ZS
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AGetFirstCharApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| string | string | 必填 | 汉字,如:果创云 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AGetFirstCharApi&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": "GCY",
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/AListDemo1024

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

接口描述: 根据搜索条件,分页获取示例数据列表,支持排序、搜索

接口参数 若无特殊说明,接口参数同时支持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整型可选示例数据ID
page整型可选1最小:1第几页
perpage整型可选10最小:1;最大:10000分页数量
haha字符串可选hahahaha
droplist字符串可选下拉

客户端请求示例

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

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


# 【 获取示例数据列表 v1.2】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AListDemo1024`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   根据搜索条件,分页获取示例数据列表,支持排序、搜索
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AListDemo1024` |
| 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 | 可选 | 示例数据ID |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| haha | string | 可选 | haha |
| droplist | string | 可选 | 下拉 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AListDemo1024&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.items字符串数据列表,失败时返回空数组
data.total整型总数
data.items[].haha字符串haha
data.items[].droplist字符串下拉
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

身份证简单校验解析接口 v1.0

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

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

接口描述: 身份证号(15位、18位兼容)合法性解析和检测,成功检验返回年月日、性别、省份

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
citizen_id字符串必须身份证号码

客户端请求示例

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

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


# 【 身份证简单校验解析接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACheckCitizenIDValidApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   身份证号(15位、18位兼容)合法性解析和检测,成功检验返回年月日、性别、省份
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ACheckCitizenIDValidApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| citizen_id | string | 必填 | 身份证号码 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ACheckCitizenIDValidApi&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": {
        "id": "44098219790110xxxx",
        "location": "广东",
        "Y": "1979",
        "m": "01",
        "d": "10",
        "sex": 1
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

金额转换为中文大写金额接口 v1.0

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

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

接口描述: PHP 金额转换为中文大写金额,如1200转成:叁万叁仟叁佰叁拾叁元

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
amount浮点型必须金额,如:1200

客户端请求示例

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

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


# 【 金额转换为中文大写金额接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAmountConvertApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 金额转换为中文大写金额,如1200转成:叁万叁仟叁佰叁拾叁元
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AAmountConvertApi` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| amount | float | 必填 | 金额,如:1200 |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AAmountConvertApi&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": "叁万叁仟叁佰叁拾叁元",
    "msg": ""
}

接口返回

返回字段类型说明
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/Sdogstar_MyApi/ARandomNameAPI

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

接口描述: PHP 生成某个范围内的随机姓名

接口参数 若无特殊说明,接口参数同时支持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表示不允许。
sex整型可选01 男 2 女 0 不限
issurname字符串可选固定姓,如:黄
是否加入复姓 true 是 false 否布尔型可选true

客户端请求示例

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

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


# 【 随机姓名接口 v1.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ARandomNameAPI`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   PHP 生成某个范围内的随机姓名
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.ARandomNameAPI` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| sex | int | 可选 | 1 男 2 女 0 不限 |
| issurname | string | 可选 | 固定姓,如:黄 |
| 是否加入复姓 true 是 false 否 | boolean | 可选 |  |


## 返回字段

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


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.ARandomNameAPI&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": {
        "surname": "闵",
        "name": "以",
        "username": "闵以"
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

验证身份证号码接口 v1.0

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

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

接口描述: php验证身份证号码是否正确,返回true或false

接口参数 若无特殊说明,接口参数同时支持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.0】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=SVIP.Sdogstar_MyApi.AISIDCardNumberApi`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:   php验证身份证号码是否正确,返回true或false
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`SVIP.Sdogstar_MyApi.AISIDCardNumberApi` |
| 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.Sdogstar_MyApi.AISIDCardNumberApi&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.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次