• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 数据统计模块 剩余流量
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 配置模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • API开发
    • 接口源码库 推荐
    • 接口DIY (低代码开发)
    • AI写接口
  • 登录
  • 注册



YesApi 接口文档

7301 发布朋友圈标准接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/PostMoment

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.PostMoment

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

接口参数 若无特殊说明,接口参数同时支持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,欢迎使用小白开放接口!"}。
moment_content字符串可选发布的内容
moment_nickname字符串必须最大:100朋友圈用户名
moment_access整型必须最小:0;最大:2朋友圈的权限
moment_url字符串可选朋友圈的跳转链接
moment_picture1字符串可选朋友圈的图片1链接
moment_picture2字符串可选朋友圈的图片2链接
moment_picture3字符串可选朋友圈的图片3链接
moment_picture4字符串可选朋友圈的图片4链接
moment_picture5字符串可选朋友圈的图片5链接
moment_picture6字符串可选朋友圈的图片6链接
moment_picture7字符串可选朋友圈的图片7链接
moment_picture8字符串可选朋友圈的图片8链接
moment_picture9字符串可选朋友圈的图片9链接
moment_lat字符串可选朋友圈的纬度
moment_lng字符串可选朋友圈的经度
moment_place字符串可选朋友圈的位置描述
more_data字符串JSON格式可选额外需要添加的数据,即客户端自定义添加的额外字段,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...},系统保留表字段(id, uuid, add_time, update_time, ext_data)将会被忽略。JSON在线解析及格式化验证

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?s=App.Market_Minimoments.postMoment&app_key={你的app_key}&sign={动态签名}&uuid={uuid}&token={token}&moment_nickname={朋友圈发布者}&moment_content={朋友圈内容}&moment_access={朋友圈查看权限}&moment_url={朋友圈跳转链接}&moment_picture1={朋友圈图片1}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 38
    },
    "msg": "小白开放接口:App.Market_Minimoments.postMoment"
}
<?php

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

// 调用小白开放接口
$uuid='6C227C5775E547105BBD3D49756C850A';
$token='7550CABB8135AE8726D65F41E7279E616B77971FAA9AB9D2A212A50CEF69EFD1';
$rs = OkayApiClient::request('App.Market_Minimoments.postMoment',array('uuid'=>$uuid,'token'=>$token,
    'nickname'=>'test','content'=>'发朋友圈啦','access'=>'0','url'=>'http://api.okayapi.com/docs.php'));


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

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 0
		[err_msg] =>
		[id] => 26
	)
	[msg] => 小白开放接口:App.Market_Minimoments.postMoment
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.id整型新发表的朋友圈ID
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

7302 查看朋友圈标准接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/ShowMoment

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.ShowMoment

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

接口参数 若无特殊说明,接口参数同时支持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

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?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密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

7303 删除朋友圈标准接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/DeleteMoment

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.DeleteMoment

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

接口参数 若无特殊说明,接口参数同时支持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,欢迎使用小白开放接口!"}。
id字符串必须朋友圈id

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?s=App.Market_Minimoments.deleteMoment&app_key={你的app_key}&sign={动态签名}&uuid={uuid}&token={token}&id={删除的朋友圈id}

返回:
{
  "ret": 200,
  "data": {
      "err_code": 0,
      "err_msg": ""
  },
  "msg": "小白开放接口:App.Market_Minimoments.deleteMoment"
}
<?php

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

// 调用小白开放接口
$uuid='6C227C5775E547105BBD3D49756C850A';
$token='7550CABB8135AE8726D65F41E7279E616B77971FAA9AB9D2A212A50CEF69EFD1';
$rs = OkayApiClient::request('App.Market_Minimoments.deleteMoment',array('uuid'=>$uuid,'token'=>$token,'id'=>'26'));


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

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 0
		[err_msg] =>
	)
	[msg] => 小白开放接口:App.Market_Minimoments.deleteMoment
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

7304 朋友圈点赞接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/GiveLike

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.GiveLike

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

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
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,欢迎使用小白开放接口!"}。
id字符串必须朋友圈id

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?s=App.Market_Minimoments.giveLike&app_key={你的app_key}&sign={动态签名}&uuid={uuid}&token={token}&id={点赞的朋友圈id}


返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "小白开放接口:App.Market_Minimoments.giveLike"
}
<?php

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

// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Minimoments.giveLike',array('id'=>'25'));

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

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 0
		[err_msg] =>
	)
	[msg] => 小白开放接口:App.Market_Minimoments.giveLike
)
*/

// 调用小白开放接口,id不存在(已删除)
$rs1 = OkayApiClient::request('App.Market_Minimoments.giveLike',array('id'=>'26'));

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

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 1
		[err_msg] => 该朋友圈id不存在
	)
	[msg] => 小白开放接口:App.Market_Minimoments.giveLike
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

7305 获取我的朋友圈接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/GetMyMoment

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.GetMyMoment

接口描述: 接口超市-迷你朋友圈-获取我的朋友圈,使用前请先安装迷你朋友圈插件。

接口参数 若无特殊说明,接口参数同时支持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,欢迎使用小白开放接口!"}。
page整型可选1最小:1第几页
perpage整型可选20最小:1;最大:100分页数量
more_select字符串用,分割可选需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?s=App.Market_Minimoments.getMyMoment&app_key={你的app_key}&sign={动态签名}&page={第几页}&perpage={每次显示多少条}&uuid={uuid}&token={token}


返回:
{
  "ret": 200,
  "data": {
  "err_code": 0,
  "err_msg": "",
  "total": 13,
  "items": [
  {
        "id": 38,
        "moment_nickname": "test",
        "moment_content": "发朋友圈啦",
        "moment_url": "http://api.okayapi.com/docs.php",
        "moment_createtime": "2019-02-20 00:02:01",
        "moment_like": "0",
        "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
        },
        {
        "id": 37,
        "moment_nickname": "test",
        "moment_content": "发朋友圈啦",
        "moment_url": "http://api.okayapi.com/docs.php",
        "moment_createtime": "2019-02-18 10:27:10",
        "moment_like": "0",
        "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
        },
        {
        "id": 36,
        "moment_nickname": "test",
        "moment_content": "发朋友圈啦",
        "moment_url": "http://api.okayapi.com/docs.php",
        "moment_createtime": "2019-02-18 10:26:50",
        "moment_like": "0",
        "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
        },
        {
        "id": 35,
        "moment_nickname": "test",
        "moment_content": "发朋友圈啦",
        "moment_url": "http://api.okayapi.com/docs.php",
        "moment_createtime": "2019-02-18 10:17:32",
        "moment_like": "0",
        "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.getMyMoment"
}
<?php

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

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


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

/*
Array
(
	[ret] => 200
	[data] => Array
	(
		[err_code] => 0
		[err_msg] =>
        [total] => 2
		[items] => Array
		(
			[0] => Array ( [id] => 2 [moment_nickname]=>sHuXnHs  [moment_content] => 第二条朋友圈 [moment_url] =>  [moment_createtime] => 2019-02-15 19:27:35 [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] => 1 [moment_nickname]=>sHuXnHs  [moment_content] => 第一条朋友圈 [moment_url] =>  [moment_createtime] => 2019-02-15 16:40:35 [moment_like] => 3 [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.getMyMoment
)
*/

接口返回及数据结构

返回字段类型说明
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密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

7306 搜索朋友圈接口

接口路径(新):http://hn2.api.okayapi.com/api/App/Market_Minimoments/SearchMoment

接口路径(旧):http://hn2.api.okayapi.com/?s=App.Market_Minimoments.SearchMoment

接口描述: 接口超市-迷你朋友圈-搜索朋友圈,根据搜索条件搜索朋友圈。注意,游客只能搜索权限为“全部”的朋友圈,登录用户可额外搜索“登陆可见”,会员自己可额外搜索“仅自己可见”的。使用前请先安装迷你朋友圈插件。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
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,欢迎使用小白开放接口!"}。
moment_nickname字符串可选昵称,精确匹配。注意,如果搜索指定的昵称,将不会显示当前登录用户的朋友圈,并且只会显示该昵称下开放的朋友圈。
moment_content字符串可选朋友圈内容,支持模糊匹配
moment_place字符串可选位置描述,支持模糊匹配
min_moment_like整型可选0最小:0最小点赞数
max_moment_like整型可选0最小:0最大点赞数,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。
min_moment_lat浮点型可选0.0最小纬度
max_moment_lat浮点型可选0.0最小纬度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。
min_moment_lng浮点型可选0.0最小经度
max_moment_lng浮点型可选0.0最小经度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。
min_moment_createtime日期可选0开始发布时间,格式时间戳,如:1565518810,为空时不过滤。
max_moment_createtime日期可选0结束发布时间,格式为时间戳,为空时不过滤。区间判断原则:前等后不等。即小于且不等于结束时间。
more_select字符串用,分割可选需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid
page整型可选1最小:1第几页
perpage整型可选20最小:1;最大:1000分页数量

客户端请求示例

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

接口返回及数据结构

返回字段类型说明
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密钥字符串),若需要关闭或开启请提交工单

特别注意:当前 hn2.api.okayapi.com 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次