YesApi 接口文档

7201 发布评论标准接口

接口路径(新)：http://hn216.api.okayapi.com/api/App/Market_Message/Post

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Market_Message.Post

接口描述： 热门 接口超市-留言板-发布评论，使用前请先安装留言评论插件。

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
message_content字符串必须留言内容，支持HTML格式
message_nickname字符串可选最大：32留言用户名
message_key字符串可选最大：64评论的唯一标识，例如某篇文章
message_pid整型可选0最小：0嵌套评论时的父级评论ID，没有时为0，目前最多支持三层嵌套
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_Message.Post&message_content=test&message_nickname=dogstar&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 14
    },
    "msg": "当前请求接口：App.Market_Message.Post"
}

<?php

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

// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Message.Post',array('model_name'=>'okayapi_message','message_nickname'=>'小白','message_content'=>'小白接口服务大众'));
// 输出结果
print_r($rs);


/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[id] => 5 
	) 
	
	[msg] => 小白开放接口：App.Market_Message.Post 
)
*/

接口返回及数据结构

返回字段类型说明
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 接口文档

7202 获取评论列表标准接口

接口路径(新)：http://hn216.api.okayapi.com/api/App/Market_Message/Show

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Market_Message.Show

接口描述： 接口超市-留言板-获取评论列表，根据唯一标识，获取评论数据，支持多级嵌套（最多三层）。使用前请先安装留言评论插件

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
message_key字符串可选最大：64评论的唯一标识，例如某篇文章，精准匹配此项
order整型可选11按评论时间顺序显示，2按评论时间逆序
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：100分页数量
more_select字符串用,分割可选需要返回的更多字段，例如客户端额外添加的自定义字段和小白系统字段。如：more_select=id,uuid

客户端请求示例

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

HTTP通用示例PHP示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
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[].message_content字符串内容，支持HTML格式
data.items[].message_nickname字符串留言用户名
data.items[].message_post_time字符串留言时间
data.items[].message_pid整型评论的父级ID，为0时表示没有父级
data.items[].child字符串评论的评论，多层嵌套
data.items[].moreSelectstring/int返回的更多的字段
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

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

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