接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Create
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Create
接口描述： 增 在直连数据库表添加一条新数据。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| data | 字符串JSON格式 | 可选 | 创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1701 创建新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Create`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 增 在直连数据库表添加一条新数据。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Create` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中： 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。 静态签名，简单，固定的签名，点击获取。 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。 定制签名，支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |
### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| data | array | 可选 | 创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.Create&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例：
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求：xxx参数错误"
}
```请求（使用data的JSON格式传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.Create&model_name=article&data={"title":"123456"}&database=super&app_key={你的app_key}&sign={接口签名}
请求（使用data_X动态参数传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.Create&model_name=article&data_title=123456&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4
},
"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 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/CheckCreate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.CheckCreate
接口描述： 增 在直连数据库表添加一条【非重复】新数据。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| data | 字符串JSON格式 | 可选 | 创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） | ||
| check_field | 字符串用,分割 | 必须 | 待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。 | ||
| model_return_data | 布尔型 | 可选 | false | 是否返回新创建或原来的数据，model_return_data=1 返回，model_return_data=0 不返回 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1702 创建非重复新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.CheckCreate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 增 在直连数据库表添加一条【非重复】新数据。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.CheckCreate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| data | array | 可选 | 创建时的初始化数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
| check_field | array | 必填 | 待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。 |
| model_return_data | boolean | 可选 | 是否返回新创建或原来的数据，model_return_data=1 返回，model_return_data=0 不返回 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；3、数据已存在，不再创建|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.id | int | 新创建数据的自增ID/或原来数据的ID|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.CheckCreate&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参数错误"
}
```请求（使用data的JSON格式传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.CheckCreate&model_name=article&data={"title":"abc","content":"something"}&check_field=title&database=super&app_key={你的app_key}&sign={接口签名}
请求（使用data_X动态参数传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.CheckCreate&model_name=article&data_title=abc&data_content=something&check_field=title&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4
},
"msg": ""
}
如果数据已经存在，则返回：
{
"ret": 200,
"data": {
"err_code": 3,
"err_msg": "数据已存在，不再创建",
"id": 11
}
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1创建失败(不符合表字段要求，或表字段不存在)；3、数据已存在，不再创建 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.id | 整型 | 新创建数据的自增ID/或原来数据的ID |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiCreate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiCreate
接口描述： 增 批量导入多条新数据，导入完毕后会返回导入的概况
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| datas | 字符串JSON格式 | 必须 | 批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1703 批量创建新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiCreate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 增 批量导入多条新数据，导入完毕后会返回导入的概况
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiCreate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| datas | array | 必填 | 批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.total | int | 本次导入的总数量|
| data.import_num | int | 成功导入的数量|
| data.not_import_num | int | 导入失败的数量|
| data.details | array | 导入过程中的操作纪录|
| data.details[].id | int | 导入的ID，从1开始|
| data.details[].new_id | int | 数据添加成功时的纪录ID，失败时为0|
| data.details[].msg | string | 导入的结果|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiCreate&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.SuperTable.MultiCreate&model_name=article&datas=[{"title":"文章标题1"},{"title":"文章标题2"}]&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 2,
"import_num": 2,
"not_import_num": 0,
"details": [
{
"id": 1,
"new_id": 10,
"msg": "导入成功"
},
{
"id": 2,
"new_id": 11,
"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时参考此提示信息 |
| data.total | 整型 | 本次导入的总数量 |
| data.import_num | 整型 | 成功导入的数量 |
| data.not_import_num | 整型 | 导入失败的数量 |
| data.details | 字符串 | 导入过程中的操作纪录 |
| data.details[].id | 整型 | 导入的ID，从1开始 |
| data.details[].new_id | 整型 | 数据添加成功时的纪录ID，失败时为0 |
| data.details[].msg | 字符串 | 导入的结果 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiFastCreate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiFastCreate
接口描述： 增 批量极速导入多条新数据，速度很快但无明细，此接口可用于批量导入数据，适用于数据初始化和还原。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| datas | 字符串JSON格式 | 必须 | 批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。 | ||
| is_ignore | 布尔型 | 可选 | true | 是否启用IGNORE，1是0否，其中：
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1704 批量极速创建新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiFastCreate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 增 批量极速导入多条新数据，速度很快但无明细，此接口可用于批量导入数据，适用于数据初始化和还原。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiFastCreate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| datas | array | 必填 | 批量导入的数据。特别注意！这是复数datas，即需要传递是的单个创建时的数组的数组。格式为JSON，即：datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。 |
| is_ignore | boolean | 可选 | 是否启用IGNORE，1是0否，其中：若为是，则在创建时判断是否存在相同的数据，并且重复时忽略跳过，最终结果是部分或全部成功创建；若为若，则不管是否存均进行创建，如果有唯一索引或其他原因导致失败将会全部创建不成功。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.total | int | 本次导入的总数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiFastCreate&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例：
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求：xxx参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0导入成功；1导入失败(如表不存在) |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.total | 整型 | 本次导入的总数量 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Update
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Update
接口描述： 改 根据ID，更新直连数据库表的数据，更新的字段需要先存在。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| id | 整型 | 必须 | 最小：1 | 数据ID，例如：1，2，3，…… | |
| data | 字符串JSON格式 | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1705 精确更新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Update`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 根据ID，更新直连数据库表的数据，更新的字段需要先存在。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Update` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| id | int | 必填 | 数据ID，例如：1，2，3，…… |
| data | array | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3更新失败(数据已删除或不存在)|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.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参数错误"
}
```请求（使用data的JSON格式传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.Update&model_name=article&id=5&data={"state":2}&database=super&app_key={你的app_key}&sign={接口签名}
请求（使用data_X动态参数传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.Update&model_name=article&id=5&data_state=2&database=super&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开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3更新失败(数据已删除或不存在) |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiUpdate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiUpdate
接口描述： 改 根据多个ID，批量更新自定义数据表单中的数据，更新的字段需要先存在。对系统保留表字段（id, uuid, add_time, update_time, ext_data）的更新将会被忽略。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| ids | ids | 必须 | 最大：500 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 | |
| data | 字符串JSON格式 | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1706 批量ID更新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiUpdate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 根据多个ID，批量更新自定义数据表单中的数据，更新的字段需要先存在。对系统保留表字段（id, uuid, add_time, update_time, ext_data）的更新将会被忽略。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiUpdate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| ids | ids | 必填 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 |
| data | array | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3更新失败(数据已删除或不存在)|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.update_total | int | 成功更新的数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiUpdate&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.SuperTable.MultiUpdate&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_total": 2
},
"msg": "小白开放接口：App.SuperTable.MultiUpdate"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记；3更新失败(数据已删除或不存在) |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.update_total | 整型 | 成功更新的数量 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeUpdate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeUpdate
接口描述： 改 功能更强大的更新操作，可以根据自定义的多个条件（AND或者OR），更新指定的数据。为防止误更新全表数据，必须至少有一个有效条件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| data | 字符串JSON格式 | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1707 自由更新数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeUpdate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 功能更强大的更新操作，可以根据自定义的多个条件（AND或者OR），更新指定的数据。为防止误更新全表数据，必须至少有一个有效条件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeUpdate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| data | array | 可选 | 待更新的数据，需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3无数据更新|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.update_rows | int | 更新的行数，0表示无任何更新|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeUpdate&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参数错误"
}
```请求（使用data的JSON格式传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeUpdate&model_name=article&where=[["title","=","123456"]]&data={"title":"654321"}&database=super&app_key={你的app_key}&sign={接口签名}
请求（使用data_X动态参数传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeUpdate&model_name=article&where_title=123456&data_title=654321&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_rows": 1
},
"msg": ""
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，更新失败(不符合表字段要求，或表字段不存在)；3无数据更新 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.update_rows | 整型 | 更新的行数，0表示无任何更新 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Get
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Get
接口描述： 查 根据ID，获取直连数据库表中的数据
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| id | 整型 | 必须 | 最小：1 | 数据ID，例如：1，2，3，…… |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1708 精确取数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Get`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 根据ID，获取直连数据库表中的数据
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Get` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| id | int | 必填 | 数据ID，例如：1，2，3，…… |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；3获取失败(数据已删除或不存在)|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 获取的数据，并返回全部字段的数据|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.Get&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.SuperTable.Get&model_name=article&id=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": 1,
"uuid": "",
"add_time": "2017-11-23 23:35:13",
"update_time": "2018-06-27 22:27:18",
"ext_data": null,
"title": "PHP程序员历险记",
"content": "PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。PHP<a>test</a>（外文名:PHP: Hypertext Preprocessor，中文名：“超文本预处理器”）是一种通用开源脚本语言。",
"post_time": "1970-01-01 00:00:00",
"view_times": "5",
"state": "1"
}
},
"msg": ""
}| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；3获取失败(数据已删除或不存在) |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 获取的数据，并返回全部字段的数据 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiGet
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiGet
接口描述： 查 根据批量ID，批量获取自定义数据表单中的数据
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| ids | ids | 必须 | 最大：500 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1709 批量ID取数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiGet`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 根据批量ID，批量获取自定义数据表单中的数据
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiGet` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| ids | ids | 必填 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.list | array | 获取的数据，没有任何数据时为空数组，如果未找到ID对应的数据则没有任何元素|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiGet&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.SuperTable.MultiGet&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"list": [
{
"id": 36,
"uuid": "",
"add_time": "2019-04-06 17:25:13",
"update_time": "2019-05-01 20:49:53",
"ext_data": null,
"title": "PHP程序员历险记223",
"content": "<p><em>PHP</em>（外文名:<em>PHP</em>: Hypertext Preprocessor，中文名：“超文本预处理器”）</p>",
"post_time": "2020-07-29 06:30:00",
"view_times": "0",
"state": "0",
"test_time": "2019-04-06 17:25:13",
"zhaiyao": ""
},
{
"id": 37,
"uuid": "",
"add_time": "2019-06-07 10:00:23",
"update_time": null,
"ext_data": null,
"title": "来吧~",
"content": null,
"post_time": "1970-01-01 00:00:00",
"view_times": "0",
"state": "0",
"test_time": "2019-06-07 10:00:23",
"zhaiyao": "来吧~"
}
]
},
"msg": "小白开放接口：App.SuperTable.MultiGet"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(符合表字段要求，或表字段不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.list | 字符串 | 获取的数据，没有任何数据时为空数组，如果未找到ID对应的数据则没有任何元素 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Delete
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Delete
接口描述： 删 根据ID，删除直连数据库表中的数据
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| id | 整型 | 必须 | 最小：1 | 数据ID，例如：1，2，3，…… |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1710 精确删除数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Delete`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 删 根据ID，删除直连数据库表中的数据
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Delete` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| id | int | 必填 | 数据ID，例如：1，2，3，…… |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.SuperTable.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.SuperTable.Delete&model_name=article&id=4&database=super&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密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiDelete
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiDelete
接口描述： 删 根据多个ID，批量删除自定义数据表单中的数据
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| ids | ids | 必须 | 最大：500 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1711 批量ID删除数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiDelete`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 删 根据多个ID，批量删除自定义数据表单中的数据
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiDelete` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| ids | ids | 必填 | 多个ID，使用英文逗号分割，例如：ids=1,2,3 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功删除；1开发类错误，删除失败(表单不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiDelete&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.SuperTable.MultiDelete&model_name=article&ids=36,37&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "小白开放接口：App.SuperTable.MultiDelete"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功删除；1开发类错误，删除失败(表单不存在)；2应用层规则拦截，拦截后可以小白开放平台查看日记 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Count
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Count
接口描述： 查 获取直连数据库表中数据的总条目数量
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1712 获取总数接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Count`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 获取直连数据库表中数据的总条目数量
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Count` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.total | int | 数据的总条目数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.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.SuperTable.Count&model_name=article&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 2
},
"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.total | 整型 | 数据的总条目数量 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeAF
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeAF
接口描述： 查 可以根据自定义的多个条件（AND或者OR），进行GROUP聚合操作运算
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| op_fun | 枚举类型 | 必须 | SUM | 范围：SUM/COUNT/MIN/MAX/AVG | 聚合函数操作 |
| op_field | 字符串 | 必须 | 进行聚合的字段名称，例如：SUM(price)中的price价格字段 | ||
| group_filed | 字符串用,分割 | 必须 | 分组字段，多个分组字段使用英文逗号分割，相当于：GROUP BY {group_filed} | ||
| sort_type | 整型 | 可选 | 1 | 排序的类型：1是聚合结果升序（默认）；2是聚合结果逆序；3是分组字段升序；4是分组字段降序 | |
| page | 整型 | 可选 | 1 | 最小：1 | 第几页 |
| top_num | 整型 | 可选 | 10 | 最小：1；最大：500 | 返回结果的数量，前面多少条 |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| select_more | 字符串用,分割 | 可选 | 需要选择的更多字段，默认已经固定返回{groupField}参数字段和聚合结果这两个字段。多个字段用英文逗号分割，如：select_more=id,uuid。如果需要再进行聚合运算，可以类似这样：select_more=id@MIN,uuid。即：字段@聚合运算。聚合运算主要有：SUM/COUNT/MIN/MAX/AVG。id@MIN 对应返回的字段名是 id_AT_MIN，name@COUNT 对应返回字段是 name_AT_COUNT，依次类似。即对应字段格式是：字段_AT_聚合运算。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1713 分组聚合接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeAF`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），进行GROUP聚合操作运算
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeAF` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| op_fun | enum | 必填 | 聚合函数操作 |
| op_field | string | 必填 | 进行聚合的字段名称，例如：SUM(price)中的price价格字段 |
| group_filed | array | 必填 | 分组字段，多个分组字段使用英文逗号分割，相当于：GROUP BY {group_filed} |
| sort_type | int | 可选 | 排序的类型：1是聚合结果升序（默认）；2是聚合结果逆序；3是分组字段升序；4是分组字段降序 |
| page | int | 可选 | 第几页 |
| top_num | int | 可选 | 返回结果的数量，前面多少条 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| select_more | array | 可选 | 需要选择的更多字段，默认已经固定返回{groupField}参数字段和聚合结果这两个字段。多个字段用英文逗号分割，如：select_more=id,uuid。如果需要再进行聚合运算，可以类似这样：select_more=id@MIN,uuid。即：字段@聚合运算。聚合运算主要有：SUM/COUNT/MIN/MAX/AVG。id@MIN 对应返回的字段名是 id_AT_MIN，name@COUNT 对应返回字段是 name_AT_COUNT，依次类似。即对应字段格式是：字段_AT_聚合运算。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.items | array | 聚合运算的结果|
| data.items[].XXX | string | 分组字段，由客户端传入的字段而定|
| data.items[].total_num | string | 聚合运算的结果（固定为：total_num）|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeAF&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where=[["id",">",0]]&database=super&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where_id=GT-0&database=super&app_key={你的app_key}&sign={接口签名}
上面查询相当于，SELECT title, SUM(view_times) AS total_num FROM article WHERE id > 0 GROUP BY title ORDER BY total_num ASC LIMIT 0,10
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"title": "这是一篇文章标题",
"total_num": "100"
},
{
"title": "这又是另一篇文章标题",
"total_num": "200"
},
// 略……
]
},
"msg": ""
}
示例2-附加更多选择字段select_more：
请求：
{你的接口域名}/?s=App.SuperTable.FreeAF&model_name=article&op_fun=SUM&op_field=view_times&group_filed=title&where=[["id",">",0]]&select_more=post_time,state@COUNT&database=super&app_key={你的app_key}&sign={接口签名}
上面查询相当于：SELECT post_time, COUNT(state) AS state_AT_COUNT, title, SUM(view_times) AS total_num FROM pa_article_tbl WHERE AND (id > 0) GROUP BY title ORDER BY total_num ASC LIMIT 0,10
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"post_time": "1970-01-01 00:00:00", // 对应参数：select_more=post_time
"state_AT_COUNT": "1", // 对应参数：select_more=state@COUNT
"title": "这是一篇文章标题",
"total_num": "100"
},
{
"post_time": "1970-01-01 00:00:00",
"state_AT_COUNT": "1",
"title": "这又是另一篇文章标题",
"total_num": "200"
},
// 略……
]
},
"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.items | 字符串 | 聚合运算的结果 |
| data.items[].XXX | 字符串 | 分组字段，由客户端传入的字段而定 |
| data.items[].total_num | 字符串 | 聚合运算的结果（固定为：total_num） |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeCount
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeCount
接口描述： 查 可以根据自定义的多个条件（AND或者OR），获取总数
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| count_by | 字符串 | 可选 | 需要非重复计数的字段，默认统计全部行数，若传字段则按些字段的非重复数据进行统计，相当于：COUNT(DISTINCT {count_by})。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1714 自由获取总数接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeCount`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），获取总数
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeCount` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| count_by | string | 可选 | 需要非重复计数的字段，默认统计全部行数，若传字段则按些字段的非重复数据进行统计，相当于：COUNT(DISTINCT {count_by})。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.total | int | 数据的总条目数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeCount&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": "",
"total": 3
},
"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.total | 整型 | 数据的总条目数量 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeQuery
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeQuery
接口描述： 查 分页获取列表数据或全部数据，支持字段选择、排序、条件查询，功能强大，是最为常用的数据接口。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| select | 字符串用,分割 | 可选 | SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid | ||
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| order | 字符串JSON格式 | 可选 | [] | SQL语句的ORDER部分，JSON格式。具体格式为：[第一组排序，第二组排序，……]，可以单个或组合排序。 每一组排序格式为："字段名 + 空格 + ASC|DESC"，其中：
例2：组合排序，order=["id DESC", "add_time ASC"]，表示id DESC, add_time ASC，即先按ID从大到小，再按创建时间倒序排序。 特别地，RAND表示随机排序，请慎用。 | |
| page | 整型 | 可选 | 1 | 最小：1 | 第几页 |
| perpage | 整型 | 可选 | 10 | 最小：1；最大：10000 | 分页数量 |
| is_real_total | 布尔型 | 可选 | true | 是否需要真正的总数，1是0否，当表单数据过多时，如果不需要查询真正的总数，将能极大提升接口响应的速度。若为假总数，固定返回9999999。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1715 分页查询列表数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeQuery`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 分页获取列表数据或全部数据，支持字段选择、排序、条件查询，功能强大，是最为常用的数据接口。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeQuery` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| select | array | 可选 | SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| order | array | 可选 | SQL语句的ORDER部分，JSON格式。具体格式为：[第一组排序，第二组排序，……]，可以单个或组合排序。每一组排序格式为："字段名 + 空格 + ASC|DESC"，其中：ASC：为指定列按升序排列DESC：为指定列按降序排列。例1：单个排序，order=["id DESC"]，表示按ID降序，即最新的在最前面。例2：组合排序，order=["id DESC", "add_time ASC"]，表示id DESC, add_time ASC，即先按ID从大到小，再按创建时间倒序排序。特别地，RAND表示随机排序，请慎用。 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| is_real_total | boolean | 可选 | 是否需要真正的总数，1是0否，当表单数据过多时，如果不需要查询真正的总数，将能极大提升接口响应的速度。若为假总数，固定返回9999999。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.total | int | 数据的总条目数量|
| data.list | array | 查询的结果列表数据|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeQuery&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeQuery&model_name=article&select=id,title,view_times&where=[["id", ">", "36"]]&order=["view_times DESC"]&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeQuery&model_name=article&select=id,title,view_times&where_id=GT-36&order=["view_times DESC"]&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 2,
"list": [
{
"id": 37,
"title": "小白开放平台更新公告",
"view_times": 300
},
{
"id": 38,
"title": "新接口上线通知",
"view_times": 260
}
],
"page": 1,
"perpage": 10
},
"msg": "小白开放接口：App.SuperTable.FreeQuery"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)； |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.total | 整型 | 数据的总条目数量 |
| data.list | 字符串 | 查询的结果列表数据 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeExport
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeExport
接口描述： 查 可以根据自定义的多个条件（AND或者OR），进行数据导出。成功导出时，此接口会直接生成可供下载的txt或csv文件。个人免费版最多导出5000条，VIP版最多可导出1万条，SVIP版最多可导出2万条。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| select | 字符串用,分割 | 可选 | SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid | ||
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| order | 字符串JSON格式 | 可选 | [] | SQL语句的ORDER部分，JSON格式。具体格式为：[第一组排序，第二组排序，……]，如：order = ["id DESC", "add_time ASC"]，表示 id DESC, add_time ASC。特别地，RAND表示随机排序，请慎用。 | |
| file_type | 枚举类型 | 可选 | txt | 范围：csv/txt/excel | 下载文件的类型，txt或csv或excel。 |
| sep | 字符串 | 可选 | , | 数据分割符，@TAB则表示水平制表符。 | |
| encoding | 枚举类型 | 可选 | UTF-8 | 范围：UTF-8/GB2312 | 导出的CSV/TXT/Excel文件编码，如果需要ANSI格式可使用encoding=GB2312。 |
| page | 整型 | 可选 | 1 | 最小：1 | 第几页 |
| perpage | 整型 | 可选 | 1000 | 最小：0；最大：150000 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1716 全量数据导出TXT或CSV接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeExport`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），进行数据导出。成功导出时，此接口会直接生成可供下载的txt或csv文件。个人免费版最多导出5000条，VIP版最多可导出1万条，SVIP版最多可导出2万条。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeExport` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| select | array | 可选 | SQL语句的SELECT部分，多个字段用英文逗号分割，如：select=id,uuid |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| order | array | 可选 | SQL语句的ORDER部分，JSON格式。具体格式为：[第一组排序，第二组排序，……]，如：order = ["id DESC", "add_time ASC"]，表示 id DESC, add_time ASC。特别地，RAND表示随机排序，请慎用。 |
| file_type | enum | 可选 | 下载文件的类型，txt或csv或excel。 |
| sep | string | 可选 | 数据分割符，@TAB则表示水平制表符。 |
| encoding | enum | 可选 | 导出的CSV/TXT/Excel文件编码，如果需要ANSI格式可使用encoding=GB2312。 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeExport&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例：
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求：xxx参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/ChangeNumber
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.ChangeNumber
接口描述： 改 根据ID，修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| id | 整型 | 必须 | 最小：1 | 数据ID | |
| change_field | 字符串 | 必须 | 待修改数值的字段名 | ||
| change_value | 字符串 | 必须 | 待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1717 精确更改数值接口(可加可减)[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.ChangeNumber`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 根据ID，修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.ChangeNumber` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| id | int | 必填 | 数据ID |
| change_field | string | 必填 | 待修改数值的字段名 |
| change_value | string | 必填 | 待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；3数据不存在或已被删除|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.change_value | string | 回传客户端本次待更改的数值|
| data.after_value | string | 本次更新后，最新的字段值|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.ChangeNumber&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.SuperTable.ChangeNumber&model_name=article&id=8&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_value": "1",
"after_value": "5"
},
"msg": ""
}| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)；3数据不存在或已被删除 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.change_value | 字符串 | 回传客户端本次待更改的数值 |
| data.after_value | 字符串 | 本次更新后，最新的字段值 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeChangeNumber
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeChangeNumber
接口描述： 改 可以根据自定义的多个条件（AND或者OR），修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。注意，此接口可更新多条数据。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| change_field | 字符串用,分割 | 必须 | 待修改数值的字段名，多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
| change_value | 字符串用,分割 | 必须 | 待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值。多个数值用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
| try_add_data | 字符串JSON格式 | 可选 | 当无更新时尝试创建的数据，仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。此参数只用于初始化，不会再进行change_value的修改。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1718 自由更改数值接口(可加可减)[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeChangeNumber`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 可以根据自定义的多个条件（AND或者OR），修改某个字段的数值，可增加或可减少。通过在服务端进行数值的叠加，尽量保持并发下的数据一致性。注意，此接口可更新多条数据。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeChangeNumber` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| change_field | array | 必填 | 待修改数值的字段名，多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。 |
| change_value | array | 必填 | 待叠加的数值，正数表示相加，负数表示相减，需要传递有效数值。多个数值用英文逗号分割。change_value和change_field分割后的数量应当相同。 |
| try_add_data | array | 可选 | 当无更新时尝试创建的数据，仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。此参数只用于初始化，不会再进行change_value的修改。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.change_value | string | 回传客户端本次待更改的数值|
| data.update_rows | string | 本次更新的条数，没有更新时为0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeChangeNumber&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.SuperTable.FreeChangeNumber&model_name=article&where=[["id","=",8]]&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_value": "1",
"update_rows": 1
},
"msg": ""
}
如果想希望在更新失败时进行数据创建，可以使用try_add_data参数，从而减少多一次接口请求，以完成数据初始化操作。登录，请求：
{你的接口域名}/?s=App.SuperTable.FreeChangeNumber&model_name=article&logic=and&where=[["id", "=", "404"]]&change_field=view_times&change_value=2&try_add_data={"view_times":1}&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_value": "1",
"update_rows": 1
},
"msg": "V1.3.16 小白开放接口 App.SuperTable.FreeChangeNumber"
}
这里接口结果返回的change_value对应本次try_add_data里面的初始化值。
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，修改失败(表单不存在或字段类型不是数值类型)； |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.change_value | 字符串 | 回传客户端本次待更改的数值 |
| data.update_rows | 字符串 | 本次更新的条数，没有更新时为0 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeFindOne
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeFindOne
接口描述： 查 可以根据自定义的多个条件（AND或者OR），查找获取一条数据
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| fields | 字符串用,分割 | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1719 自由获取一条数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeFindOne`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），查找获取一条数据
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeFindOne` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| fields | array | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 获取的数据，可以指定返回字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeFindOne&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeFindOne&model_name=article&where=[["title","=","123456"]]&database=super&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeFindOne&model_name=article&where_title=123456&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "5",
"uuid": "",
"add_time": "2018-06-27 22:13:28",
"update_time": null,
"ext_data": null,
"title": "123456",
"content": null,
"post_time": "1970-01-01 00:00:00",
"view_times": "0"
}
},
"msg": "",
"info": [
"当前请求接口：App.SuperTable.FreeFindOne",
"小白入门教程：a.okayapi.com/Aa5PH4"
]
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 获取的数据，可以指定返回字段 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/GetDataAfterChangeNum
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.GetDataAfterChangeNum
接口描述： 查改 可以根据自定义的多个条件（AND或者OR），查找获取一条数据，然后对指定的字段进行加减操作，最后返回最新的数据。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| fields | 字符串用,分割 | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time | ||
| order | 字符串 | 可选 | id ASC | 排序规则，格式：字段名+空格+ASC|DESC，特别地，RAND表示随机排序。 | |
| change_field | 字符串 | 必须 | 待加减的字段名 | ||
| change_value | 字符串 | 必须 | 待加减的数字，正数表示相加，负数表示相减，需要传递有效数值。例如：change_value=1 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1720 加减后返回数据[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.GetDataAfterChangeNum`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查改 可以根据自定义的多个条件（AND或者OR），查找获取一条数据，然后对指定的字段进行加减操作，最后返回最新的数据。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.GetDataAfterChangeNum` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| fields | array | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
| order | string | 可选 | 排序规则，格式：字段名+空格+ASC|DESC，特别地，RAND表示随机排序。 |
| change_field | string | 必填 | 待加减的字段名 |
| change_value | string | 必填 | 待加减的数字，正数表示相加，负数表示相减，需要传递有效数值。例如：change_value=1 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 返回加减后的数据，没有数据时返回null；修改成功时固定会返回修改的字段更新后的最新值|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.GetDataAfterChangeNum&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.SuperTable.GetDataAfterChangeNum&model_name=article&logic=and&where=[["id", ">", "1"]]&fields=add_time&order=id asc&change_field=view_times&change_value=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"view_times": 204,
"add_time": "2019-04-06 17:25:13"
},
"total": 23
},
"msg": "V2.1.0 果创云开放接口 App.SuperTable.GetDataAfterChangeNum"
}
以上会把article文章表单的某一篇文章的阅读数view_times加1，然后返回最新的数据。
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 返回加减后的数据，没有数据时返回null；修改成功时固定会返回修改的字段更新后的最新值 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeRandOne
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeRandOne
接口描述： 查 可以根据自定义的多个条件（AND或者OR），随机获取一条数据。获取数据后不会修改或删除数据。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id",">",0]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| fields | 字符串用,分割 | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1721 随机获取一条数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeRandOne`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），随机获取一条数据。获取数据后不会修改或删除数据。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeRandOne` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| fields | array | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 获取的数据，可以指定返回字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeRandOne&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例：
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求：xxx参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 获取的数据，可以指定返回字段 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreePopOne
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreePopOne
接口描述： 查改 可以根据自定义的多个条件（AND或者OR），查找获取一条数据，并且在获取数据后更改字段，从而实现非重复数据的获取
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| fields | 字符串用,分割 | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time | ||
| data | 字符串JSON格式 | 可选 | 待更新的数据（注意！获取到数据后将会进行此更新），需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） | ||
| data_X | 字符串 | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） | ||
| order_type | 整型 | 可选 | 1 | 排序类型，默认order_type=1，表示按默认的顺序，即ID升序；order_type=2时表示ID降序；order_type=3表示随机排序，将能更好地实现高并发下的非重复获取（为保证接口质量，随机排序取的数据量超过10W，请联系小白客服进行定制化！）；order_type=4表示更新时间update_time升序；order_type=5表示更新时间update_time降序； |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1722 “阅后即焚”接口(专取非重复数据)[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreePopOne`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查改 可以根据自定义的多个条件（AND或者OR），查找获取一条数据，并且在获取数据后更改字段，从而实现非重复数据的获取
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreePopOne` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| fields | array | 可选 | 需要返回的字段名，多个字段用英文逗号分割，示例：fields=id,uuid,add_time |
| data | array | 可选 | 待更新的数据（注意！获取到数据后将会进行此更新），需要JSON编码后传递。格式：data={"字段名1":"字段值1","字段名2":"字段值2"...}。JSON在线解析及格式化验证（data和data_X二选一） |
| data_X | string | 可选 | 动态参数，优先于data的JSON数据。可自由传入动态参数，字段名组合格式：data_ + X（X要换成你的字段名），例如数据表单标题title字段，组合后为：&data_title=YesApi，等效于：&data={"title":"YesApi"}。可以同时传入多个动态参数，例如：&data_title=YesApi&data_year=2020，比JSON格式更方便（data和data_X二选一） |
| order_type | int | 可选 | 排序类型，默认order_type=1，表示按默认的顺序，即ID升序；order_type=2时表示ID降序；order_type=3表示随机排序，将能更好地实现高并发下的非重复获取（为保证接口质量，随机排序取的数据量超过10W，请联系小白客服进行定制化！）；order_type=4表示更新时间update_time升序；order_type=5表示更新时间update_time降序； |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 获取的数据，可以指定返回字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreePopOne&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参数错误"
}
```请求（使用data的JSON格式传递，data和data_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreePopOne&model_name=article&where=[["state", "=", 0]]&data={"state":1}&database=super&app_key={你的app_key}&sign={接口签名}
请求（使用data_X动态参数传递，data和data_X二选一）（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreePopOne&model_name=article&where_state=0&data_state=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "2",
"uuid": "",
"add_time": "2018-04-09 23:42:25",
"update_time": ,
"ext_data": ,
"title": "xx",
"content": "yy",
"post_time": "1970-01-01 00:00:00",
"view_times": "2",
"state": "0"
}
},
"msg": ""
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 获取的数据，可以指定返回字段 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/DropOneByOne
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.DropOneByOne
接口描述： 查删 根据主键id从小到大依次获取数据，取完就立即删除，从而实现非重复数据的获取。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1723 即用即删接口(专取非重复数据)[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.DropOneByOne`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查删 根据主键id从小到大依次获取数据，取完就立即删除，从而实现非重复数据的获取。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.DropOneByOne` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据；4并发太大，请稍候重试！|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.data | object | 获取到的非重复数据，即整条纪录数据。|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.DropOneByOne&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.SuperTable.DropOneByOne&model_name=article&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "1",
"uuid": "",
"title": "小接口做大事情！",
"add_time": "2019-01-26 18:04:30"
}
},
"msg": ""
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据；4并发太大，请稍候重试！ |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.data | 对象 | 获取到的非重复数据，即整条纪录数据。 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeMin
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeMin
接口描述： 查 可以根据自定义的多个条件（AND或者OR），获取某个字段的最小值
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| field | 字符串 | 必须 | 取哪个字段的最小值，如：field=id |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1724 自由获取最小值接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeMin`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），获取某个字段的最小值
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeMin` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| field | string | 必填 | 取哪个字段的最小值，如：field=id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.min | string | 获取的最小值|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeMin&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeMin&model_name=article&where=[["id", "<", 3]]&field=view_times&database=super&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeMin&model_name=article&where_id=LT-3&field=view_times&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"min": "2"
},
"msg": ""
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.min | 字符串 | 获取的最小值 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeMax
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeMax
接口描述： 查 可以根据自定义的多个条件（AND或者OR），获取某个字段的最大值
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| field | 字符串 | 必须 | 取哪个字段的最大值，如：field=id |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1725 自由获取最大值接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeMax`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），获取某个字段的最大值
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeMax` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| field | string | 必填 | 取哪个字段的最大值，如：field=id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.min | string | 获取的最大值|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeMax&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.SuperTable.FreeMax&model_name=article&where=[["id", "<", 3]]&field=view_times&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"max": "5"
},
"msg": ""
}| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.min | 字符串 | 获取的最大值 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeSum
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeSum
接口描述： 查 可以根据自定义的多个条件（AND或者OR），计算某个字段的总和
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| field | 字符串 | 必须 | 取哪个字段的总和，如：field=money |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1726 自由求和接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeSum`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以根据自定义的多个条件（AND或者OR），计算某个字段的总和
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeSum` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| field | string | 必填 | 取哪个字段的总和，如：field=money |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.sum | string | 总和|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeSum&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeSum&model_name=article&logic=or&where=[["id","=",1],["id","=",5]]&field=view_times&database=super&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeSum&model_name=article&logic=or&where_id=1||5&field=view_times&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"sum": "5"
},
"msg": ""
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误，获取失败(表单不存在)；3查无数据 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.sum | 字符串 | 总和 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeDelete
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeDelete
接口描述： 删 可以根据自定义的多个条件（AND或者OR），删除多条数据。数据一旦删除，无法恢复，请谨慎操作！
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| max_delete_num | 整型 | 可选 | 0 | 最小：0 | 最多删除多少条，0表示无限制，即全部删除 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1727 自由删除数据接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeDelete`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 删 可以根据自定义的多个条件（AND或者OR），删除多条数据。数据一旦删除，无法恢复，请谨慎操作！
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeDelete` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| max_delete_num | int | 可选 | 最多删除多少条，0表示无限制，即全部删除 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.delete_total | int | 删除的条目数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeDelete&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参数错误"
}
```请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeDelete&model_name=article&where=[["id","=",4]]&max_delete_num=1&database=super&app_key={你的app_key}&sign={接口签名}
请求（where和where_X二选一）：
{你的接口域名}/?s=App.SuperTable.FreeDelete&model_name=article&where_id=4&max_delete_num=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"delete_total": 0
},
"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.delete_total | 整型 | 删除的条目数量 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/FreeMultiCal
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.FreeMultiCal
接口描述： 改 根据条件，批量进行四则运算，即：加/减/乘/除。例如，field=x，op=add，number=1，组合起来表示：x=x+1。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| logic | 枚举类型 | 可选 | and | 范围：and/or | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中：
写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求：
以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 | |
| where_X | 字符串 | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下：
||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） | ||
| field | 字符串 | 必须 | 待更新的字段，如：field=money，此字段必须为数值类型 | ||
| op | 枚举类型 | 必须 | 范围：add/sub/mul/div | 运算符号，加：add，减：sub，乘：mul，乘：div | |
| number | 字符串 | 必须 | 待运算的数字，例如加多少，减多少，乘多少，除多少。必须为合法的数字，可以是小数 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1728 批量四则运算接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.FreeMultiCal`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 根据条件，批量进行四则运算，即：加/减/乘/除。例如，field=x，op=add，number=1，组合起来表示：x=x+1。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.FreeMultiCal` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| logic | enum | 可选 | where条件的逻辑组合，logic=and表示逻辑且，logic=or表示逻辑或 |
| where | array | 可选 | SQL语句的WHERE查询条件，JSON格式，格式为：[第一组条件, 第二组条件, ……]。（where和where_X二选一，不可混用，以where_X优先） 写法1：每一组的条件格式为：["字段名", "比较符", "比较值"]，其中： 字段名：表单结构中存在的字段，或表字段 比较符：比较符号可以是>、>=、<、<=、<>、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值：需要比较的值，不同比较符的比较值格式会有所不同。如果字段是数值类型，请传递数值类型，不要用字符串。 示例：当logic=and, where=[["id",">",9],["id","<=",10]]，则表示：id > 9 AND id <= 10。 写法2（Beta）：每一组的条件格式可以为：MySQL条件字符串，支持嵌套、组合、函数等，功能更强大，组合更灵活，但要求： 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用，并且使用静态参数，开启接口签名，以防SQL注入攻击 示例：当logic=and, where=["id > 9", "id <= 10"]，则表示：id > 9 AND id <= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入，请用写法1；如果需要更强大的条件组合，并且是固定参数条件时，可用写法2。更多示例说明请参考WHERE参数介绍。 |
| where_X | string | 可选 | 动态条件，优先于where的JSON数据，简化的where条件，更易使用但只支持部分比较符。条件格式：where_ + X（X要换成你的字段名） = 比较符（见下方） + 中横线（-） + 比较值。支持的比较符和示例如下： EQ：等于（默认），如：where_year=EQ-2020，或：where_year=2020，表示年份year等于2020； GT：大于，如：where_year=GT-2020，表示年份year大于2020； GE：大于等于，如：where_year=GE-2020，表示年份year大于或等于2020； LT：小于，如：where_year=LT-2020，表示年份year小于2020； LE：大于等于，如：where_year=LE-2020，表示年份year小于或等于2020； NE：不等于，如：where_year=NE-2020，表示年份year不等于2020； LIKE：模糊匹配，如：where_name=LIKE-小白，表示名字name含有小白的； NLIKE：模糊匹配（排除），如：where_name=NLIKE-小白，表示名字name不包含小白的 IN：枚举查询，如：where_year=IN-2020,2021,2022，表示年份year在这三个年份，多个值用英文逗号分割 NIN：枚举查询（排除），如：where_year=NIN-2020,2021,2022，表示年份year不在这三个年份，多个值用英文逗号分割 如果同一字段有多个条件，使用双竖线||分割，如：where_year=GT-2000||LT-2020，表示year年份大于2020（logic=and或logic=or）小于2020。（where和where_X二选一，不可混用，以where_X优先） |
| field | string | 必填 | 待更新的字段，如：field=money，此字段必须为数值类型 |
| op | enum | 必填 | 运算符号，加：add，减：sub，乘：mul，乘：div |
| number | 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时参考此提示信息|
| data.update_rows | string | 本次更新的条数，没有更新时为0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.FreeMultiCal&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.SuperTable.FreeMultiCal&model_name=article&where=[["id","=","1"]]&field=view_times&op=add&number=1&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_rows": 1
},
"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.update_rows | 字符串 | 本次更新的条数，没有更新时为0 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/Desc
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.Desc
接口描述： 查 利用DESC命令查看某个表的结构
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1730 查看表结构[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.Desc`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 利用DESC命令查看某个表的结构
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.Desc` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.desc | array | 表结构描述|
| data.desc[].Field | string | 字段名称|
| data.desc[].Type | string | 字段类型，例如：int(11)|
| data.desc[].Collation | string | 字段编码，例如：utf8mb4_general_ci|
| data.desc[].Null | string | 是否允许为空，YES/NO|
| data.desc[].Key | string | 字段索引，空/PRI/NOR|
| data.desc[].Default | string | 默认值|
| data.desc[].Extra | string | 额外信息，例如：auto_increment|
| data.desc[].Comment | string | 字段注释|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.Desc&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.SuperTable.Desc&model_name=okayapi&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"desc": [
{
"Field": "id",
"Type": "int(11)",
"Null": "NO",
"Key": "PRI",
"Default": ,
"Extra": "auto_increment",
"Collation": "",
"Comment": "注释"
},
{
"Field": "OKAYAPI",
"Type": "varchar(1024)",
"Null": "YES",
"Key": "",
"Default": ,
"Extra": "",
"Collation": "",
"Comment": "注释"
}
]
},
"msg": "当前请求接口：App.SuperTable.Desc"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.desc | 字符串 | 表结构描述 |
| data.desc[].Field | 字符串 | 字段名称 |
| data.desc[].Type | 字符串 | 字段类型，例如：int(11) |
| data.desc[].Collation | 字符串 | 字段编码，例如：utf8mb4_general_ci |
| data.desc[].Null | 字符串 | 是否允许为空，YES/NO |
| data.desc[].Key | 字符串 | 字段索引，空/PRI/NOR |
| data.desc[].Default | 字符串 | 默认值 |
| data.desc[].Extra | 字符串 | 额外信息，例如：auto_increment |
| data.desc[].Comment | 字符串 | 字段注释 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/ICanDoIt
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.ICanDoIt
接口描述： 改 可以执行原始的SQL语句进行数据库变更，例如建表、加字段、加索引、改字段等。你可以通过配置小白直连数据库账号的权限来控制允许进行哪些变更。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 此时的表名可任意指定一个 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| sql | 字符串 | 必须 | 待执行的任意SQL语句，须符合MySQL数据库语法，请谨慎操作 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1731 万能变更接口[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.ICanDoIt`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 可以执行原始的SQL语句进行数据库变更，例如建表、加字段、加索引、改字段等。你可以通过配置小白直连数据库账号的权限来控制允许进行哪些变更。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.ICanDoIt` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 此时的表名可任意指定一个 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| sql | string | 必填 | 待执行的任意SQL语句，须符合MySQL数据库语法，请谨慎操作 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.sql | array | 返回本次成功执行SQL语句|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.ICanDoIt&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参数错误"
}
```请求（注意sql参数的语法、编码和特殊字符，推荐用POST方式）：
{你的接口域名}/?s=App.SuperTable.ICanDoIt&model_name=OKAYAPI&database=super&sql=ALTER TABLE okayapi ADD COLUMN test_name VARCHAR(10)&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"sql": "ALTER TABLE okayapi ADD COLUMN test_name5 VARCHAR(10)"
},
"msg": "当前请求接口：App.SuperTable.ICanDoIt"
}| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 状态操作码，0成功；1开发类错误 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.sql | 字符串 | 返回本次成功执行SQL语句 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/SqlQuery
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.SqlQuery
接口描述： 查 可以通过原始SQL语句，查询数据库，并返回全部结果集。你可以通过配置小白直连数据库账号的权限来控制允许查询哪些表。注意查询的结果不要过大，以免卡死！
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 此时的表名可任意指定一个 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| sql | 字符串 | 必须 | 待查询的完整SQL语句，须符合MySQL数据库语法，只支持SELECT系列的操作。推荐此参数使用POST方式，若使用GET方式须进行URL编码，以免解析出错 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1732 通过原始SQL查库[直连版]】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.SqlQuery`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 可以通过原始SQL语句，查询数据库，并返回全部结果集。你可以通过配置小白直连数据库账号的权限来控制允许查询哪些表。注意查询的结果不要过大，以免卡死！
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.SqlQuery` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 此时的表名可任意指定一个 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| sql | string | 必填 | 待查询的完整SQL语句，须符合MySQL数据库语法，只支持SELECT系列的操作。推荐此参数使用POST方式，若使用GET方式须进行URL编码，以免解析出错 |
| is_test_connect | 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.sql | array | 返回本次成功查询的结果|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.SqlQuery&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.SuperTable.SqlQuery&model_name=okayapi&sql=select id,username,time from okayapi_test limit 0, 3&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"sql": [
{
"id": "1",
"username": "dogstar1",
"time": "2018-04-09 20:40:20"
},
{
"id": "2",
"username": "dogstar2",
"time": "2018-04-09 20:40:20"
},
{
"id": "3",
"username": "dogstar3",
"time": "2018-04-09 20:40:20"
}
]
},
"msg": "当前请求接口：App.SuperTable.SqlQuery"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景 |
| data.err_msg | 字符串 | 错误提示信息，err_code非0时参考此提示信息 |
| data.sql | 字符串 | 返回本次成功查询的结果 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
接口路径(新)：http://api.yesapi.net/api/App/SuperTable/MultiCheckCreate
接口路径(旧)：http://api.yesapi.net/?s=App.SuperTable.MultiCheckCreate
接口描述： 批量增非重复 批量操作，在自定义数据表单中添加一个【非重复】新数据，添加的字段应先在小白开放平台进行添加。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| model_name | 字符串 | 必须 | 数据库表名 | ||
| database | 字符串 | 可选 | super | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 | |
| datas | 字符串JSON格式 | 必须 | 批量创建时的初始化数据，注意是数组格式，需要JSON编码后传递。格式：datas=[{"字段名1":"字段值1","字段名2":"字段值2"...}]。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 | ||
| check_field | 字符串用,分割 | 必须 | 待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 1803 批量创建非重复新数据接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.SuperTable.MultiCheckCreate`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 批量增非重复 批量操作，在自定义数据表单中添加一个【非重复】新数据，添加的字段应先在小白开放平台进行添加。
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.SuperTable.MultiCheckCreate` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| model_name | string | 必填 | 数据库表名 |
| model_uuid | string | 可选 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | string | 可选 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程 |
| database | string | 可选 | 自己的数据库配置标记，注意！这是数据库的配置标识，不是数据库的名称。默认使用super，不用传。如果需要配置多个数据库时，可与小白技术人员联系。重要事情说三遍，这是数据配置标识，不是数据库名称。使用此接口前，请先进入：数据库直连服务配置。 |
| datas | array | 必填 | 批量创建时的初始化数据，注意是数组格式，需要JSON编码后传递。格式：datas=[{"字段名1":"字段值1","字段名2":"字段值2"...}]。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 |
| check_field | array | 必填 | 待检测的字段。注意：data数据中必须包含此字段的数据，用作检测重复的依据。多个检测字段用英文逗号分割。例如：check_field=name,age，表示同时检测名字和年龄。请留意字段类型的相等性判断，如字符串类型的字段不能在data参数中传整型参数。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 状态操作码，0成功；1操作失败，2应用层规则拦截，拦截后可以小白开放平台查看日记|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.details | array | 创建的详情|
| data.details[].id | int | 客户端传递参数的序号，从1开始|
| data.details[].create_status | int | 服务端创建非重复数据的状态，0表示创建添加成功，1表示创建失败，2表示数据已存在|
| data.details[].data_id | int | 数据ID，创建成功时是新添加数据的ID，数据存在时是原来数据的ID|
| data.details[].msg | string | 创建时的错误提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.SuperTable.MultiCheckCreate&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.SuperTable.MultiCheckCreate&model_name=article&datas=[{"title":"aaa"},{"title":"bbb"},{"title":"ccc"}]&check_field=title&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"details": [
{
"id": 1,
"msg": "创建成功",
"data_id": 42,
"create_status": 0
},
{
"id": 2,
"msg": "创建成功",
"data_id": 43,
"create_status": 0
},
{
"id": 3,
"msg": "创建成功",
"data_id": 44,
"create_status": 0
}
]
},
"msg": "V1.3.4 小白开放接口 App.SuperTable.MultiCheckCreate"
}
再次请求：
{你的接口域名}/?s=App.SuperTable.MultiCheckCreate&model_name=article&datas=[{"title":"aaa"},{"title":"123"},{"title":"456"}]&check_field=title&database=super&app_key={你的app_key}&sign={接口签名}
返回：
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"details": [
{
"id": 1,
"msg": "数据已存在，不再创建",
"data_id": 42,
"create_status": 2
},
{
"id": 2,
"msg": "创建成功",
"data_id": 45,
"create_status": 0
},
{
"id": 3,
"msg": "创建成功",
"data_id": 46,
"create_status": 0
}
]
},
"msg": "V1.3.4 小白开放接口 App.SuperTable.MultiCheckCreate"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回 |