接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
message_key | 字符串 | 可选 | 最大:64 | 评论的唯一标识,例如某篇文章,精准匹配此项 | |
order | 整型 | 可选 | 1 | 1按评论时间顺序显示,2按评论时间逆序 | |
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:100 | 分页数量 |
more_select | 字符串用,分割 | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
在线测试
参数 | 是否必填 | 值 |
---|---|---|
s | 固定 | |
uuid | 可选 | |
token | 可选 | |
return_data | 可选 | |
message_key | 可选 | |
order | 可选 | |
page | 可选 | |
perpage | 可选 | |
more_select | 可选 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Market_Message.Show&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 3, // 顶层评论总数
"items": [
{
"id": 8,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:21:27",
"message_pid": 0,
"child": [
]
},
{
"id": 9,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:21:28",
"message_pid": 0,
"child": [ // 第二层评论(即:评论的评论)
{
"id": 11,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:21:45",
"message_pid": 9,
"child": [ // 第三层评论(即:评论的评论的评论)
{
"id": 13,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:22:00",
"message_pid": 11
},
{
"id": 14,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:35:13",
"message_pid": 11
}
]
},
{
"id": 12,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:21:50",
"message_pid": 9,
"child": [
]
}
]
},
{
"id": 10,
"message_nickname": "dogstar",
"message_content": "test",
"message_post_time": "2018-12-02 11:21:29",
"message_pid": 0,
"child": [
]
}
]
},
"msg": "当前请求接口:App.Market_Message.Show"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Message.Show');
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[total] => 6
[items] => Array
(
[0] => Array ( [id] => 1 [message_nickname] => 小白君 [message_content] =>小白接口真棒![message_post_time] => 2019-01-30 12:00:00 [message_pid] => 0 [child] => Array ( ) )
[1] => Array ( [id] => 2 [message_nickname] => dogstar [message_content] =>欢迎使用小白接口^_^ [message_post_time] => 2019-01-30 18:00:00 [message_pid] => 0 [child] => Array ( ) )
[2] => Array ( [id] => 3 [message_nickname] => 游客 [message_content] => 好用,五星好评! [message_post_time] => 2019-01-30 20:00:00 [message_pid] => 0 [child] => Array ( ) )
[3] => Array ( [id] => 4 [message_nickname] => 小白 [message_content] => 加油! [message_post_time] => 0000-00-00 00:00:00 [message_pid] => 0 [child] => Array ( ) )
[4] => Array ( [id] => 5 [message_nickname] => 小白 [message_content] => 小白接口服务大众 [message_post_time] => 0000-00-00 00:00:00 [message_pid] => 0 [child] => Array ( ) )
)
)
[msg] => 小白开放接口:App.Market_Message.Show
)
*/
接口返回及数据结构
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 顶层评论总数 |
data.items | 字符串 | 评论列表 |
data.items[].id | 整型 | 评论ID |
data.items[].message_content | 字符串 | 内容,支持HTML格式 |
data.items[].message_nickname | 字符串 | 留言用户名 |
data.items[].message_post_time | 字符串 | 留言时间 |
data.items[].message_pid | 整型 | 评论的父级ID,为0时表示没有父级 |
data.items[].child | 字符串 | 评论的评论,多层嵌套 |
data.items[].moreSelect | string/int | 返回的更多的字段 |
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万次接口流量奖励。