Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by 匡佳华
Commit e6aec5234f47c1e0c255d7d919dc449afa5ddee8 1 parent a8f072f9

Update 个人信息.md

Inline Side-by-side
Showing 1 changed file with 132 additions and 190 deletions
1 -## 1、修改用户生日 （判断用户是否可以修改生日也 调用这个接口 ） #  
2 -  
3 -修改用户生日#（method=app.passport.modifyBirthday）  
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||（手机尺寸）| 1 +## 1、百度API文本审核 #
12 2
  3 +百度API文本审核#（method=${yoho.reviewed.controller.url}/textAudit/textAudit）
13 #### 请求参数 4 #### 请求参数
14 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
15 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
16 -|uid|Integer|1-11|否|123333||用户id|  
17 -|birthday|String|1-11|是|1990-10-01||用户生日|  
18 -|business_line|String|1-11|否|yohobuy||业务线| 5 +| 参数名称 | 参数类型 | 长度 | 是否必填 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|uid|Integer||否|3801009||若填写，随结果返回|
  8 +|content|String|255|是|昵称测试💰 🐧💰||需审核文本|
  9 +|scenName|String|255|是|NICKENAME_CENSOR(暂定)||审核场景名称|
  10 +|license|String|255|是|22c5c86b-3dad-473b-8688-a386a0695343(暂定)||场景安全码，由我们提供|
  11 +|businessLine|String|255|是|uic(暂定)||业务线，必须与场景对应的一致|
  12 +|context|String|255|是|uic(暂定)||调用方webContext，必须与场景对应的一致|
19 13
20 #### 接口说明 14 #### 接口说明
21 -| 接口说明|| 15 +| 接口说明||
22 |:-------| -----:| 16 |:-------| -----:|
23 -|请求域名|http://api.yoho.cn|  
24 -|接口名|app.passport.modifyBirthday|  
25 -|接口说明|修改用户生日| 17 +|请求域名|${yoho.reviewed.controller.url}|
  18 +|接口名|textAudit/textAudit|
  19 +|接口说明|百度API文本审核|
26 |http请求方式|POST/GET| 20 |http请求方式|POST/GET|
27 -#### 返回错误  
28 -|错误code|错误提示| 21 +
  22 +#### 返回信息
  23 +|返回字段|描述|
29 |:-------| -----:| 24 |:-------| -----:|
30 -|500|uid is null|  
31 -注意，通用的头部没有列出。  
32 -请求示例  
33 -?method=app.passport.modifyBirthday&uid=121335423&birthday=1990-10-10&business_line=yohobuy 25 +|code|返回码|
  26 +|message|提示信息|
  27 +|date|返回对象|
  28 +|-responseCode|本次审核唯一标志|
  29 +|-resultCode|审核结果 1: 通过，2: 不通过|
  30 +|-rejectWord|违规词，审核通过则为空|
  31 +|-resultDatas|百度api返回信息|
  32 +|-uid|若请求参数中传了uid则带回|
  33 +
34 34
  35 +请求示例
  36 +${yoho.reviewed.controller.url}/textAudit/textAudit?sceneName=NICKENAME_CENSOR&businessLine=uic&context=uic-gateway&license=22c5c86b-3dad-473b-8688-a386a0695343&uid=38010009&content=昵称测试💰 🐧💰
35 ### 响应 37 ### 响应
36 -code为200即为成功，否则是失败。  
37 -响应参数，data部分  
38 -响应成功JSON格式如下所示，修改成功后也会返回当前是否可修改  
39 38
  39 +审核通过JSON格式如下所示
40 ```json 40 ```json
41 - {  
42 - "alg": "SALT_MD5",  
43 - "code": 200,  
44 - "data": {  
45 - "isCanModifyBirthday": "Y"  
46 - },  
47 - "md5": "a283f46716da490be8d41f487a92d858",  
48 - "message": "success"  
49 - } 41 +{
  42 + "code": 200,
  43 + "data": {
  44 + "responseCode": "pqrk1j82pa78f",
  45 + "resultCode": "1",
  46 + "rejectWord": "",
  47 + "resultDatas": "{\"result\":{\"pass\":[{\"score\":0.014999999664724,\"hit\":[],\"label\":1},{\"score\":0.037999998778105,\"hit\":[],\"label\":2},{\"score\":0,\"hit\":[],\"label\":3},{\"score\":0.25764735099338,\"hit\":[],\"label\":4},{\"score\":0.0049999998882413,\"hit\":[],\"label\":5}],\"review\":[],\"reject\":[],\"spam\":0},\"log_id\":7019037961078052478}",
  48 + "uid": 38010009
  49 + },
  50 + "message": "success"
  51 +}
50 ``` 52 ```
51 53
52 -响应失败JSON格式如下所示 54 +审核不通过JSON格式如下所示
53 ```json 55 ```json
54 - {  
55 - "alg": "SALT_MD5",  
56 - "code": 500,  
57 - "data": {},  
58 - "md5": "f4a7a490bb6666b005008d795ed14e5d",  
59 - "message": "Uid Is Null."  
60 - } 56 +{
  57 + "code": 200,
  58 + "data": {
  59 + "responseCode": "pqrk8s82pa78g",
  60 + "resultCode": "2",
  61 + "rejectWord": "金三胖,金三胖,三胖",
  62 + "resultDatas": "{\"result\":{\"pass\":[{\"score\":0.0099999997764826,\"hit\":[],\"label\":1},{\"score\":0.078000001609325,\"hit\":[],\"label\":2},{\"score\":0.24356552238806,\"hit\":[],\"label\":4},{\"score\":0.0080000003799796,\"hit\":[],\"label\":5}],\"review\":[],\"reject\":[{\"score\":1.0,\"hit\":[\"金三胖\",\"金三胖\",\"三胖\"],\"label\":3}],\"spam\":1},\"log_id\":1886341134614767166}",
  63 + "uid": 38010009
  64 + },
  65 + "message": "success"
  66 +}
61 ``` 67 ```
62 -  
63 -## 2、修改用户基本信息 （生日除外） #  
64 -  
65 -修改用户基本信息#（method=app.passport.modifyUserInfo）  
66 -#### 公共请求参数  
67 -| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |  
68 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
69 -|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|  
70 -|app_version|float|10|否|1||APP版本|  
71 -|os_version|string|20|否|Android4.4||系统版本+机器型号|  
72 -|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|  
73 -|screen_size|string|20|否|800x900||（手机尺寸）|  
74 -  
75 -#### 请求参数  
76 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
77 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
78 -|uid|Integer|1-11|否|123333||用户id|  
79 -|nick_name|String|1-11|否|yoho||用户昵称|  
80 -|gender|String|1|是|1||用户性别|  
81 -|weight|Integer|1-11|是|120||用户体重|  
82 -|height|Integer|1-11|是|180||用户身高|  
83 -|username|String|1-11|是|yoho||用户真实姓名|  
84 -|income|Byte|1|是|1||用户收入|  
85 -|profession|Byte|1|是|1||用户职业|  
86 -|headIco|String|1-11|是|/2017/08/31/14/04034936184a918b5bff3df94d5960a6cf.246138.jpg||用户头像|  
87 -|business_line|String|1-11|否|yohobuy||业务线|  
88 -  
89 -#### 接口说明  
90 -| 接口说明||  
91 -|:-------| -----:|  
92 -|请求域名|http://api.yoho.cn|  
93 -|接口名|app.passport.modifyUserInfo|  
94 -|接口说明|修改用户基本信息（生日除外）|  
95 -|http请求方式|POST/GET|  
96 -#### 返回错误  
97 -|错误code|错误提示|  
98 -|:-------| -----:|  
99 -|500|您的昵称已被人使用，请更换|  
100 -|500|Uid Is Null|  
101 -|500|Nick_name Is Null|  
102 -注意，通用的头部没有列出。  
103 -请求示例  
104 -?method=app.passport.modifyUserInfo&uid=121335423&birthday=1990-10-10&business_line=yohobuy  
105 -  
106 -### 响应  
107 -code为200即为成功，否则是失败。  
108 -响应参数，data部分  
109 -响应成功JSON格式如下所示:  
110 -```json  
111 - {  
112 - "alg": "SALT_MD5",  
113 - "code": 200,  
114 - "data":[],  
115 - "md5": "42b33a259be2e3cacf485dc1359f6302",  
116 - "message": "基本资料修改成功"  
117 - }  
118 -```  
119 -响应失败JSON格式如下所示 68 +审核失败JSON格式如下所
120 ```json 69 ```json
121 - {  
122 - "alg": "SALT_MD5",  
123 - "code": 500,  
124 - "data": {},  
125 - "md5": "f4a7a490bb6666b005008d795ed14e5d",  
126 - "message": "Uid Is Null."  
127 - } 70 +{
  71 + "code": 209,
  72 + "message": "文本为空"
  73 +}
128 ``` 74 ```
129 75
130 76
131 -## 3、(uic接口)修改用户生日（ 判断用户是否可以修改生日也调用这个 接口）#  
132 -  
133 -修改用户生日#（requestMapping=/UserInfoRest/modifyUserBirthday） 77 +## 2、百度API图片审核 #
134 78
  79 +百度API图片审核#（method=${yoho.reviewed.controller.url}/imageAudit/imageAudit）
135 #### 请求参数 80 #### 请求参数
136 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
137 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
138 -|uid|Integer|1-11|否|123333||用户id|  
139 -|birthday|String|1-11|是|1990-10-01||用户生日|  
140 -|business_line|String|1-11|否|yohobuy||业务线| 81 +| 参数名称 | 参数类型 | 长度 | 是否必填 | 示例 | 默认值 | 备注 |
  82 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  83 +|uid|Integer||否|3801009||若填写，随结果返回|
  84 +|imageBOList|List||是|||list中存ImageBO对象|
  85 +|-imageUrl|String||是|https://ss1.bdstatic.com/4958&fm=27&gp=0.jpg||图片url,为List中ImageBO对象必传字段|
  86 +|scenName|String|255|是|HEADIMG_CENSOR(暂定)||审核场景名称|
  87 +|license|String|255|是|22c5c86b-3dad-473b-8688-a386a0695343(暂定)||场景安全码，由我们提供|
  88 +|businessLine|String|255|是|uic(暂定)||业务线，必须与场景对应的一致|
  89 +|context|String|255|是|uic(暂定)||调用方webContext，必须与场景对应的一致|
  90 +
  91 +请求示例JSON格式如下所示
  92 +```json
  93 +{
  94 + "uid": "3801009",
  95 + "sceneName":"HEADIMG_CENSOR",
  96 + "businessLine":"uic",
  97 + "context":"uic",
  98 + "license":"22c5c86b-3dad-473b-8688-a386a0695343",
  99 + "imageBOList":[
  100 + {
  101 + "imageUrl":"https://ss1.bdstatic.com/70cFvXSh_Q1YnxGkpoWK1HF6hhy/it/u=1393987749,3422146058&fm=27&gp=0.jpg"
  102 + },
  103 + {
  104 + "imageUrl":"https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/u=1752243568,253651337&fm=27&gp=0.jpg"
  105 + }
  106 + ]
  107 +}
  108 +```
141 109
142 #### 接口说明 110 #### 接口说明
143 -| 接口说明|| 111 +| 接口说明||
144 |:-------| -----:| 112 |:-------| -----:|
145 -|请求域名|http://api.yoho.cn|  
146 -|接口名|app.passport.modifyBirthday|  
147 -|接口说明|修改用户生日| 113 +|请求域名|${yoho.reviewed.controller.url}|
  114 +|接口名|/imageAudit/imageAudit|
  115 +|接口说明|百度api图片审核|
148 |http请求方式|POST| 116 |http请求方式|POST|
149 -#### 返回错误  
150 -|错误code|错误提示| 117 +
  118 +#### 返回信息
  119 +|返回字段|描述|
151 |:-------| -----:| 120 |:-------| -----:|
152 -|400|请先登录|  
153 -注意，通用的头部没有列出。  
154 -请求示例  
155 -http://127.0.0.1:8096/uic/UserInfoRest/modifyUserBirthday 121 +|code|返回码|
  122 +|message|提示信息|
  123 +|date|返回对象|
  124 +|-responseCode|本次审核记录唯一标志|
  125 +|-resultCode|审核结果 1:通过, 2:不通过|
  126 +|-resultDatas|百度api返回信息|
  127 +|-uid|若请求参数中传了uid则带回|
  128 +
  129 +
156 ### 响应 130 ### 响应
157 -code为200即为成功，否则是失败。  
158 -响应参数，data部分  
159 -响应成功JSON格式如下所示，修改成功后也会返回当前是否可修改  
160 131
  132 +审核通过JSON格式如下所示
161 ```json 133 ```json
162 - {  
163 - "code": 200,  
164 - "message": "生日可以修改",  
165 - "data": {  
166 - "isCanModifyBirthday": "Y"  
167 - }  
168 - } 134 +{
  135 + "code": 200,
  136 + "data": {
  137 + "responseCode": "pqrjb462p0hes",
  138 + "resultCode": "1",
  139 + "resultDatas": "[{\"conclusion\":\"合规\",\"log_id\":15566091557698088,\"conclusionType\":1}]",
  140 + "uid": 3801009
  141 + },
  142 + "message": "success"
  143 +}
169 ``` 144 ```
170 -响应失败JSON格式如下所示 145 +
  146 +审核不通过JSON格式如下所示
171 ```json 147 ```json
172 - {  
173 - "message": "请先登录",  
174 - "code": 400  
175 - } 148 +{
  149 + "code": 200,
  150 + "data": {
  151 + "responseCode": "pqrj4v62p0her",
  152 + "resultCode": "2",
  153 + "resultDatas": "[{\"conclusion\":\"合规\",\"log_id\":15566089388365587,\"conclusionType\":1},{\"conclusion\":\"不合规\",\"log_id\":15566089595368808,\"data\":[{\"msg\":\"存在水印码内容\",\"probability\":0.97585493,\"type\":5},{\"msg\":\"恶意推广\",\"probability\":0.92202735,\"type\":9}],\"conclusionType\":2}]",
  154 + "uid": 3801009
  155 + },
  156 + "message": "success"
  157 +}
  158 +}
176 ``` 159 ```
177 160
178 -## 4、（uic接口）修改用户基本信息 （生日除外） #  
179 -  
180 -修改用户基本信息#（requestMapping=/UserInfoRest/modifyUserInfo）  
181 -  
182 -#### 请求参数  
183 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
184 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
185 -|uid|Integer|1-11|否|123333||用户id|  
186 -|nick_name|String|1-11|否|yoho||用户昵称|  
187 -|gender|String|1|是|1||用户性别|  
188 -|weight|Integer|1-11|是|120||用户体重|  
189 -|height|Integer|1-11|是|180||用户身高|  
190 -|username|String|1-11|是|yoho||用户真实姓名|  
191 -|income|Byte|1|是|1||用户收入|  
192 -|profession|Byte|1|是|1||用户职业|  
193 -|headIco|String|1-11|是|/2017/08/31/14/04034936184a918b5bff3df94d5960a6cf.246138.jpg||用户头像|  
194 -|business_line|String|1-11|否|yohobuy||业务线|  
195 161
196 -#### 接口说明  
197 -| 接口说明||  
198 -|:-------| -----:|  
199 -|请求域名|http://api.yoho.cn|  
200 -|接口名|/UserInfoRest/modifyUserInfo|  
201 -|接口说明|修改用户基本信息（生日除外）|  
202 -|http请求方式|POST|  
203 -#### 返回错误  
204 -|错误code|错误提示|  
205 -|:-------| -----:|  
206 -|500|您的昵称已被人使用，请更换|  
207 -|400|请先登录|  
208 -请求示例  
209 -http://127.0.0.1:8096/uic/UserInfoRest/modifyUserInfo  
210 -  
211 -### 响应  
212 -code为200即为成功，否则是失败。  
213 -响应参数，data部分  
214 -响应成功JSON格式如下所示: 162 +审核失败JSON格式如下所
215 ```json 163 ```json
216 - {  
217 - "code": 200,  
218 - "message": "success."  
219 - } 164 +{
  165 + "code": 208,
  166 + "message": "图片内容失败"
  167 +}
220 ``` 168 ```
221 -响应失败JSON格式如下所示  
222 -```json  
223 - {  
224 - "message": "您的昵称已被人使用，请更换",  
225 - "code": 500  
226 - }