YesApi 接口文档

7302 查看朋友圈标准接口 App.Market_Minimoments.ShowMoment

接口路径(新):http://demo.phalapi.net/api/App/Market_Minimoments/ShowMoment

接口路径(旧):http://demo.phalapi.net/?s=App.Market_Minimoments.ShowMoment

接口描述: 接口超市-迷你朋友圈-查看朋友圈,使用前请先安装迷你朋友圈插件

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

接口流量
1
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小:32;最大:32UUID,全局唯一用户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","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
lastid整型可选最小:2上次最后阅读的id,默认从最开始一条加载
perpage整型可选20最小:1;最大:100分页数量
more_select字符串用,分割可选需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid

在线测试

参数是否必填
s 固定
uuid 可选
token 可选
return_data 可选
lastid 可选
perpage 可选
more_select 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
{你的接口域名}/?s=App.Market_Minimoments.showMoment&app_key={你的app_key}&sign={动态签名}&lastid={上次查看的id}&perpage={每次显示多少条}&uuid={uuid}&token={token}

返回:
{
  "ret": 200,
  "data": {
        "err_code": 0,
        "err_msg": "",
        "total": 28,
        "items": [
              {
                "id": 1,
                "moment_nickname": "sHuXnHs",
                "moment_content": "第一条朋友圈",
                "moment_url": null,
                "moment_createtime": "2019-02-15 16:40:35",
                "moment_like": "3",
                "moment_picture1": null,
                "moment_picture2": null,
                "moment_picture3": null,
                "moment_picture4": null,
                "moment_picture5": null,
                "moment_picture6": null,
                "moment_picture7": null,
                "moment_picture8": null,
                "moment_picture9": null,
                "moment_lat": null,
                "moment_lng": null,
                "moment_place": null
              }
        ]
  },
  "msg": "小白开放接口:App.Market_Minimoments.showMoment"
}
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$uuid='6C227C5775E547105BBD3D49756C850A';
$token='7550CABB8135AE8726D65F41E7279E616B77971FAA9AB9D2A212A50CEF69EFD1';
$rs = OkayApiClient::request('App.Market_Minimoments.showMoment',array('uuid'=>$uuid,'token'=>$token,'lastid'=>'10','perpage'=>'2'));

// 输出结果
print_r($rs);

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 0
		[err_msg] =>
        [total] => 22
		[items] => Array
		(
			[0] => Array ( [id] => 9  [moment_nickname]=>sHuXnHs [moment_content] => 我在发朋友圈 [moment_url] =>  [moment_createtime] => 2019-02-15 20:18:34 [moment_like] => 0 [moment_picture1]=>  [moment_picture2]=>  [moment_picture3]=>  [moment_picture4]=>  [moment_picture5]=>  [moment_picture6]=>  [moment_picture7]=>  [moment_picture8]=>  [moment_picture9]=>  [moment_lat]=>  [moment_lng)=> [moment_place]=> )
			[1] => Array ( [id] => 8  [moment_nickname]=>sHuXnHs [moment_content] => 我在发朋友圈 [moment_url] =>  [moment_createtime] => 2019-02-15 20:18:34 [moment_like] => 0 [moment_picture1]=>  [moment_picture2]=>  [moment_picture3]=>  [moment_picture4]=>  [moment_picture5]=>  [moment_picture6]=>  [moment_picture7]=>  [moment_picture8]=>  [moment_picture9]=>  [moment_lat]=>  [moment_lng)=> [moment_place]=> )
		)
	)
	[msg] => 小白开放接口:App.Market_Minimoments.showMoment
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/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[].nickname字符串朋友圈发布者名称
data.items[].moment_content字符串朋友圈的内容
data.items[].moment_url字符串朋友圈跳转链接
data.items[].moment_createtime字符串朋友圈发表时间
data.items[].moment_like整型朋友圈点赞数
data.items[].moment_picture1字符串朋友圈图片1
data.items[].moment_picture2字符串朋友圈图片2
data.items[].moment_picture3字符串朋友圈图片3
data.items[].moment_picture4字符串朋友圈图片4
data.items[].moment_picture5字符串朋友圈图片5
data.items[].moment_picture6字符串朋友圈图片6
data.items[].moment_picture7字符串朋友圈图片7
data.items[].moment_picture8字符串朋友圈图片8
data.items[].moment_picture9字符串朋友圈图片9
data.items[].moment_lat字符串朋友圈发布纬度
data.items[].moment_lng字符串朋友圈发布经度
data.items[].moment_place字符串朋友圈位置描述
data.items[].moreSelectstring/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万次接口流量奖励。