接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiCheckCreate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiCheckCreate
接口描述: 批量增非重复 批量操作,在自定义数据表单中添加一个【非重复】新数据,添加的字段应先在小白开放平台进行添加。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
datas | 字符串JSON格式 | 必须 | 批量创建时的初始化数据,注意是数组格式,需要JSON编码后传递。格式:datas=[{"字段名1":"字段值1","字段名2":"字段值2"...}]。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 | ||
check_field | 字符串用,分割 | 必须 | 待检测的字段。注意:data数据中必须包含此字段的数据,用作检测重复的依据。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiCheckCreate&model_name=TestTable&db_mark=db_test&datas=[{"name":"中文123abc","quantity":11},{"name":"中文123abc","quantity":12}]&check_field=name&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"details": [
{
"id": 1,
"msg": "数据已存在,不再创建",
"data_id": 1,
"create_status": 2
},
{
"id": 2,
"msg": "数据已存在,不再创建",
"data_id": 1,
"create_status": 2
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.MultiCheckCreate"
}
返回字段 | 类型 | 说明 |
---|---|---|
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.details | 字符串 | 创建的详情 |
data.details[].id | 整型 | 客户端传递参数的序号,从1开始 |
data.details[].create_status | 整型 | 服务端创建非重复数据的状态,0表示创建添加成功,1表示创建失败,2表示数据已存在 |
data.details[].data_id | 整型 | 数据ID,创建成功时是新添加数据的ID,数据存在时是原来数据的ID |
data.details[].msg | 字符串 | 创建时的错误提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiDelete
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiDelete
接口描述: 批量删 根据多个ID,批量删除自定义数据表单中的数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
ids | ids | 必须 | 最大:500 | 多个ID,使用英文逗号分割,例如:ids=1,2,3 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiDelete&model_name=TestTable&db_mark=db_test&ids=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.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://demo.phalapi.net/api/App/DB_MsSQL_Data/GetDataAfterChangeNum
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetDataAfterChangeNum
接口描述: 查改 可以根据自定义的多个条件(AND或者OR),查找获取一条数据,然后对指定的字段进行加减操作,最后返回最新的数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
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.data | 对象 | 返回加减后的数据,没有数据时返回null;修改成功时固定会返回修改的字段更新后的最新值 |
data.total | 整型 | 符合条件的总数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeReplace
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeReplace
接口描述: 批量 改 针对表单的单个字段,根据指定的查找值和替换值进行自定义条件的批量替换
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
field_name | 字符串 | 必须 | 字段名称,需要替换的字段名 | ||
from_str | 字符串 | 必须 | 要替换的子字符串 | ||
to_str | 字符串 | 必须 | 新的替换子字符串,不能和from_str一样 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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优先) |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
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.update_total | 整型 | 成功更新的数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/Create
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Create
接口描述: 增 向sql server数据库的表在添加一个新纪录数据,添加的字段必须要在表中已经存在。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
data | 字符串JSON格式 | 可选 | 创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...},注意编码格式统一为UTF-8。 | ||
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 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.Create&model_name=TestTable&db_mark=db_test&data={"name":"中文123abc","quantity":10}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 1
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Create"
}
创建前需要提前创建好数据库表,例如:
1> USE TestDB
2> go
Changed database context to 'TestDB'.
1> CREATE TABLE TestTable (id INT identity(1,1) NOT NULL PRIMARY KEY, name VARCHAR(50), quantity INT);
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
(1 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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.id | 整型 | 新创建数据的自增ID |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiCreate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiCreate
接口描述: 批量增 批量导入多条新数据,导入完毕后会返回导入的概况
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
datas | 字符串JSON格式 | 必须 | 批量导入的数据。特别注意!这是复数datas,即需要传递是的单个创建时的数组的数组。格式为JSON,即:datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiCreate&model_name=TestTable&db_mark=db_test&datas=[{"name":"中文123abc","quantity":11},{"name":"中文123abc","quantity":12}]&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,
"msg": "导入成功"
},
{
"id": 2,
"msg": "导入成功"
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.MultiCreate"
}
创建前需要提前创建好数据库表,例如:
1> USE TestDB
2> go
Changed database context to 'TestDB'.
1> CREATE TABLE TestTable (id INT identity(1,1) NOT NULL PRIMARY KEY, name VARCHAR(50), quantity INT);
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 11
2 中文123abc 12
(2 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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[].msg | 字符串 | 导入的结果 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiFastCreate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiFastCreate
接口描述: 批量增 批量极速导入多条新数据,速度很快但无明细,此接口可用于批量导入数据,适用于数据初始化和还原。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
datas | 字符串JSON格式 | 必须 | 批量导入的数据。特别注意!这是复数datas,即需要传递是的单个创建时的数组的数组。格式为JSON,即:datas=[单个创建时的数据1, 单个创建时的数据2, ...]。一次最多只允许导入1000条数据。 | ||
is_ignore | 布尔型 | 可选 | true | 是否启用IGNORE,1是0否,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/CheckCreate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.CheckCreate
接口描述: 增 在自定义数据表单中添加一个【非重复】新数据,添加的字段应先要在表中已经存在。即当数据不存在时则创建,当数据已存在时不进行任何操作。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.CheckCreate&model_name=TestTable&db_mark=db_test&data={"name":"中文123abc","quantity":10}&check_field=name&return_data=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 3,
"err_msg": "数据已存在,不再创建",
"id": 1,
"data": {
"id": 1,
"name": "中文123abc",
"quantity": "10"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.CheckCreate"
}
返回字段 | 类型 | 说明 |
---|---|---|
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/或原来数据的ID |
data.data | 对象 | 新创建或原来的数据,全部字段返回。默认不返回,return_data=1 才返回。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/Count
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Count
接口描述: 查 获取sql server直连数据库表的总条目数量
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
(1 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.Count&model_name=TestTable&db_mark=db_test&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 1
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Count"
}
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeCount
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeCount
接口描述: 查 可以根据自定义的多个条件(AND或者OR),获取总数
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeCount&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",1]]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 2
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeCount"
}
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/Get
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Get
接口描述: 查 根据ID,获取自定义数据表单中的数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
id | 整型 | 必须 | 最小:1 | 数据ID,例如:1,2,3,…… |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
(1 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.Get&model_name=TestTable&db_mark=db_test&id=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": 1,
"name": "中文123abc",
"quantity": "10"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Get"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(不符合表字段要求,或表字段不存在,数据已删除或不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,并返回全部字段的数据 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiGet
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiGet
接口描述: 批量查 sql server根据批量ID,批量获取自定义数据表单中的数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
ids | ids | 必须 | 最大:500 | 多个ID,使用英文逗号分割,例如:ids=1,2,3 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiGet&model_name=TestTable&db_mark=db_test&ids=1,2,3&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"list": [
{
"id": 1,
"name": "中文123abc",
"quantity": "10"
},
{
"id": 2,
"name": "123",
"quantity": "100"
},
{
"id": 3,
"name": "中文123abc",
"quantity": "10"
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.MultiGet"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(不符合表字段要求,或表字段不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.list | 字符串 | 获取的数据,没有任何数据时为空数组,如果未找到ID对应的数据则没有任何元素 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeMax
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeMax
接口描述: 查 可以根据自定义的多个条件(AND或者OR),获取某个字段的最大值
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeMax&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",0]]&field=quantity&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"max": "100"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeMax"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在,查无数据,字段不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.max | 字符串 | 获取的最大值 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeMin
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeMin
接口描述: 查 可以根据自定义的多个条件(AND或者OR),获取某个字段的最小值
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeMin&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",0]]&field=quantity&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"min": "10"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeMin"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在,查无数据,字段不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.min | 字符串 | 获取的最小值 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/ChangeNumber
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.ChangeNumber
接口描述: 改 根据ID,修改某个字段的数值,可增加或可减少。通过在服务端进行数值的叠加,尽量保持并发下的数据一致性。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
id | 整型 | 必须 | 最小:1 | 数据ID | |
change_field | 字符串 | 必须 | 待修改数值的字段名 | ||
change_value | 字符串 | 必须 | 待叠加的数值,正数表示相加,负数表示相减,需要传递有效数值 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.ChangeNumber&model_name=TestTable&db_mark=db_test&id=3&change_field=quantity&change_value=2&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_value": "2",
"after_value": "12"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.ChangeNumber"
}
返回字段 | 类型 | 说明 |
---|---|---|
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.after_value | 字符串 | 本次更新后,最新的字段值 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/CheckCreateOrUpdate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.CheckCreateOrUpdate
接口描述: 增改 在自定义数据表单中尝试添加一个【非重复】新数据,如果数据已经存在,则进行更新操作。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
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可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | 多个check_field的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.CheckCreateOrUpdate&model_name=TestTable&db_mark=db_test&data={"name":"中文123abc","quantity":4}&check_field=name,quantity&logic=and&app_key={你的app_key}&sign={动态签名}
第一次数据不存在就插入,返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4,
"op_type": "insert"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.CheckCreateOrUpdate"
}
第二次数据存在则更新,返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4,
"op_type": "update"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.CheckCreateOrUpdate"
}
返回字段 | 类型 | 说明 |
---|---|---|
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/或原来数据的ID |
data.op_type | 字符串 | 本次操作的具体类型,insert为插入,update为更新 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/Delete
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Delete
接口描述: 删 根据ID,删除自定义数据表单中的数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
id | 整型 | 必须 | 最小:1 | 数据ID,例如:1,2,3,…… |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.Delete&model_name=TestTable&db_mark=db_test&id=12&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Delete"
}
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/DropOneByOne
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.DropOneByOne
接口描述: 查删 根据主键id从小到大依次获取数据,取完就立即删除,从而实现非重复数据的获取。此接口即便在高并发下也能保证数据非重复。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 10
2 123 100
3 中文123abc 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.DropOneByOne&model_name=TestTable&db_mark=db_test&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "1",
"name": "中文123abc",
"quantity": "10"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.DropOneByOne"
}
请求后数据:
id name quantity
----------- -------------------------------------------------- -----------
2 123 100
3 中文123abc 10
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在,查无数据) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取到的非重复数据,即整条纪录数据。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeDelete
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeDelete
接口描述: 删 可以根据自定义的多个条件(AND或者OR),删除多条数据。数据一旦删除,无法恢复,请谨慎操作!
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeDelete&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",1]]&max_delete_num=0&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"delete_total": 2
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeDelete"
}
修改后的数据
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeExport
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeExport
接口描述: 查 可以根据自定义的多个条件(AND或者OR),进行数据导出。成功导出时,此接口会直接生成可供下载的txt或csv文件。个人免费版最多导出5000条,VIP版最多可导出1万条,SVIP版最多可导出3万条。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
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):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeFindOne
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeFindOne
接口描述: 查 可以根据自定义的多个条件(AND或者OR),查找获取一条数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeFindOne&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",1]]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "2",
"name": "123",
"quantity": "2"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeFindOne"
}
修改后的数据
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 2
2 123 3
3 中文123abc 4
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在,查无数据) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeChangeNumber
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeChangeNumber
接口描述: 改 可以根据自定义的多个条件(AND或者OR),修改某个或多个字段的数值,可增加或可减少。通过在服务端进行数值的叠加,尽量保持并发下的数据一致性。注意,此接口可更新多条数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeChangeNumber&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",0]]&change_field=quantity&change_value=2&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_value": "2",
"update_rows": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeChangeNumber"
}
修改后的数据
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 3
2 123 4
3 中文123abc 5
返回字段 | 类型 | 说明 |
---|---|---|
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.details[].update_rows | 整型 | 本次的更新结果,对应更新的条目数量。没有更新或没有创建时为0,如果进行更新或初始化创建则为1,其他情况为对应更新的条目数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeMultiCal
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeMultiCal
接口描述: 批量改 根据条件,批量进行四则运算,即:加/减/乘/除。例如,field=x,op=add,number=1,组合起来表示:x=x+1。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeMultiCal&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",0]]&field=quantity&op=add&number=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_rows": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeMultiCal"
}
修改后的数据
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 2
2 123 3
3 中文123abc 4
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreePopAll
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreePopAll
接口描述: 查改 可以根据自定义的多个条件(AND或者OR),查找获取多条数据,并且在获取数据后更改字段,从而实现非重复数据的获取
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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表示随机排序,将能更好地实现高并发下的非重复获取;order_type=4表示更新时间update_time升序;order_type=5表示更新时间update_time降序; | |
top_num | 整型 | 可选 | 0 | 最小:0 | 最多返回前面多少条,0表示全部取出 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreePopAll&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",2]]&data={"name":"FreePopAll","quantity":10}&order_type=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": [
{
"id": "3",
"name": "中文123abc",
"quantity": "3"
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreePopAll"
}
请求后的数据变成:
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 FreePopAll 10
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeConcact
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeConcact
接口描述: 改 可以根据自定义的多个条件(AND或者OR),修改某个字段的字符串内容,可以在前面追加,也可以在后面追加。同时支持分割符。通过在服务端进行字符串的叠加,尽量保持并发下的数据一致性。注意,此接口可更新多条数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 | 字符串 | 必须 | 待修改字符串的字段名,如果不希望在前后出现多余的分割符,可将字段的默认值设置为NULL。 | ||
concact_str | 字符串 | 必须 | 待追加的字符串 | ||
seperator | 字符串 | 可选 | 分割符,默认为空字符串 | ||
side | 枚举类型 | 可选 | right | 范围:right/left | 新增的追加在哪边,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 1 10
2 2 100
3 3 10
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeConcact&model_name=TestTable&db_mark=db_test&logic=and&where=[["id",">",0]]&change_field=name&concact_str=yesapi&side=right&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_rows": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeConcact"
}
请求后数据:
id name quantity
----------- -------------------------------------------------- -----------
1 1yesapi 10
2 2yesapi 100
3 3yesapi 10
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeAF
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeAF
接口描述: 查统计 统计接口,可以根据自定义的多个条件(AND或者OR),进行GROUP聚合操作运算
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
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):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeAF&model_name=TestTable&db_mark=db_test&op_fun=SUM&op_field=quantity&group_filed=name&logic=and&where=[["id",">",0]]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"name": "中文123abc",
"total_num": "4"
},
{
"name": "123",
"total_num": "2"
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeAF"
}
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeAggregation
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeAggregation
接口描述: 查统计 可以根据自定义的多个条件(AND或者OR),进行SUM/COUNT/MIN/MAX/AVG等聚合运算,同时支持多个字段的聚合运算。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
op_funs | 字符串用,分割 | 必须 | 最小:1 | 聚合函数操作,支持多个聚合运算,目前支持:SUM/COUNT/MIN/MAX/AVG,分别表示:求和/数目/最小/最大/平均数,注意全部大写,多个用英文逗号分割。 | |
op_fields | 字符串用,分割 | 必须 | 进行聚合的字段名称,需要和op_funs的运算一一对应,,多个用英文逗号分割。例如:假设op_funs=SUM,COUNT,同时op_fields=price,id,那么最终相当于:SUM(price), COUNT(id),返回结果字段是:SUM_price, COUNT_id | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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优先) |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设已经有以下数据库表和数据:
1> USE TestDB
2> go
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abc 1
2 123 2
3 中文123abc 3
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeAggregation&model_name=TestTable&db_mark=db_test&op_funs=MAX&op_fields=quantity&logic=and&where=[["id",">",0]]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"report": {
"MAX_quantity": "3"
}
},
"msg": "V1.5.0 小白开放接口 App.DB_MsSQL_Data.FreeAggregation"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在,查无数据) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.report | 对象 | 聚合运算的表格数据 |
data.report.SUM_field | mixed | 返回的字段是动态的名称,字段名是:聚合运算名+下划线+字段名,例如:SUM_field。失败时返回 NULL,根据运算和字段类型不同,返回结果可能是int,也可能是string类型,或浮点数。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/Transfer
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Transfer
接口描述: 改 在同一个数据库表内的同一字段,进行点对点同级“转账”操作。例如:把A账号的100积分转到B账号的积分。要求:转出和转入账号纪录已经存在且必须唯一;字段类型和“转账”数量均为整数;符合交换律和零和(即A转给B,然后B再转给A后,恢复和最初的一样)。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
account_field | 字符串 | 必须 | 最小:1 | 账号字段名称 | |
from_account | 字符串 | 必须 | 最小:1 | 转出账号,即对应account_field字段的值,必须存在且唯一 | |
to_account | 字符串 | 必须 | 最小:1 | 转入账号,即对应account_field字段的值,必须存在且唯一 | |
amount_field | 字符串 | 必须 | 最小:1 | 数量字段名称,此字段必须为整数类型,例如:tinyint、smallint、int、bigint等 | |
amount | 整型 | 必须 | 最小:1 | 待转的数量,必须为整数,且为正整数,且转出账号数量充足 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable where id = 3 or id = 4;
2> go
id name quantity
----------- -------------------------------------------------- -----------
3 中文123abc 4
4 中文123abc 17
(2 rows affected)
如果需要从id=3转移2个quantity到id=4的账号,可以请求接口:
{你的接口域名}/?s=App.DB_MsSQL_Data.Transfer&model_name=TestTable&db_mark=db_test&account_field=id&from_account=3&to_account=4&amount_field=quantity&amount=2&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"from_account_amout": 2,
"to_account_amout": 19,
"amount": 2
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Transfer"
}
重新查询:
1> select * from TestTable where id = 3 or id = 4;
2> go
id name quantity
----------- -------------------------------------------------- -----------
3 中文123abc 2
4 中文123abc 19
(2 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误;10转出账号不存在;11转出账号不唯一;12转出账号数量不足;20转入账号不存在;21转入账号不唯一 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.from_account_amout | 整型 | 成功转移后转出账号的剩余数量 |
data.to_account_amout | 整型 | 成功转移后转入账号的最新数量 |
data.amount | 整型 | 成功转移后本次转移的数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/Update
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.Update
接口描述: 改 根据ID,更新sql server数据库表中的数据,更新的字段需要先存在。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
id | 整型 | 必须 | 最小:1 | 数据ID,例如:1,2,3,…… | |
data | 字符串JSON格式 | 可选 | 待更新的数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...} | ||
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 客户端接入指南(如何生成签名) 开启/关闭签名
假设已有数据:
1> select * from TestTable where id = 1;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文123abcd
(1 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.Update&model_name=TestTable&db_mark=db_test&id=1&data={"name":"中文12345ABCD","quantity":99}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.Update"
}
重新查询数据后:
1> use TestDB;
2> go
Changed database context to 'TestDB'.
1> select * from TestTable where id = 1;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文12345ABCD 99
(1 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiUpdate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiUpdate
接口描述: 批量改 根据多个ID,批量更新sql server数据库表中的数据,更新的字段需要先存在。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
ids | ids | 必须 | 最大:500 | 多个ID,使用英文逗号分割,例如:ids=1,2,3 | |
data | 字符串JSON格式 | 可选 | 待更新的数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...} | ||
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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable where id = 1 or id = 3 or id = 5;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 中文12345ABCD 99
3 中文123abc 2
5 中文123abc 12
(3 rows affected)
如果需要把id为1、3、5的数据统一更新,可以请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiUpdate&model_name=TestTable&db_mark=db_test&ids=1,3,5&data={"name":"小白","quantity":666}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_total": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.MultiUpdate"
}
重新查询数据:
1> select * from TestTable where id = 1 or id = 3 or id = 5;
2> go
id name quantity
----------- -------------------------------------------------- -----------
1 小白接口 666
3 小白接口 666
5 小白接口 666
(3 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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_total | 整型 | 成功更新的数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/MultiCheckCreateOrUpdate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.MultiCheckCreateOrUpdate
接口描述: 批量增改 批量版接口,在sql server数据库表中尝试添加一个【非重复】新数据,如果数据已经存在,则进行更新操作。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
datas | 字符串JSON格式 | 必须 | 需要批量创建的初始化数据,需要JSON编码后传递。格式:datas=[{第一组数据},{第二组数据},{第三组数据……}]。每一组的数据格式:{"字段名1":"字段值1","字段名2":"字段值2"...} | ||
check_field | 字符串用,分割 | 必须 | 待检测的字段,非批量,全部检测的字段都应一致。注意:datas批量数据每一组数据中必须包含待检测的全部字段。即check_field可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | 多个check_field的逻辑组合,非批量,全部检测的字段都应一致。logic=and表示逻辑且,logic=or表示逻辑或 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
2 123 100
3 小白接口 666
4 中文123abc 19
5 小白接口V2 666
6 中文123abc 11
7 中文123abc 12
(6 rows affected)
如果需要对name为123和name为小白接口的quantity进行更新,并且需要添加一个新的name为ABC的数据,可以请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.MultiCheckCreateOrUpdate&model_name=TestTable&db_mark=db_test&datas=[{"name":"123","quantity":101},{"name":"小白","quantity":888},{"name":"ABC","quantity":123}]&check_field=name&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"details": [
{
"op_type": "update",
"id": 2
},
{
"op_type": "update",
"id": 3
},
{
"op_type": "insert",
"id": 8
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.MultiCheckCreateOrUpdate"
}
重新查询:
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
2 123 101
3 小白接口 888
4 中文123abc 19
5 小白接口V2 666
6 中文123abc 11
7 中文123abc 12
8 ABC 123
(7 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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.details | 字符串 | 批量的结果 |
data.details[].id | 整型 | 新创建数据的自增ID/或原来数据的ID |
data.details[].op_type | 字符串 | 本次操作的具体类型,insert为插入,update为更新,fail为失败(参数错误) |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/GetOneDataByOneField
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetOneDataByOneField
接口描述: 查 在sql server数据库中,根据一个表字段快速获取数据库表的其他字段的数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
field_name | 字符串 | 必须 | 需要匹配的表单字段名称 | ||
field_value | 字符串 | 必须 | 需要查找和对比的字段值 | ||
select | 字符串用,分割 | 可选 | 需要返回的字段,默认返回全部字段,多个字段用英文逗号分割,如:select=id,uuid |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable where name = 'ABC';
2> go
id name quantity
----------- -------------------------------------------------- -----------
8 ABC 123
(1 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetOneDataByOneField&model_name=TestTable&db_mark=db_test&field_name=name&field_value=ABC
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "8",
"name": "ABC",
"quantity": "123"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.GetOneDataByOneField"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;3数据不存在或已删除 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 查找到的数据,如果未找到则为null。其中,id字段固定返回。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/GetMoreDataByMoreField
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetMoreDataByMoreField
接口描述: 查 在sql server数据库中,根据数据库表的一个字段或多个字段取一条或多条数据。最多返回20条。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
field_name_list | 字符串用,分割 | 必须 | 最小:1 | 需要匹配的表单字段名称列表,多个字段用英文逗号分割,如:field_name_list=title,name | |
field_value_list | 字符串用,分割 | 必须 | 最小:1 | 需要查找和对比的字段值列表,多个值用英文逗号分割,如:field_value_list=标题,小白 。字段值不能含有英文逗号。field_value_list数量必须和field_name_list数量保持一致。 | |
select | 字符串用,分割 | 可选 | 需要返回的字段,默认返回全部字段,多个字段用英文逗号分割,如:select=id,uuid | ||
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 20 | 最小:1;最大:10000 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable where name = 'ABC';
2> go
id name quantity
----------- -------------------------------------------------- -----------
8 ABC 123
9 ABC 123
10 ABC 456
(3 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetMoreDataByMoreField&model_name=TestTable&db_mark=db_test&logic=and&field_name_list=name,quantity&field_value_list=ABC,123&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"id": "8",
"name": "ABC",
"quantity": "123"
},
{
"id": "9",
"name": "ABC",
"quantity": "123"
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.GetMoreDataByMoreField"
}
由于id=10的纪录中quantity=456,因此接口不会返回。
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功; |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.items | 对象 | 查找到的数据列表,如果未找到则为空数组。最多返回20条,ID升序获取。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/GetFiledDailyDataReport
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetFiledDailyDataReport
接口描述: 查统计 sql server数据库中,针对数据库表中的单个字段,获取两个周期内每日的统计报表,可以统计总数或总条目数量,即:sum({field}) 或 count({field})。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
op | 枚举类型 | 可选 | COUNT | 范围:SUM/COUNT | 需要统计的类型,求和:SUM,算总条目数:COUNT |
field | 字符串 | 必须 | 需要统计的字段,如:field=money | ||
date_field | 字符串 | 必须 | add_time | 需要统计的时间日期字段,此字段类型必须是datetime,如:field=add_time | |
days | 整型 | 可选 | 7 | 最大:180 | 多少天前的对比报表数据,例如7表示一周前,30天表示上个月 |
startDate | 日期 | 可选 | 开始日期,例如:2020-02-20 | ||
endDate | 日期 | 可选 | 结束日期,例如:2020-02-27,包含结束当天的数据。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestReport;
2> go
id num add_time
----------- ----------- -----------------------
1 10 2020-02-27 10:00:00.000
2 20 2020-02-28 10:00:00.000
3 30 2020-02-28 12:00:00.000
4 50 2020-02-29 14:00:00.000
5 100 2020-02-29 18:00:00.000
(5 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetFiledDailyDataReport&model_name=TestReport&db_mark=db_test&op=COUNT&field=id&date_field=add_time&days=7&startDate=2020-02-24&endDate=2020-02-29&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": {
"now": [
{
"date": "2020-02-24",
"total": 0,
"id": 1
},
{
"date": "2020-02-25",
"total": 0,
"id": 2
},
{
"date": "2020-02-26",
"total": 0,
"id": 3
},
{
"date": "2020-02-27",
"total": 1,
"id": 4
},
{
"date": "2020-02-28",
"total": 2,
"id": 5
}
],
"pre": [
{
"date": "2020-02-19",
"total": 0,
"id": 1
},
{
"date": "2020-02-20",
"total": 0,
"id": 2
},
{
"date": "2020-02-21",
"total": 0,
"id": 3
},
{
"date": "2020-02-22",
"total": 0,
"id": 4
},
{
"date": "2020-02-23",
"total": 0,
"id": 5
}
]
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.GetFiledDailyDataReport"
}
对于进行求和的报表,可以请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetFiledDailyDataReport&model_name=TestReport&db_mark=db_test&op=SUM&field=id&date_field=add_time&days=7&startDate=2020-02-24&endDate=2020-02-29&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": {
"now": [
{
"date": "2020-02-24",
"total": 0,
"id": 1
},
{
"date": "2020-02-25",
"total": 0,
"id": 2
},
{
"date": "2020-02-26",
"total": 0,
"id": 3
},
{
"date": "2020-02-27",
"total": 1,
"id": 4
},
{
"date": "2020-02-28",
"total": 5,
"id": 5
}
],
"pre": [
{
"date": "2020-02-19",
"total": 0,
"id": 1
},
{
"date": "2020-02-20",
"total": 0,
"id": 2
},
{
"date": "2020-02-21",
"total": 0,
"id": 3
},
{
"date": "2020-02-22",
"total": 0,
"id": 4
},
{
"date": "2020-02-23",
"total": 0,
"id": 5
}
]
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.GetFiledDailyDataReport"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.items | 对象 | 报表数据 |
data.items.now | 字符串 | 最近几天的统计数据 |
data.items.now[].id | 整型 | 序号 |
data.items.now[].date | 字符串 | 日期,格式如:2019-04-01 |
data.items.now[].total | 浮点型 | 统计的总数 |
data.items.pre | 字符串 | 上一周期的统计数据 |
data.items.pre[].id | 整型 | 序号 |
data.items.pre[].date | 字符串 | 日期,格式如:2019-04-01 |
data.items.pre[].total | 浮点型 | 统计的总数 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/GetFieldDropdownList
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetFieldDropdownList
接口描述: 查 sql server数据库中,获取数据库表中指定字段的下拉列表,全表去重后顺序显示。最多显示前面1000条。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
field_name | 字符串 | 必须 | 字段名称,需要获取下拉列表的字段 | ||
num | 整型 | 可选 | 100 | 最小:2;最大:1000 | 返回的列表数量 |
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id",">",0]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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优先) |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
2 123 113
3 小白接口 890
4 中文123abc 19
5 小白接口V2 666
6 中文123abc 11
7 中文123abc 12
8 ABC 123
9 ABC 123
10 ABC 456
11 中文123abc 10
(10 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetFieldDropdownList&model_name=TestTable&db_mark=db_test&field_name=name&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
"123",
"ABC",
"小白接口",
"小白接口V2",
"中文123abc"
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.GetFieldDropdownList"
}
返回字段 | 类型 | 说明 |
---|---|---|
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 | 字符串 | 查找到的下拉列表数据,每个元素为字段值。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeUpdate
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeUpdate
接口描述: 改 功能更强大的更新操作,可以根据自定义的多个条件(AND或者OR),更新sql server指定的表数据。为防止误更新全表数据,必须至少有一个有效条件。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
4 小白V6 27
5 小白接口V5 674
6 小白接口V5 19
7 小白接口V5 20
8 小白接口V5 131
9 小白接口V5 131
10 小白接口V5 10
(7 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeUpdate&model_name=TestTable&db_mark=db_test&logic=and&where=[["id", ">=", "6"],["id", "<", "9"]]&data={"name":"小白V8"}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"update_rows": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeUpdate"
}
重新查询数据:
1> select * from TestTable;
2> go
id name quantity
----------- -------------------------------------------------- -----------
4 小白V6 27
5 小白接口V5 674
6 小白V8 19
7 小白V8 20
8 小白V8 131
9 小白接口V5 131
10 小白接口V5 10
(7 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeTree
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeTree
接口描述: 查 可以根据自定义条件获取树状分类的数据,可用于:组织架构、目录分类、网站菜单、级联地址等场景。要求:sql server数据库表中须含有指向父级的ID。当前最多一次性获取两层。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
parent_field | 字符串 | 必须 | parent_id | 子级存放父级id的字段名称,此字段必须要出现在表单中,为int类型。如果不想使用默认的字段名称parent_field ,可以自定义其他字段名称。 | |
parent_id | 整型 | 必须 | 0 | 所属父类id的值,顶级分类的父级id值为0。固定对应表单中id字段的值。具体使用请见下方请求示例。 | |
where | 字符串JSON格式 | 可选 | [] | 可选且安全的where条件,格式为:[["第一个位置表示字段名称(字段必须先存在)","第二个位置表示判断>符号(可以是:>、>=、<、<=、=、<>, LIKE)","第三个位置表示判断值"]]。多个条件逻辑关系为:AND,并且接口会默认加上父级ID的匹配。 | |
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 | 字符串用,分割 | 可选 | SQL语句的SELECT部分,多个字段用英文逗号分割,如:select=id,uuid | ||
order | 字符串JSON格式 | 可选 | [] | SQL语句的ORDER部分,格式为:[第一组排序,第二组排序,……],如:order = ["id DESC", "add_time ASC"],表示 id DESC, add_time ASC。特别地,RAND表示随机排序。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity parent_id
----------- -------------------------------------------------- ----------- -----------
4 小白V6 27 NULL
5 小白接口V5 674 0
6 小白V8 19 4
7 小白V8 20 4
8 小白V8 131 0
9 小白接口V5 131 8
10 小白接口V5 10 8
(7 rows affected)
请求第一级:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeTree&model_name=TestTable&db_mark=db_test&parent_field=parent_id&parent_id=0&where=[["id", ">=", "1"]]&order=["id DESC"]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"tree": [
{
"id": 8,
"name": "小白V8",
"quantity": "131",
"parent_id": 0,
"children_tree": [
{
"id": 10,
"name": "小白接口V5",
"quantity": "10",
"parent_id": 8
},
{
"id": 9,
"name": "小白接口V5",
"quantity": "131",
"parent_id": 8
}
]
},
{
"id": 5,
"name": "小白接口V5",
"quantity": "674",
"parent_id": 0,
"children_tree": []
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeTree"
}
请求第二级:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeTree&model_name=TestTable&db_mark=db_test&parent_field=parent_id&parent_id=8&where=[["id", ">=", "1"]]&order=["id DESC"]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"tree": [
{
"id": 10,
"name": "小白接口V5",
"quantity": "10",
"parent_id": 8,
"children_tree": []
},
{
"id": 9,
"name": "小白接口V5",
"quantity": "131",
"parent_id": 8,
"children_tree": []
}
]
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeTree"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,查询失败(表不存在或查询错误); |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.tree | 字符串 | 树状数据 |
data.tree[].id | 整型 | 固定返回,ID |
data.tree[].{parent_id} | 整型 | 固定返回,父级ID,字段名由客户端指定 |
data.children_tree | 字符串 | 子节点的树状数据,没有时为空数组。表单中不能添加children_tree字段,以免引起冲突。返回字段、过滤条件和排序逻辑和顶层一样。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeSum
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeSum
接口描述: 查 可以根据自定义的多个条件(AND或者OR),计算sql server数据库表中某个字段的总和
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity parent_id
----------- -------------------------------------------------- ----------- -----------
4 小白V6 27 NULL
5 小白接口V5 674 0
6 小白V8 19 4
7 小白V8 20 4
8 小白V8 131 0
9 小白接口V5 131 8
10 小白接口V5 10 8
(7 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeSum&model_name=TestTable&db_mark=db_test&logic=and&where=[["name", "=", "小白V8"]]&field=quantity&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"sum": "170"
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeSum"
}
返回字段 | 类型 | 说明 |
---|---|---|
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://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeRandOne
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeRandOne
接口描述: 查 可以根据自定义的多个条件(AND或者OR),随机获取一条数据。获取数据后不会修改或删除原来的数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id",">",0]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeRandOne&model_name=TestTable&db_mark=db_test&logic=and&where=[["id", ">=", "1"]]&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "4",
"name": "小白V6hxh",
"quantity": "27",
"parent_id": null
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreeRandOne"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(数据库表不存在); 3查无数据;4当前取随机数据已超过10万条,为保证接口服务质量,请联系小白客服进行定制化。 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreeQuery
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreeQuery
接口描述: 查 可以根据自定义的多个条件(AND或者OR),对sql server 数据库表数据进行快速且安全的搜索和查询。只能获取前面多少条数据,暂时不支持分页。如果需要进行分页操作,可以借助主键或ID进行游标遍历,即把本次获取到的最后的id作为下一次新开始的ID位置。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
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):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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表示随机排序,请慎用。 | |
top | 整型 | 可选 | 10 | 最小:1;最大:10000 | 取前面多少条,对应TOP数量。 |
is_real_total | 布尔型 | 可选 | true | 是否需要真正的总数,1是0否,当表单数据过多时,如果不需要查询真正的总数,将能极大提升接口响应的速度。若为假总数,固定返回9999999。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select * from TestTable;
2> go
id name quantity parent_id
----------- -------------------------------------------------- ----------- -----------
4 小白V6hxh 27 NULL
5 小白接口V5hxh 674 0
6 小白V8hxh 19 4
7 小白V8hxh 20 4
8 小白V8hxh 131 0
9 小白接口V5hxh 131 8
10 小白接口V5hxh 10 8
(7 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreeQuery&model_name=TestTable&db_mark=db_test&logic=and&where=[["id", ">=", "1"]]&order=["id DESC"]&top=3&is_real_total=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 7,
"list": [
{
"id": "10",
"name": "小白接口V5hxh",
"quantity": "10",
"parent_id": "8"
},
{
"id": "9",
"name": "小白接口V5hxh",
"quantity": "131",
"parent_id": "8"
},
{
"id": "8",
"name": "小白V8hxh",
"quantity": "131",
"parent_id": "0"
}
],
"page": 1,
"perpage": 3
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.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 | 字符串 | 查询的结果列表数据 |
data.page | 整型 | 当前第几页 |
data.perpage | 整型 | 当前分页数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/FreePopOne
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.FreePopOne
接口描述: 查改 可以根据自定义的多个条件(AND或者OR),从sql server 数据库表中查找获取一条数据,并且在获取数据后更改字段,从而实现非重复数据的获取
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
logic | 枚举类型 | 可选 | and | 范围:and/or | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
where | 字符串JSON格式 | 可选 | [["id", ">=", "1"]] | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中:
写法2(Beta):每一组的条件格式可以为:MsSQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求:
以上两种写法可以混合使用。如果需要有效防止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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
1> select id,name,is_used from TestTable;
2> go
id name is_used
----------- -------------------------------------------------- -----------
4 小白V6hxh 0
5 小白接口V5hxh 0
6 小白V8hxh 0
7 小白V8hxh 0
8 小白V8hxh 0
9 小白接口V5hxh 0
10 小白接口V5hxh 0
(7 rows affected)
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.FreePopOne&model_name=TestTable&db_mark=db_test&logic=and&where=[["id", ">=", "1"]]&data={"is_used":"1"}&order_type=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"data": {
"id": "4",
"name": "小白V6hxh",
"quantity": "27",
"parent_id": null,
"is_used": "0"
}
},
"msg": "V1.4.17 小白开放接口 App.DB_MsSQL_Data.FreePopOne"
}
重新查询数据:
1> select id,name,is_used from TestTable;
2> go
id name is_used
----------- -------------------------------------------------- -----------
4 小白V6hxh 1
5 小白接口V5hxh 0
6 小白V8hxh 0
7 小白V8hxh 0
8 小白V8hxh 0
9 小白接口V5hxh 0
10 小白接口V5hxh 0
(7 rows affected)
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表不存在);3查无数据;4当前取随机数据已超过10万条,为保证接口服务质量,请联系小白客服进行定制化。 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://demo.phalapi.net/api/App/DB_MsSQL_Data/GetDocx
接口路径(旧):http://demo.phalapi.net/?s=App.DB_MsSQL_Data.GetDocx
接口描述: 查 sql server数据库中,根据数据库表ID,获取自定义数据表单中的数据,并生成可直接下载的word文档。HTML内容将会被作为普通文本序列化输出。注意,仅当成功时才可下载word文档,失败时依然以接口JSON结果返回。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 数据库表名,表名规范如下:
| ||
db_mark | 字符串 | 必须 | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
id | 整型 | 必须 | 最小:1 | 数据ID,例如:1,2,3,…… | |
title | 字符串 | 可选 | word文档标题及文件名 | ||
tpl | 字符串 | 可选 | word文档的模板,表单字段点位符为:{{字段名}} 。例如:ID为 {{id}} ,更新时间为{{update_time}} ,创建时间{{add_time}} ,特别地,换行为{{\n}} 。未设置模板时,默认显示全部字段,一行一个字段 | ||
font_style | 字符串JSON格式 | 可选 | {"name":"Arial"} | word文档的格式设置,JSON格式,示例:{"name": "Microsoft Yahei UI", "size": 20, "color": "#ff6600", "bold": true} 格式配置:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.DB_MsSQL_Data.GetDocx&model_name=TestTable&db_mark=db_test&id=5&title=我是word文档标题&tpl=我的名字是:{{name}},质量是:{{quantity}}分。&font_style={"name":"Arial"}&app_key={你的app_key}&sign={动态签名}
返回:
直接可以下载的word文件,其中,
标题是:我是word文档标题.docx
内容是:
我是word文档标题
我的名字是:小白接口V2,质量是:666分。
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功,注意,仅当成功时才可下载word文档,失败时依然以接口JSON结果返回。;1开发类错误,获取失败(符合表字段要求,或表字段不存在);3获取失败(数据已删除或不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次