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

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Add

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Add

接口描述：增添加一个元素到应用的集合里

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
key	字符串	必须		最小：1；最大：64	集合名称
data	字符串JSON格式	必须			元素数据，需要JSON编码后传递。JSON在线解析及格式化验证
keyword	字符串	可选		最大：100	关键字，可用于模糊搜索
weight	整型	可选	0		权重，可用于排序

客户端请求示例

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

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


# 【 5901 添加元素接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Add`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  增 添加一个元素到应用的集合里
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Add` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 必填 | 集合名称 |
| data | array | 必填 | 元素数据，需要JSON编码后传递。JSON在线解析及格式化验证 |
| keyword | string | 可选 | 关键字，可用于模糊搜索 |
| weight | int | 可选 | 权重，可用于排序 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0添加成功|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.id | int | 新添加的元素ID（全局的集合元素ID是唯一的）|


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Add&key=students&data={"username":"dogstar","age":18}&keyword=dogstar&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 65
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Update

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Update

接口描述：改更新应用集合里的某个元素

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
id	整型	必须		最小：1	元素ID
data	字符串JSON格式	必须			增量更新的元素数据，需要JSON编码后传递。JSON在线解析及格式化验证
keyword	字符串	可选		最大：100	待更新的关键字，为空时删除关键字
weight	字符串	可选			待更新的权重

客户端请求示例

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

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


# 【 5902 更新元素接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Update`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  改 更新应用集合里的某个元素
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Update` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| 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 |
| data | array | 必填 | 增量更新的元素数据，需要JSON编码后传递。JSON在线解析及格式化验证 |
| keyword | string | 可选 | 待更新的关键字，为空时删除关键字 |
| weight | string | 可选 | 待更新的权重 |


## 返回字段

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


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Update&id=65&data={"sex":"男"}&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/GetItem

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.GetItem

接口描述：查获取应用集合里的某个元素

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
id	整型	必须		最小：1	元素ID
fields	字符串用,分割	可选			需要获取的字段，默认取全部，多个字段用英文逗号分割

客户端请求示例

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

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


# 【 5903 获取元素接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.GetItem`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  查 获取应用集合里的某个元素
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.GetItem` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| 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 |
| fields | array | 可选 | 需要获取的字段，默认取全部，多个字段用英文逗号分割 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0获取成功，1元素不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.id | int | 元素ID|
| data.key | string | 键名|
| data.data | object | 条目数据|
| data.keyword | string | 关键字|
| data.weight | int | 权重|
| data.add_time | string | 添加时间，格式为：Y-m-d H:i:s|
| data.update_time | string | 最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空|


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.GetItem&id=65&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 65,
        "key": "students",
        "data": {
            "username": "dogstar",
            "age": 18
        },
        "keyword": "dogstar",
        "weight": "0",
        "add_time": "2018-07-02 23:28:21",
        "update_time": ""
    },
    "msg": ""
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0获取成功，1元素不存在
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
data.id	整型	元素ID
data.key	字符串	键名
data.data	对象	条目数据
data.keyword	字符串	关键字
data.weight	整型	权重
data.add_time	字符串	添加时间，格式为：Y-m-d H:i:s
data.update_time	字符串	最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Delete

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Delete

接口描述：删删除应用集合里的某个元素

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
id	整型	必须		最小：1	待删除的元素ID

客户端请求示例

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

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


# 【 5904 删除元素接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Delete`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  删 删除应用集合里的某个元素
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Delete` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| 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.err_code | int | 操作码，0删除成功，1元素不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Delete&id=65&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Count

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Count

接口描述：查获取应用集合里的元素的总数

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
key	字符串	必须		最小：1；最大：64	集合名称

客户端请求示例

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

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


# 【 5905 获取元素总数接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Count`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  查 获取应用集合里的元素的总数
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Count` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 必填 | 集合名称 |


## 返回字段

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


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Count&key=students&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 1
    },
    "msg": ""
}

接口返回

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

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/GetList

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.GetList

接口描述：查获取应用集合里的元素列表

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
key	字符串	必须		最小：1；最大：64	集合名称
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：1000	分页数量
sort	字符串	可选	1	最小：1；最大：6	排序，1创建时间顺序，2创建时间逆序, 3权重顺序，4权重逆序，5更新时间顺序，6更新时间逆序；通过字符串拼接可组合排序，如41表示：权重逆序，创建时间顺序

客户端请求示例

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

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


# 【 5906 获取集合列表接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.GetList`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  查 获取应用集合里的元素列表
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.GetList` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 必填 | 集合名称 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| sort | string | 可选 | 排序，1创建时间顺序，2创建时间逆序, 3权重顺序，4权重逆序，5更新时间顺序，6更新时间逆序；通过字符串拼接可组合排序，如41表示：权重逆序，创建时间顺序 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0获取成功|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.items | array | 元素列表|
| data.items[].id | int | 元素ID|
| data.items[].key | string | 键名|
| data.items[].data | object | 条目数据|
| data.items[].keyword | string | 关键字|
| data.items[].weight | int | 权重|
| data.items[].add_time | string | 添加时间，格式为：Y-m-d H:i:s|
| data.items[].update_time | string | 最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空|
| data.total | int | 元素总数|
| data.page | int | 当前第几页|
| data.perpage | int | 每页多少个|


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.GetList&key=students&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "id": 65,
                "key": "students",
                "data": {
                    "username": "dogstar",
                    "age": 18
                },
                "keyword": "dogstar",
                "weight": 0,
                "add_time": "2018-07-02 23:28:21",
                "update_time": ""
            },
            {
                "id": 66,
                "key": "students",
                "data": {
                    "username": "yoyo",
                    "age": 18
                },
                "keyword": "yoyo",
                "weight": 0,
                "add_time": "2018-07-02 23:31:57",
                "update_time": ""
            }
        ],
        "total": 2,
        "page": 1,
        "perpage": 10
    },
    "msg": ""
}

<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Set.GetList',array('key'=>'students','app_key'=>'你的app_key'),3000);

// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[0] => Array 
			( 
				[id] => 1 
				[key] => students 
				[data] => Array 
				(
					 [id] => 65 
					 [key] => students 
					 [data] => Array 
					 ( 
					 	[username] => dogstar 
						[age] => 19 
					  ) 
					  [keyword] => dogstar 
					  [weight] => 122 
				)
				 [keyword] => 
				 [weight] => 0 
				 [add_time] => 2019-02-03 01:39:43 
				 [update_time] => 
			) 
		) 
		[total] => 1 
		[page] => 1 
		[perpage] => 10 
	) 
	
	[msg] => 小白开放接口：App.Main_Set.GetList 
)
*/

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0获取成功
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
data.items	字符串	元素列表
data.items[].id	整型	元素ID
data.items[].key	字符串	键名
data.items[].data	对象	条目数据
data.items[].keyword	字符串	关键字
data.items[].weight	整型	权重
data.items[].add_time	字符串	添加时间，格式为：Y-m-d H:i:s
data.items[].update_time	字符串	最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空
data.total	整型	元素总数
data.page	整型	当前第几页
data.perpage	整型	每页多少个
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Query

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Query

接口描述：查根据条件，查询应用集合里的元素列表

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
key	字符串	必须		最小：1；最大：64	集合名称
keyword	字符串	可选		最大：100	待模糊搜索的关键字，不传时不搜索
start_weight	字符串	可选			权重范围，最小权重（包含），不传时不限制
end_weight	字符串	可选			权重范围，最大权重（不包含，即前等后不等），不传时不限制
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：1000	分页数量
sort	字符串	可选	1	最小：1；最大：6	排序，1创建时间顺序，2创建时间逆序, 3权重顺序，4权重逆序，5更新时间顺序，6更新时间逆序；通过字符串拼接可组合排序，如41表示：权重逆序，创建时间顺序

客户端请求示例

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

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


# 【 5907 查询集合列表接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Query`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  查 根据条件，查询应用集合里的元素列表
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Query` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 必填 | 集合名称 |
| keyword | string | 可选 | 待模糊搜索的关键字，不传时不搜索 |
| start_weight | string | 可选 | 权重范围，最小权重（包含），不传时不限制 |
| end_weight | string | 可选 | 权重范围，最大权重（不包含，即前等后不等），不传时不限制 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| sort | string | 可选 | 排序，1创建时间顺序，2创建时间逆序, 3权重顺序，4权重逆序，5更新时间顺序，6更新时间逆序；通过字符串拼接可组合排序，如41表示：权重逆序，创建时间顺序 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0获取成功|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.items | array | 元素列表|
| data.items[].id | int | 元素ID|
| data.items[].key | string | 键名|
| data.items[].data | object | 条目数据|
| data.items[].keyword | string | 关键字|
| data.items[].weight | int | 权重|
| data.items[].add_time | string | 添加时间，格式为：Y-m-d H:i:s|
| data.items[].update_time | string | 最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空|
| data.total | int | 元素总数|
| data.page | int | 当前第几页|
| data.perpage | int | 每页多少个|


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Query&key=students&keyword=dogstar&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "id": 65,
                "key": "students",
                "data": {
                    "username": "dogstar",
                    "age": 18
                },
                "keyword": "dogstar",
                "weight": 0,
                "add_time": "2018-07-02 23:28:21",
                "update_time": ""
            }
        ],
        "total": 1,
        "page": 1,
        "perpage": 10
    },
    "msg": ""
}

接口返回

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	操作码，0获取成功
data.err_msg	字符串	错误提示信息，err_code非0时参考此提示信息
data.items	字符串	元素列表
data.items[].id	整型	元素ID
data.items[].key	字符串	键名
data.items[].data	对象	条目数据
data.items[].keyword	字符串	关键字
data.items[].weight	整型	权重
data.items[].add_time	字符串	添加时间，格式为：Y-m-d H:i:s
data.items[].update_time	字符串	最后更新时间，格式为：Y-m-d H:i:s，若从未更新则为空
data.total	整型	元素总数
data.page	整型	当前第几页
data.perpage	整型	每页多少个
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

接口路径(新)：http://hn.api.yesapi.net/api/App/Main_Set/Clear

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Main_Set.Clear

接口描述：删删除应用集合里的全部的元素

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选		最小：32；最大：32	UUID，全局唯一用户ID
token	字符串	可选		最小：64；最大：64	会话凭证
return_data	字符串	可选			公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
yesapi_allow_origin	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
key	字符串	必须		最小：1；最大：64	待删除的集合名称

客户端请求示例

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

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


# 【 5908 清空集合】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Main_Set.Clear`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  删 删除应用集合里的全部的元素
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Main_Set.Clear` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | UUID，全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| key | string | 必填 | 待删除的集合名称 |


## 返回字段

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


## 请求示例

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

请求：
{你的接口域名}/?s=App.Main_Set.Clear&key=students&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 1
    },
    "msg": "
}

接口返回

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

5901 添加元素接口

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

5902 更新元素接口

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

5903 获取元素接口

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

5904 删除元素接口

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

5905 获取元素总数接口

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

5906 获取集合列表接口

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

5907 查询集合列表接口

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

5908 清空集合

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

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

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

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

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

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

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

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

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