YesApi接口文档 | 果创云_数据库API_500+免费接口(原名:小白接口)

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Market_Message/Post

接口路径(旧)：http://api.yesapi.net/?s=App.Market_Message.Post

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

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
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 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 7201 发布评论标准接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Message.Post`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  热门 接口超市-留言板-发布评论，使用前请先安装留言评论插件。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Market_Message.Post` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| message_content | string | 必填 | 留言内容，支持HTML格式 |
| message_nickname | string | 可选 | 留言用户名 |
| message_key | string | 可选 | 评论的唯一标识，例如某篇文章 |
| message_pid | int | 可选 | 嵌套评论时的父级评论ID，没有时为0，目前最多支持三层嵌套 |
| 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_Message.Post&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_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表示服务端异常，查看异常错误码
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密钥字符串)`，若需要关闭或开启请提交工单

YesApi 接口文档

接口路径(新)：http://api.yesapi.net/api/App/Market_Message/Show

接口路径(旧)：http://api.yesapi.net/?s=App.Market_Message.Show

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

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

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，点击查看，或免费注册。
sign	字符串	可选			公共参数接口签名，其中：关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。静态签名，简单，固定的签名，点击获取。动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。定制签名，支持个性化签名签名算法定制。
uuid	字符串	可选			公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选			公共参数数据返回结构，其中： 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	整型	可选	0		公共参数是否允许跨域请求，1表示允许，0表示不允许。
message_key	字符串	可选		最大：64	评论的唯一标识，例如某篇文章，精准匹配此项
order	整型	可选	1		1按评论时间顺序显示，2按评论时间逆序
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：100	分页数量
more_select	字符串用,分割	可选			需要返回的更多字段，例如客户端额外添加的自定义字段和小白系统字段。如：more_select=id,uuid

客户端请求示例

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

我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 7202 获取评论列表标准接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Message.Show`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  接口超市-留言板-获取评论列表，根据唯一标识，获取评论数据，支持多级嵌套（最多三层）。使用前请先安装留言评论插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Market_Message.Show` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| message_key | string | 可选 | 评论的唯一标识，例如某篇文章，精准匹配此项 |
| order | int | 可选 | 1按评论时间顺序显示，2按评论时间逆序 |
| 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[].message_content | string | 内容，支持HTML格式|
| data.items[].message_nickname | string | 留言用户名|
| data.items[].message_post_time | string | 留言时间|
| data.items[].message_pid | int | 评论的父级ID，为0时表示没有父级|
| data.items[].child | array | 评论的评论，多层嵌套|
| data.items[].moreSelect | string/int | 返回的更多的字段|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Message.Show&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_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密钥字符串)`，若需要关闭或开启请提交工单

7201 发布评论标准接口

7201 发布评论标准接口

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

客户端请求示例

接口返回

7202 获取评论列表标准接口

7202 获取评论列表标准接口

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

客户端请求示例

接口返回

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

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