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、修改用户生日 （判断用户是否可以修改生日也 调用这个接口 ） #
修改用户生日#（method=app.passport.modifyBirthday）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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||（手机尺寸）|
## 1、百度API文本审核 #
百度API文本审核#（method=${yoho.reviewed.controller.url}/textAudit/textAudit）
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer|1-11|否|123333||用户id|
|birthday|String|1-11|是|1990-10-01||用户生日|
|business_line|String|1-11|否|yohobuy||业务线|
| 参数名称 | 参数类型 | 长度 | 是否必填 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer||否|3801009||若填写，随结果返回|
|content|String|255|是|昵称测试💰 🐧💰||需审核文本|
|scenName|String|255|是|NICKENAME_CENSOR(暂定)||审核场景名称|
|license|String|255|是|22c5c86b-3dad-473b-8688-a386a0695343(暂定)||场景安全码，由我们提供|
|businessLine|String|255|是|uic(暂定)||业务线，必须与场景对应的一致|
|context|String|255|是|uic(暂定)||调用方webContext，必须与场景对应的一致|
#### 接口说明
| 接口说明||
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.passport.modifyBirthday|
|接口说明|修改用户生日|
|请求域名|${yoho.reviewed.controller.url}|
|接口名|textAudit/textAudit|
|接口说明|百度API文本审核|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
#### 返回信息
|返回字段|描述|
|:-------| -----:|
|500|uid is null|
注意，通用的头部没有列出。
请求示例
?method=app.passport.modifyBirthday&uid=121335423&birthday=1990-10-10&business_line=yohobuy
|code|返回码|
|message|提示信息|
|date|返回对象|
|-responseCode|本次审核唯一标志|
|-resultCode|审核结果 1: 通过，2: 不通过|
|-rejectWord|违规词，审核通过则为空|
|-resultDatas|百度api返回信息|
|-uid|若请求参数中传了uid则带回|
请求示例
${yoho.reviewed.controller.url}/textAudit/textAudit?sceneName=NICKENAME_CENSOR&businessLine=uic&context=uic-gateway&license=22c5c86b-3dad-473b-8688-a386a0695343&uid=38010009&content=昵称测试💰 🐧💰
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示，修改成功后也会返回当前是否可修改
审核通过JSON格式如下所示
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"isCanModifyBirthday": "Y"
},
"md5": "a283f46716da490be8d41f487a92d858",
"message": "success"
}
{
"code": 200,
"data": {
"responseCode": "pqrk1j82pa78f",
"resultCode": "1",
"rejectWord": "",
"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}",
"uid": 38010009
},
"message": "success"
}
```
响应失败JSON格式如下所示
审核不通过JSON格式如下所示
```json
{
"alg": "SALT_MD5",
"code": 500,
"data": {},
"md5": "f4a7a490bb6666b005008d795ed14e5d",
"message": "Uid Is Null."
}
{
"code": 200,
"data": {
"responseCode": "pqrk8s82pa78g",
"resultCode": "2",
"rejectWord": "金三胖,金三胖,三胖",
"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}",
"uid": 38010009
},
"message": "success"
}
```
## 2、修改用户基本信息 （生日除外） #
修改用户基本信息#（method=app.passport.modifyUserInfo）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer|1-11|否|123333||用户id|
|nick_name|String|1-11|否|yoho||用户昵称|
|gender|String|1|是|1||用户性别|
|weight|Integer|1-11|是|120||用户体重|
|height|Integer|1-11|是|180||用户身高|
|username|String|1-11|是|yoho||用户真实姓名|
|income|Byte|1|是|1||用户收入|
|profession|Byte|1|是|1||用户职业|
|headIco|String|1-11|是|/2017/08/31/14/04034936184a918b5bff3df94d5960a6cf.246138.jpg||用户头像|
|business_line|String|1-11|否|yohobuy||业务线|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.passport.modifyUserInfo|
|接口说明|修改用户基本信息（生日除外）|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|您的昵称已被人使用，请更换|
|500|Uid Is Null|
|500|Nick_name Is Null|
注意，通用的头部没有列出。
请求示例
?method=app.passport.modifyUserInfo&uid=121335423&birthday=1990-10-10&business_line=yohobuy
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data":[],
"md5": "42b33a259be2e3cacf485dc1359f6302",
"message": "基本资料修改成功"
}
```
响应失败JSON格式如下所示
审核失败JSON格式如下所
```json
{
"alg": "SALT_MD5",
"code": 500,
"data": {},
"md5": "f4a7a490bb6666b005008d795ed14e5d",
"message": "Uid Is Null."
}
{
"code": 209,
"message": "文本为空"
}
```
## 3、(uic接口)修改用户生日（ 判断用户是否可以修改生日也调用这个 接口）#
修改用户生日#（requestMapping=/UserInfoRest/modifyUserBirthday）
## 2、百度API图片审核 #
百度API图片审核#（method=${yoho.reviewed.controller.url}/imageAudit/imageAudit）
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer|1-11|否|123333||用户id|
|birthday|String|1-11|是|1990-10-01||用户生日|
|business_line|String|1-11|否|yohobuy||业务线|
| 参数名称 | 参数类型 | 长度 | 是否必填 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer||否|3801009||若填写，随结果返回|
|imageBOList|List||是|||list中存ImageBO对象|
|-imageUrl|String||是|https://ss1.bdstatic.com/4958&fm=27&gp=0.jpg||图片url,为List中ImageBO对象必传字段|
|scenName|String|255|是|HEADIMG_CENSOR(暂定)||审核场景名称|
|license|String|255|是|22c5c86b-3dad-473b-8688-a386a0695343(暂定)||场景安全码，由我们提供|
|businessLine|String|255|是|uic(暂定)||业务线，必须与场景对应的一致|
|context|String|255|是|uic(暂定)||调用方webContext，必须与场景对应的一致|
请求示例JSON格式如下所示
```json
{
"uid": "3801009",
"sceneName":"HEADIMG_CENSOR",
"businessLine":"uic",
"context":"uic",
"license":"22c5c86b-3dad-473b-8688-a386a0695343",
"imageBOList":[
{
"imageUrl":"https://ss1.bdstatic.com/70cFvXSh_Q1YnxGkpoWK1HF6hhy/it/u=1393987749,3422146058&fm=27&gp=0.jpg"
},
{
"imageUrl":"https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/u=1752243568,253651337&fm=27&gp=0.jpg"
}
]
}
```
#### 接口说明
| 接口说明||
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.passport.modifyBirthday|
|接口说明|修改用户生日|
|请求域名|${yoho.reviewed.controller.url}|
|接口名|/imageAudit/imageAudit|
|接口说明|百度api图片审核|
|http请求方式|POST|
#### 返回错误
|错误code|错误提示|
#### 返回信息
|返回字段|描述|
|:-------| -----:|
|400|请先登录|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8096/uic/UserInfoRest/modifyUserBirthday
|code|返回码|
|message|提示信息|
|date|返回对象|
|-responseCode|本次审核记录唯一标志|
|-resultCode|审核结果 1:通过, 2:不通过|
|-resultDatas|百度api返回信息|
|-uid|若请求参数中传了uid则带回|
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示，修改成功后也会返回当前是否可修改
审核通过JSON格式如下所示
```json
{
"code": 200,
"message": "生日可以修改",
"data": {
"isCanModifyBirthday": "Y"
}
}
{
"code": 200,
"data": {
"responseCode": "pqrjb462p0hes",
"resultCode": "1",
"resultDatas": "[{\"conclusion\":\"合规\",\"log_id\":15566091557698088,\"conclusionType\":1}]",
"uid": 3801009
},
"message": "success"
}
```
响应失败JSON格式如下所示
审核不通过JSON格式如下所示
```json
{
"message": "请先登录",
"code": 400
}
{
"code": 200,
"data": {
"responseCode": "pqrj4v62p0her",
"resultCode": "2",
"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}]",
"uid": 3801009
},
"message": "success"
}
}
```
## 4、（uic接口）修改用户基本信息 （生日除外） #
修改用户基本信息#（requestMapping=/UserInfoRest/modifyUserInfo）
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|Integer|1-11|否|123333||用户id|
|nick_name|String|1-11|否|yoho||用户昵称|
|gender|String|1|是|1||用户性别|
|weight|Integer|1-11|是|120||用户体重|
|height|Integer|1-11|是|180||用户身高|
|username|String|1-11|是|yoho||用户真实姓名|
|income|Byte|1|是|1||用户收入|
|profession|Byte|1|是|1||用户职业|
|headIco|String|1-11|是|/2017/08/31/14/04034936184a918b5bff3df94d5960a6cf.246138.jpg||用户头像|
|business_line|String|1-11|否|yohobuy||业务线|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/UserInfoRest/modifyUserInfo|
|接口说明|修改用户基本信息（生日除外）|
|http请求方式|POST|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|您的昵称已被人使用，请更换|
|400|请先登录|
请求示例
http://127.0.0.1:8096/uic/UserInfoRest/modifyUserInfo
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
审核失败JSON格式如下所
```json
{
"code": 200,
"message": "success."
}
{
"code": 208,
"message": "图片内容失败"
}
```
响应失败JSON格式如下所示
```json
{
"message": "您的昵称已被人使用，请更换",
"code": 500
}
\ No newline at end of file
... ...