小白接口
接口地址:http://api.yesapi.cn/?s=App.Hello.World
接口描述: 入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名
接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签
在线测试
添加收藏
直接访问接口
我要调整此接口
接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
app_key | 字符串 | 必须 | | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 |
sign | 字符串 | 可选 | | | 公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包。
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。
企业版支持专属签名算法定制。 |
uuid | 字符串 | 可选 | | 最大:32 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。 |
token | 字符串 | 可选 | | 最小:64;最大:64 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。 |
return_data | 字符串 | 可选 | 0 | | 公共参数 数据返回结构,其中:
- return_data=0,返回完整的接口结果,示例:
{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"} ;
- return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:
{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"} 。
|
name | 字符串 | 必须 | | | 随便一个名字参数 |
在线测试
客户端请求示例
查看我的接口域名、app_key和app_secrect
客户端接入指南(如何生成签名)
开启/关闭签名
请求:
{你的接口域名}/?s=App.Hello.World&name=OKAYAPI&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"title": "Hello OKAYAPI!"
},
"msg": ""
}
<?php
// 引入PHP SDK文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口(根据需要,可动态调整请求参数)
$rs = OkayApiClient::request('App.Hello.World', array('name' => 'dogstar'), 3000);
// 输出结果
print_r($rs);
/**
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[title] => Hi dogstar,欢迎使用小白接口!
)
[msg] => 小白开放接口:App.Hello.World
)
*/
#!/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.Hello.World', 'name': 'dogstar'}
# 发起请求
return HTTPGet(API_URL, params)
print(main())
# {u'msg': u'\u5f53\u524d\u5c0f\u767d\u63a5\u53e3\uff1aApp.Hello.World', u'data': {u'title': u'Hi dogstar\uff0c\u6b22\u8fce\u4f7f\u7528\u5c0f\u767d\u63a5\u53e3\uff01', u'err_msg': u'', u'err_code': 0}, u'ret': 200}
import yesapi from '../../utils/YesApi/yesapi.js';
/**
* 小白接口请求示例
*/
okayApiHelloWorld: function(e) {
/**
* 准备接口参数(根据需要,可动态调整请求参数)
*/
let params = {
s: "Hello.World", // 必须,待请求的接口服务名称
name: "dogstar" // 可选,根据接口文档,补充更多接口参数
};
let _self = this
/**
* 对小白接口发起请求
*/
wx.request({
url: app.globalData.okayapiHost, // 使用小白接口的域名,或者PHP代理域名
data: okayapi.enryptData(params), // 如果直接调用小白接口,需要在小程序里生成签名
method: "POST", // 通常情况下都可使用POST方式调用小白开放接口
header: { "Content-Type": "application/x-www-form-urlencoded" }, // 大坑:如果使用的是POST请求,一定要设置这个header,不然参数无法POST
success: function (wxRes) {
// TODO:实现你的梦想……
let res = wxRes.data
if (res.data && res.data.err_code == 0) {
// TODO:请求成功
console.log('ok: ', res.data)
} else {
// TODO:当前操作失败
console.log('fail: ', res)
}
}
})
}
JS SDK 下载:https://github.com/yesapicn/yesapi-wxmini-sdk
接口使用帮助说明
小白君正在拼命补充中……
返回结构说明
返回字段 | 类型 | 说明 |
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.title | 字符串 | 测试标题 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
ret异常错误码
错误码 | 错误类型 | 错误描述信息 | 解决方法 |
ret = 200 | 成功 | 请求成功 | |
ret = 400 | 客户端非法请求 | 非法请求,参数错误 | 1、根据接口文档的接口参数,提供正确的参数 |
ret = 404 | 客户端非法请求 | 接口服务不存在 | 1、查看小白接口大全,确保接口服务名称拼写正确 |
ret = 500 | 小白接口异常 | 如果出现此错误,请联系技术人员处理 | 1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复 |
ret = 401 | 客户端非法请求 | 用户未登录,或登录凭证已过期 | 1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口 |
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、请先升级终身会员/标准版/旗舰版/企业版 |
常见问题FAQ
Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。