接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况:
| |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
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二选一) |
在线测试
参数 | 是否必填 | 值 |
---|---|---|
s | 固定 | |
uuid | 可选 | |
token | 可选 | |
return_data | 可选 | |
model_name | 必须 | |
model_uuid | 可选 | |
check_code | 可选 | |
data | 可选 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求(使用data的JSON格式传递,data和data_X二选一):
{你的接口域名}/?s=App.Table.Create&model_name=article&data={"title":"123456"}&app_key={你的app_key}&sign={动态签名}
请求(使用data_X动态参数传递,data和data_X二选一):
{你的接口域名}/?s=App.Table.Create&model_name=article&data_title=123456&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口(第一个示例:从省份开始选择):
$rs = OkayApiClient::request('App.Table.Create',array('model_name'=>'telephone','data'=>json_encode(array("mobile"=>"13088886666","mobile_status"=>"1"))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] =>
Array
(
[err_code] => 0
[err_msg] =>
[id] => 6
)
[msg] => 小白开放接口:App.Table.Create
)
*/
#!/usr/bin/python
#coding=utf-8
import requests
import hashlib
# TODO: 请根据需要,换成您的HOST,app_key和app_secrect
API_URL = '你的小白接口域名,例如:http://api.okayapi.com/'
APP_KEY = '你的app_key'
APP_SECRET = '你的app_secrect'
# 生成签名
def Signature(params, key=None, secret=None):
key = key or APP_KEY
secret = secret or APP_SECRET
params.pop('app_secrect', None)
params['app_key'] = key
md5_ctx = hashlib.md5()
md5_ctx.update(''.join([params[value] for value in sorted([key for key in params])]) + secret)
return md5_ctx.hexdigest().upper()
# 调用小白开放接口
def HTTPGet(url, params):
params['sign'] = Signature(params)
resp = requests.get(url, params)
return resp.json()
def main():
# 待请求的接口与相关参数(根据需要,可动态调整请求参数)
params = {
's': 'App.Table.Create',
'model_name': 'okayapi_message',
'data': json.dumps({'message_nickname': 'test', 'message_key': 'aba'})
}
# 发起请求
return HTTPGet(API_URL, params)
pprint.pprint(main())
# {u'data': {u'err_code': 0, u'err_msg': u'', u'id': u'6'},
# u'msg': u'\u5f53\u524d\u5c0f\u767d\u63a5\u53e3\uff1aApp.Table.Create',
# u'ret': 200}
/**
* 准备接口参数
*/
var data = {title:"123456"};
var params = {
s: "App.Table.Create", // 待请求的接口服务名称
name: "article", // 更多接口参数
data: JSON.stringify(data), // 转JSON格式
callback: "onCallback" // 客户端的JS回调函数
};
/**
* 发起JSONP请求
*/
$.ajax({
url: 'http://api.yesapi.cn/', // TODO:你的接口域名
dataType: 'jsonp',
jsonpCallback: params.callback,
cache: true,
data: enryptData(params) // 动态加密
}).done(function (rs) {
console.log("done");
console.log(rs);
});
/**
* TODO: 客户端的JS回调函数
*/
function onCallback(rs) {
console.log("onCallback");
console.log(rs);
alert("果创云开放接口请求完毕,请查看控制台!");
}
/**
* 生成小白接口签名
*/
function enryptData(params) {
// TODO:请改成您的app_key
const OKAYAPI_APP_KEY = "16BD4337FB1D355902E0502AFCBFD4DF";
// TODO:请改成您的app_secrect,请勿对外暴露!!
const OKAYAPI_APP_SECRECT = "4c1402596e4cd017eeaO670df6f8B6783475b4ac8A32B4900f20abP2159711ad";
params['app_key'] = OKAYAPI_APP_KEY;
var sdic = Object.keys(params).sort();
var paramsStrExceptSign = "";
for(ki in sdic){
paramsStrExceptSign += params[sdic[ki]];
}
var sign = md5(paramsStrExceptSign + OKAYAPI_APP_SECRECT).toUpperCase();
params['sign'] = sign;
return params;
}
接口返回及数据结构
返回字段 | 类型 | 说明 |
---|---|---|
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密钥字符串) |
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万次接口流量奖励。