Authored by chaogeng

新增uic鉴权接口文档

  1 +## 1、登录接口##
  2 +登录(/login/login)
  3 +
  4 +#### 请求参数 post
  5 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|account|String|1-11|否|802654||邮箱/手机号|
  8 +|password|String|1-50|否|||密码|
  9 +|area|string|1-10|(国际手机号不可为空,不传默认为86)|86||区号|
  10 +|source|string|1-10|否|"mars"、"now"||标识,用于区分mars和资讯|
  11 +|client_type|string|1-10|否|"iphone"、"android"、"h5"||标识客户端类型|
  12 +
  13 +请求参数示例:http://192.168.102.27:8096/uic/login/login
  14 +```json
  15 +{"account":"17088865665",
  16 + "password":"123abc",
  17 + "area":"86",
  18 + "source":"mars",
  19 + "client_type":"iphone"
  20 +}
  21 +```
  22 +
  23 +响应JSON格式如下所示:
  24 +```json
  25 +{
  26 + code: 20101,
  27 + message: "成功登录",
  28 + data: {
  29 + uid: 20443640,
  30 + create_time: 1482227299,
  31 + mobile_phone: "17088865665",
  32 + yoho_session_key: "4255464fb22b0af8f8338244565ea4ef",
  33 + email: "0"
  34 + }
  35 +}
  36 +```
  37 +
  38 +#### 返回码说明:
  39 +| 返回码说明||
  40 +|:-------| -----:|
  41 +|返回码|说明|
  42 +|20001|成功登录|
  43 +
  44 +## 2、第三方登录接口##
  45 +第三方登录(/login/signinByOpenID)
  46 +
  47 +#### 请求参数 post
  48 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  49 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  50 +|type|int||否|4||第三方登录类型|
  51 +|auth|String|1-50|否|||第三方登录账号|
  52 +|source|string|1-10|否|"mars"、"now"||标识,用于区分mars和资讯|
  53 +|client_type|string|1-10|否|"iphone"、"android"、"h5"||标识客户端类型|
  54 +
  55 +请求参数示例:http://192.168.102.27:8096/uic/login/signinByOpenID
  56 +```json
  57 +{"type":"4",
  58 + "auth":"E94AD2374908F320ABDFBC5D4A9D69C5",
  59 + "source":"mars",
  60 + "client_type":"iphone"
  61 +}
  62 +```
  63 +
  64 +响应JSON格式如下所示:
  65 +```json
  66 +{
  67 + code: 200,
  68 + message: "成功操作",
  69 + data: {
  70 + uid: 20443640,
  71 + create_time: 1482227299,
  72 + mobile_phone: "17088865665",
  73 + yoho_session_key: "4255464fb22b0af8f8338244565ea4ef",
  74 + email: "0"
  75 + }
  76 +}
  77 +```
  78 +
  79 +#### 返回码说明:
  80 +| 返回码说明||
  81 +|:-------| -----:|
  82 +|返回码|说明|
  83 +|200|成功操作|
  84 +|405|不存在该用户|
  85 +
  86 +## 3、获取用户账号信息##
  87 +短信登录后获取用户账号信息(/profile/getProfile)
  88 +
  89 +#### 请求参数 post
  90 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  91 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  92 +|account|String|1-11|否|802654||邮箱/手机号|
  93 +|area|string|1-10|(国际手机号不可为空,不传默认为86)|86||区号|
  94 +|source|string|1-10|否|"mars"、"now"||标识,用于区分mars和资讯|
  95 +|client_type|string|1-10|否|"iphone"、"android"、"h5"||标识客户端类型|
  96 +
  97 +请求参数示例:http://192.168.102.27:8096/uic/profile/getProfile
  98 +```json
  99 +{"account":"17088865665",
  100 + "area":"86",
  101 + "source":"mars",
  102 + "client_type":"iphone"
  103 +}
  104 +```
  105 +
  106 +响应JSON格式如下所示:
  107 +```json
  108 +{
  109 + code: 200,
  110 + message: "成功操作",
  111 + data: {
  112 + uid: 20443640,
  113 + create_time: 1482227299,
  114 + mobile_phone: "17088865665",
  115 + email: "0"
  116 + }
  117 +}
  118 +```
  119 +
  120 +#### 返回码说明:
  121 +| 返回码说明||
  122 +|:-------| -----:|
  123 +|返回码|说明|
  124 +|200|成功操作|
  125 +|405|不存在该用户|
  126 +
  127 +## 4、获取用户session##
  128 +短信登录后获取用户账号信息(/session/getSession)
  129 +
  130 +#### 请求参数 post
  131 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  132 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  133 +|uid|String|1-11|否|20443640||uid|
  134 +|source|string|1-10|否|"mars"、"now"||标识,用于区分mars和资讯|
  135 +|client_type|string|1-10|否|"iphone"、"android"、"h5"||标识客户端类型|
  136 +
  137 +请求参数示例:http://192.168.102.27:8096/uic/session/getSession
  138 +```json
  139 +{
  140 +"uid":20443640
  141 +}
  142 +```
  143 +
  144 +响应JSON格式如下所示:
  145 +```json
  146 +{
  147 + uid: 20443640,
  148 + sessionKey: "05d3297e1023916a04fa6a0f0f0848d5",
  149 + oldSessionKey: null,
  150 + createIP: 0,
  151 + ssoUid: null,
  152 + clientType: null,
  153 + sessionType: null
  154 +}
  155 +```
  156 +
  157 +#### 返回码说明:
  158 +| 返回码说明||
  159 +|:-------| -----:|
  160 +|返回码|说明|
  161 +|200|成功操作|