Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by zhouxiang
Commit 6408de6019119b4bc07ee6eb5f9cbeb8309daaa0 1 parent 4272b288

update

Inline Side-by-side
Showing 1 changed file with 262 additions and 0 deletions
  1 +## 1、获取用户浏览记录商品列表 ##
  2 +
  3 +获取用户浏览记录商品列表（?method=app.browse.product）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +#### 请求参数
  13 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  14 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  15 +|uid|int|否|1-11|3566164||用户id|
  16 +|page|int|否||1||页数|
  17 +|limit|int|否||10||一页显示条数|
  18 +#### 接口说明
  19 +| 接口说明||
  20 +|:-------| -----:|
  21 +|请求域名|http://api.yoho.cn|
  22 +|接口名|app.browse.product|
  23 +|获取用户浏览记录商品列表|
  24 +|http请求方式|POST/GET|
  25 +#### 返回错误
  26 +|错误code|错误提示|
  27 +|:-------| -----:|
  28 +|500|请先登录|
  29 +
  30 +注意，通用的头部没有列出。
  31 +请求示例
  32 +http://192.168.102.205:8080/gateway?method=app.browse.product&uid=8040080&page=1&limit=10
  33 +
  34 +### 响应
  35 +code为200即为成功，否则是失败。
  36 +响应参数，data部分
  37 +响应成功JSON格式如下所示:
  38 +```json
  39 +{
  40 + "code": 200,
  41 + "message": "Sales Product List",
  42 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  43 + "alg": "SALT_MD5",
  44 + "data": []
  45 +}
  46 +```
  47 +响应失败JSON格式如下所示:
  48 +```json
  49 +{
  50 + "code": 500,
  51 + "message": "请先登录",
  52 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  53 + "alg": "SALT_MD5",
  54 + "data": []
  55 +}
  56 +```
  57 +
  58 +
  59 +2.删除/清空用户浏览记录
  60 +删除/清空用户浏览记录（?method=app.browse.delete）
  61 +#### 公共请求参数
  62 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  63 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  64 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  65 +|app_version|float|10|否|1||APP版本|
  66 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  67 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  68 +|screen_size|string|20|否|800x900||（手机尺寸）|
  69 +#### 请求参数
  70 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  71 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  72 +|uid|int|否|1-11|8004080||用户id|
  73 +|skn|String|否|1-11|51082157||skn|
  74 +|category_id|String|否|1-5|123||分类id|
  75 +#### 接口说明
  76 +| 接口说明||
  77 +|:-------| -----:|
  78 +|请求域名|http://api.yoho.cn|
  79 +|接口名|app.browse.delete|
  80 +|删除/清空用户浏览记录|
  81 +|http请求方式|POST/GET|
  82 +
  83 +#### 返回错误
  84 +|错误code|错误提示|
  85 +|:-------| -----:|
  86 +|400|用户ID错误|
  87 +|400|请先登录|
  88 +
  89 +注意，通用的头部没有列出。
  90 +请求示例
  91 +http://192.168.102.205:8080/gateway?method=app.browse.delete&uid=8004080&skn=51082157&category_id=125
  92 +### 响应
  93 +code为200即为成功，否则是失败。
  94 +响应参数，data部分
  95 +响应成功JSON格式如下所示:
  96 +```json
  97 +{
  98 + "code": 200,
  99 + "message": "delete success",
  100 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  101 + "alg": "SALT_MD5",
  102 + "data": []
  103 +}
  104 +```
  105 +响应失败JSON格式如下所示:
  106 +```json
  107 +{
  108 + "code": 400,
  109 + "message": "用户ID错误",
  110 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  111 + "alg": "SALT_MD5",
  112 + "data": []
  113 +}
  114 +```
  115 +```json
  116 +{
  117 + "code": 400,
  118 + "message": "请先登录",
  119 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  120 + "alg": "SALT_MD5",
  121 + "data": []
  122 +}
  123 +```
  124 +
  125 +## 3、批量新增浏览记录 ##
  126 +
  127 +批量新增浏览记录（?method=app.browse.addBrowseBatch）
  128 +#### 公共请求参数
  129 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  130 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  131 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  132 +|app_version|float|10|否|1||APP版本|
  133 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  134 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  135 +|screen_size|string|20|否|800x900||（手机尺寸）|
  136 +#### 请求参数
  137 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  138 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  139 +|uid|String|否|1-11|8040080||用户id|
  140 +|udid|String|否|1-100|f5f38dbc1ec9ddde5ee8bff4091bdf960f76d532||udid|
  141 +|browseList|String|否||[{"product_skn":"51082157","category_id":"1"},{"product_skn":"51149414","category_id":"1"}]||批量浏览记录|
  142 +#### 接口说明
  143 +| 接口说明||
  144 +|:-------| -----:|
  145 +|请求域名|http://api.yoho.cn|
  146 +|接口名|app.browse.addBrowseBatch|
  147 +|接口说明|批量新增浏览记录|
  148 +|http请求方式|POST/GET|
  149 +
  150 +#### 返回错误
  151 +|错误code|错误提示|
  152 +|:-------| -----:|
  153 +|400|用户ID错误|
  154 +|400|浏览记录列表为空|
  155 +
  156 +注意，通用的头部没有列出。
  157 +请求示例
  158 +http://192.168.102.205:8080/gateway?method=app.browse.addBrowseBatch&uid=8040080&udid=f5f38dbc1ec9ddde5ee8bff4091bdf960f76d532&browseList=[{"product_skn":"51082157","category_id":"1"},{"product_skn":"51149414","category_id":"1"}]
  159 +### 响应
  160 +code为200即为成功，否则是失败。
  161 +响应参数，data部分
  162 +响应成功JSON格式如下所示:
  163 +```json
  164 +{
  165 + "alg": "SALT_MD5",
  166 + "code": 200,
  167 + "data": 6,
  168 + "md5": "b3ba9f9280e241bff5f4b630cbedd06e",
  169 + "message": "addBrowseBatch success"
  170 +}
  171 +```
  172 +
  173 +响应失败JSON格式如下所示:
  174 +```json
  175 +{
  176 + "code": 400,
  177 + "message": "用户ID错误",
  178 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  179 + "alg": "SALT_MD5",
  180 + "data": []
  181 +}
  182 +```
  183 +```json
  184 +{
  185 + "code": 400,
  186 + "message": "浏览记录列表为空",
  187 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  188 + "alg": "SALT_MD5",
  189 + "data": []
  190 +}
  191 +```
  192 +
  193 +## 4、获取浏览记录的数量 ##
  194 +
  195 +获取浏览记录的数量（?method=app.home.getInfoNum）
  196 +#### 公共请求参数
  197 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  198 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  199 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  200 +|app_version|float|10|否|1||APP版本|
  201 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  202 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  203 +|screen_size|string|20|否|800x900||（手机尺寸）|
  204 +#### 请求参数
  205 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  206 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  207 +|uid|int|否|1-11|8040080||用户id|
  208 +|udid|String|否|1-100|f5f38dbc1ec9ddde5ee8bff4091bdf960f76d532||udid|
  209 +#### 接口说明
  210 +| 接口说明||
  211 +|:-------| -----:|
  212 +|请求域名|http://api.yoho.cn|
  213 +|接口名|app.home.getInfoNum|
  214 +|接口说明|获取浏览记录的数量|
  215 +|http请求方式|POST/GET|
  216 +
  217 +#### 返回错误
  218 +|错误code|错误提示|
  219 +|:-------| -----:|
  220 +|500|uid is null|
  221 +
  222 +注意，通用的头部没有列出。
  223 +请求示例
  224 +http://192.168.102.205:8080/gateway?method=app.home.getInfoNumu&uid=8040080&udid=f5f38dbc1ec9ddde5ee8bff4091bdf960f76d532
  225 +### 响应
  226 +code为200即为成功，否则是失败。
  227 +响应参数，data部分
  228 +响应成功JSON格式如下所示:
  229 +```json
  230 +{
  231 + "alg": "SALT_MD5",
  232 + "code": 200,
  233 + "data": {
  234 + "brand_favorite_total": 0,
  235 + "comment_total": 0,
  236 + "coupon_num": 0,
  237 + "inbox_total": 0,
  238 + "limitCodeNum": 0,
  239 + "product_browse": 20,
  240 + "product_favorite_total": 1,
  241 + "refund_exchange_num": 0,
  242 + "send_cargo_num": 0,
  243 + "showOrderNum": 1,
  244 + "toShareOrderNum": 1,
  245 + "wait_cargo_num": 0,
  246 + "wait_pay_num": 0,
  247 + "yoho_coin_num": 0
  248 + },
  249 + "md5": "bc44aca8c575ddf9718fd73d7ba07852",
  250 + "message": "Get info num is success!"
  251 +}
  252 +```
  253 +响应失败JSON格式如下所示:
  254 +```json
  255 +{
  256 + "code": 500,
  257 + "message": "uid is null",
  258 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  259 + "alg": "SALT_MD5",
  260 + "data": []
  261 +}
  262 +