帮助搜索.md
2.33 KB
1、帮助搜索
帮助搜索（method=app.helper.search）
公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|---|---|---|---|---|---|---|
| client_secret | string | 50 | 否 | 5ac68f20cb18efe154be | 进入接口提供的参数加密信息 | |
| app_version | float | 10 | 否 | 1 | APP版本 | |
| os_version | string | 20 | 否 | Android4.4 | 系统版本+机器型号 | |
| client_type | string | 20 | 否 | iphone/android/ipad | 手机型号（不区分大小写） | |
| screen_size | string | 20 | 否 | 800x900 | （手机尺寸） |
请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|---|---|---|---|---|---|---|
| showPlatform | String | 否 | yohobuy_pc | 显示平台:yohobuy_ios/yohobuy_pc | ||
| keyword | String | 否 | 关键词 | |||
| page | String | 是 | 1 | 页码 | ||
| viewNum | String | 是 | 条数 | |||
| firstCategoryId | String | 是 | 一级帮助分类ID | |||
| secendCategoryId | String | 是 | 二级帮助分类ID | |||
| isFaq | String | 是 | 是否是常见问题 | |||
| isRobotQa | String | 是 | 是否是机器人 | |||
| isCustomerService | String | 是 | 是否是机器人 | |||
| status | String | 是 | 状态 | |||
| helperType | String | 是 | 帮助类型 |
接口说明
| 接口说明 | |
|---|---|
| 请求域名 | http://api.yoho.cn |
| 接口名 | method=app.helper.search |
| 接口说明 | 校验是否是注册用户 |
| http请求方式 | POST/GET |
返回错误
| 错误code | 错误提示 |
|---|---|
| 500 | 参数缺失 |
注意，通用的头部没有列出。
请求示例
?method=app.helper.search&showPlatform=yohobuy_pc&keyword=退货&debug=XYZ
响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON(BLK-PC)格式如下所示:
{
"alg": "SALT_MD5",
"code": 200,
"data":
{
"code": 200,
"data":
{
"helper_list":
[
{
"caption": "如何登录注册呢？",
"id": "28"
}
],
"total": 1,
"page_total": 1,
"page": 1,
"page_size": 10
},
"message": "success"
},
"md5": "0f1f09eee18ad4ddac21825ea7103c45",
"message": "操作成功"
}