接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
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_聚合运算。 |
在线测试
参数 | 是否必填 | 值 |
---|---|---|
s | 固定 | |
return_data | 可选 | |
model_name | 必须 | |
db_mark | 必须 | |
op_fun | 必须 | |
op_field | 必须 | |
group_filed | 必须 | |
sort_type | 可选 | |
page | 可选 | |
top_num | 可选 | |
logic | 可选 | |
where | 可选 | |
select_more | 可选 |
客户端请求示例
查看我的接口域名、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密钥字符串) ,若需要关闭或开启请提交工单 |
ret异常错误码
错误码 | 错误类型 | 错误描述信息 | 解决方法 |
---|---|---|---|
ret = 200 | 成功 | 请求成功 | |
ret = 400 | 客户端非法请求 | 非法请求,参数错误 | 1、根据接口文档的接口参数,提供正确的参数 |
ret = 401 | 客户端非法请求 | 用户未登录,或登录凭证已过期 | 1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口 |
ret = 402 | 客户端非法请求 | IP已被黑名单拦截 | 1、进入接口IP设置,移除IP黑名单设置 |
ret = 403 | 客户端非法请求 | IP未命中白名单 | 1、进入接口IP设置,添加IP白名单设置,或清空IP白名单设置 |
ret = 404 | 客户端非法请求 | 接口服务不存在 | 1、查看小白接口大全,确保接口服务名称拼写正确 |
ret = 406 | 客户端非法请求 | 非法app_key,请核对你所在的接口域名 | 1、在我的套餐查看并核对接口域名 |
ret = 407 | 客户端非法请求 | 当前应用已过期 | 1、进行续费或续约,延长应用有效期 |
ret = 408 | 客户端非法请求 | 当前应用存在异常,已被封号 | 1、联系在线客服人工处理(系统升级维护中,或 应用存在异常已被平台封号) |
ret = 409 | 客户端非法请求 | 签名错误 | 1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级 |
ret = 410 | 客户端非法请求 | 权限不足,非系统管理员 | 1、应用权限不足,可联系在线客服咨询沟通 |
ret = 411 | 客户端非法请求 | 权限不足,应用管理员未登录 | 1、请提供应用管理员的admin_uuid和admin_token参数后重试 |
ret = 412 | 客户端非法请求 | 权限不足,非应用管理员 | 1、请在果创云把会员设置为管理员 |
ret = 413 | 客户端非法请求 | 本月接口流量超出,已被临时冻结 | 1、开通接口流量叠加包,或升级套餐 |
ret = 414 | 客户端非法请求 | 并发过高 | 1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。 |
ret = 415 | 客户端非法请求 | 接口已被开发者关闭 | 1、接口已被开发者关闭,请进入果创云接口开关重新开启 |
ret = 416 | 客户端非法请求 | 权限不足,个人免费版套餐无法使用专业版接口 | 1、请先升级终身会员/标准版/旗舰版/企业版 |
ret = 417 | 客户端非法请求 | 子应用异常,如:子应用签名错误/已过期/流量不足 | 1、使用主账号在管理和配置 客户端/子应用 |
ret = 500 | 小白接口异常 | 如果出现此错误,请联系技术人员处理 | 1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复 |
常见问题FAQ
Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。
Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果。答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。
Q3 问:请求接口时提示JSON格式错误。答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。
Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1
,或参考用反向代理解决跨域问题等3种解决方案。
Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。