接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/PostMoment
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.PostMoment
接口描述: 接口超市-迷你朋友圈-发布朋友圈,使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
| token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| 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 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7301 发布朋友圈标准接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.PostMoment`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-发布朋友圈,使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.PostMoment` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 必填 | UUID,全局唯一用户ID |
| token | string | 必填 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| moment_content | string | 可选 | 发布的内容 |
| moment_nickname | string | 必填 | 朋友圈用户名 |
| moment_access | int | 必填 | 朋友圈的权限 |
| moment_url | string | 可选 | 朋友圈的跳转链接 |
| moment_picture1 | string | 可选 | 朋友圈的图片1链接 |
| moment_picture2 | string | 可选 | 朋友圈的图片2链接 |
| moment_picture3 | string | 可选 | 朋友圈的图片3链接 |
| moment_picture4 | string | 可选 | 朋友圈的图片4链接 |
| moment_picture5 | string | 可选 | 朋友圈的图片5链接 |
| moment_picture6 | string | 可选 | 朋友圈的图片6链接 |
| moment_picture7 | string | 可选 | 朋友圈的图片7链接 |
| moment_picture8 | string | 可选 | 朋友圈的图片8链接 |
| moment_picture9 | string | 可选 | 朋友圈的图片9链接 |
| moment_lat | string | 可选 | 朋友圈的纬度 |
| moment_lng | string | 可选 | 朋友圈的经度 |
| moment_place | string | 可选 | 朋友圈的位置描述 |
| more_data | array | 可选 | 额外需要添加的数据,即客户端自定义添加的额外字段,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...},系统保留表字段(id, uuid, add_time, update_time, ext_data)将会被忽略。JSON在线解析及格式化验证 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.id | int | 新发表的朋友圈ID|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.PostMoment&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| data | object/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密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/ShowMoment
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.ShowMoment
接口描述: 接口超市-迷你朋友圈-查看朋友圈,使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
| token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证 | |
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| lastid | 整型 | 可选 | 最小:2 | 上次最后阅读的id,默认从最开始一条加载 | |
| perpage | 整型 | 可选 | 20 | 最小:1;最大:100 | 分页数量 |
| more_select | 字符串用,分割 | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7302 查看朋友圈标准接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.ShowMoment`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-查看朋友圈,使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.ShowMoment` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | UUID,全局唯一用户ID |
| token | string | 可选 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| lastid | int | 可选 | 上次最后阅读的id,默认从最开始一条加载 |
| perpage | int | 可选 | 分页数量 |
| more_select | array | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.total | int | 可见朋友圈条数|
| data.items | array | 朋友圈列表|
| data.items[].id | int | 朋友圈id|
| data.items[].nickname | string | 朋友圈发布者名称|
| data.items[].moment_content | string | 朋友圈的内容|
| data.items[].moment_url | string | 朋友圈跳转链接|
| data.items[].moment_createtime | string | 朋友圈发表时间|
| data.items[].moment_like | int | 朋友圈点赞数|
| data.items[].moment_picture1 | string | 朋友圈图片1|
| data.items[].moment_picture2 | string | 朋友圈图片2|
| data.items[].moment_picture3 | string | 朋友圈图片3|
| data.items[].moment_picture4 | string | 朋友圈图片4|
| data.items[].moment_picture5 | string | 朋友圈图片5|
| data.items[].moment_picture6 | string | 朋友圈图片6|
| data.items[].moment_picture7 | string | 朋友圈图片7|
| data.items[].moment_picture8 | string | 朋友圈图片8|
| data.items[].moment_picture9 | string | 朋友圈图片9|
| data.items[].moment_lat | string | 朋友圈发布纬度|
| data.items[].moment_lng | string | 朋友圈发布经度|
| data.items[].moment_place | string | 朋友圈位置描述|
| data.items[].moreSelect | string/int | 返回的更多的字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.ShowMoment&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| 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[].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[].moreSelect | string/int | 返回的更多的字段 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/DeleteMoment
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.DeleteMoment
接口描述: 接口超市-迷你朋友圈-删除朋友圈,使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
| token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| id | 字符串 | 必须 | 朋友圈id |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7303 删除朋友圈标准接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.DeleteMoment`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-删除朋友圈,使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.DeleteMoment` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 必填 | UUID,全局唯一用户ID |
| token | string | 必填 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | string | 必填 | 朋友圈id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.DeleteMoment&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| data | object/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密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/GiveLike
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.GiveLike
接口描述: 接口超市-迷你朋友圈-朋友圈点赞,使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| id | 字符串 | 必须 | 朋友圈id |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7304 朋友圈点赞接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.GiveLike`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-朋友圈点赞,使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.GiveLike` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | string | 必填 | 朋友圈id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.GiveLike&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| data | object/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密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/GetMyMoment
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.GetMyMoment
接口描述: 接口超市-迷你朋友圈-获取我的朋友圈,使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
| token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
| perpage | 整型 | 可选 | 20 | 最小:1;最大:100 | 分页数量 |
| more_select | 字符串用,分割 | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7305 获取我的朋友圈接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.GetMyMoment`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-获取我的朋友圈,使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.GetMyMoment` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 必填 | UUID,全局唯一用户ID |
| token | string | 必填 | 会话凭证 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| more_select | array | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.total | int | 我的朋友圈条数|
| data.items | array | 我的朋友圈列表|
| data.items[].id | int | 朋友圈id|
| data.items[].nickname | string | 朋友圈发布者名称|
| data.items[].moment_content | string | 朋友圈的内容|
| data.items[].moment_url | string | 朋友圈跳转链接|
| data.items[].moment_createtime | string | 朋友圈发表时间|
| data.items[].moment_like | int | 朋友圈点赞数|
| data.items[].moment_picture1 | string | 朋友圈图片1|
| data.items[].moment_picture2 | string | 朋友圈图片2|
| data.items[].moment_picture3 | string | 朋友圈图片3|
| data.items[].moment_picture4 | string | 朋友圈图片4|
| data.items[].moment_picture5 | string | 朋友圈图片5|
| data.items[].moment_picture6 | string | 朋友圈图片6|
| data.items[].moment_picture7 | string | 朋友圈图片7|
| data.items[].moment_picture8 | string | 朋友圈图片8|
| data.items[].moment_picture9 | string | 朋友圈图片9|
| data.items[].moment_lat | string | 朋友圈发布纬度|
| data.items[].moment_lng | string | 朋友圈发布经度|
| data.items[].moment_place | string | 朋友圈位置描述|
| data.items[].moreSelect | string/int | 返回的更多的字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.GetMyMoment&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| 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[].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[].moreSelect | string/int | 返回的更多的字段 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_Minimoments/SearchMoment
接口路径(旧):http://api.yesapi.net/?s=App.Market_Minimoments.SearchMoment
接口描述: 接口超市-迷你朋友圈-搜索朋友圈,根据搜索条件搜索朋友圈。注意,游客只能搜索权限为“全部”的朋友圈,登录用户可额外搜索“登陆可见”,会员自己可额外搜索“仅自己可见”的。使用前请先安装迷你朋友圈插件。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| 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 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7306 搜索朋友圈接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Minimoments.SearchMoment`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 接口超市-迷你朋友圈-搜索朋友圈,根据搜索条件搜索朋友圈。注意,游客只能搜索权限为“全部”的朋友圈,登录用户可额外搜索“登陆可见”,会员自己可额外搜索“仅自己可见”的。使用前请先安装迷你朋友圈插件。
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Minimoments.SearchMoment` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| moment_nickname | string | 可选 | 昵称,精确匹配。注意,如果搜索指定的昵称,将不会显示当前登录用户的朋友圈,并且只会显示该昵称下开放的朋友圈。 |
| moment_content | string | 可选 | 朋友圈内容,支持模糊匹配 |
| moment_place | string | 可选 | 位置描述,支持模糊匹配 |
| min_moment_like | int | 可选 | 最小点赞数 |
| max_moment_like | int | 可选 | 最大点赞数,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 |
| min_moment_lat | float | 可选 | 最小纬度 |
| max_moment_lat | float | 可选 | 最小纬度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 |
| min_moment_lng | float | 可选 | 最小经度 |
| max_moment_lng | float | 可选 | 最小经度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 |
| min_moment_createtime | date | 可选 | 开始发布时间,格式时间戳,如:1565518810,为空时不过滤。 |
| max_moment_createtime | date | 可选 | 结束发布时间,格式为时间戳,为空时不过滤。区间判断原则:前等后不等。即小于且不等于结束时间。 |
| more_select | array | 可选 | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.total | int | 朋友圈条数|
| data.items | array | 朋友圈列表|
| data.items[].id | int | 朋友圈id|
| data.items[].nickname | string | 朋友圈发布者名称|
| data.items[].moment_content | string | 朋友圈的内容|
| data.items[].moment_url | string | 朋友圈跳转链接|
| data.items[].moment_createtime | string | 朋友圈发表时间|
| data.items[].moment_like | int | 朋友圈点赞数|
| data.items[].moment_picture1 | string | 朋友圈图片1|
| data.items[].moment_picture2 | string | 朋友圈图片2|
| data.items[].moment_picture3 | string | 朋友圈图片3|
| data.items[].moment_picture4 | string | 朋友圈图片4|
| data.items[].moment_picture5 | string | 朋友圈图片5|
| data.items[].moment_picture6 | string | 朋友圈图片6|
| data.items[].moment_picture7 | string | 朋友圈图片7|
| data.items[].moment_picture8 | string | 朋友圈图片8|
| data.items[].moment_picture9 | string | 朋友圈图片9|
| data.items[].moment_lat | string | 朋友圈发布纬度|
| data.items[].moment_lng | string | 朋友圈发布经度|
| data.items[].moment_place | string | 朋友圈位置描述|
| data.items[].moreSelect | string/int | 返回的更多的字段|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Minimoments.SearchMoment&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| 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[].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[].moreSelect | string/int | 返回的更多的字段 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次