登录授权接口文档

亦凉 2022-05-18 05:05 406阅读 0赞

# 登录授权接口文档 #

## 一、流程图 ##

![这里写图片描述][70]

从图中，我们知道作为授权方服务端主要提供以下几个接口：authorize、accessToken、refreshToken、userInfo，其中前三个为认证服务器提供，最后一个为资源服务器提供，目前，认证服务器与资源服务器可以认为是同一个服务器。

## 二、接口定义 ##

### 1. 获取code ###

路径： [http://authserver/oauth2/authorize][http_authserver_oauth2_authorize]  
说明：此接口由授权方客户端发起，所以要跟正常的接口一样带上userId和签名，以便后端知道是哪个用户。  
方法：POST  
参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>responseType</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示授权类型，此处的值固定为"code"</td> 
  </tr> 
  <tr> 
   <td>appid</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示客户端的ID，授权方分配</td> 
  </tr> 
  <tr> 
   <td>scope</td> 
   <td>String</td> 
   <td>否</td> 
   <td>表示申请的权限范围，目前统一传 “user” 进来</td> 
  </tr> 
  <tr> 
   <td>state</td> 
   <td>String</td> 
   <td>否</td> 
   <td>表示客户端的当前状态，可以指定任意值，认证服务器会原封不动地返回这个值</td> 
  </tr> 
  <tr> 
   <td>userId</td> 
   <td>Long</td> 
   <td>是</td> 
   <td>用户id</td> 
  </tr> 
  <tr> 
   <td>sign</td> 
   <td>String</td> 
   <td>是</td> 
   <td>使用token加密后的签名</td> 
  </tr> 
 </tbody> 
</table>

返回值：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>code</td> 
   <td>String</td> 
   <td>服务端生成的code，有效期为5分钟</td> 
  </tr> 
  <tr> 
   <td>state</td> 
   <td>String</td> 
   <td>客户端传过来的state原样返回</td> 
  </tr> 
 </tbody> 
</table>

### 2. 获取accessToken ###

路径： [http://authserver/oauth2/accessToken][http_authserver_oauth2_accessToken]  
说明：此接口由被授权方服务端调用，需要传授权方分配的secret。  
方法：POST  
参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>grantType</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示使用的授权模式，此处的值固定为"authorization_code"</td> 
  </tr> 
  <tr> 
   <td>appid</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示客户端的ID，授权方分配</td> 
  </tr> 
  <tr> 
   <td>secret</td> 
   <td>String</td> 
   <td>是</td> 
   <td>密钥，授权方分配</td> 
  </tr> 
  <tr> 
   <td>code</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示上一步获得的授权码</td> 
  </tr> 
 </tbody> 
</table>

返回值：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>accessToken</td> 
   <td>String</td> 
   <td>授权令牌，有效期为2小时</td> 
  </tr> 
  <tr> 
   <td>expiresIn</td> 
   <td>Long</td> 
   <td>有效时间，单位毫秒，7200000ms</td> 
  </tr> 
  <tr> 
   <td>refreshToken</td> 
   <td>String</td> 
   <td>刷新accessToken时使用，有效期为30天</td> 
  </tr> 
  <tr> 
   <td>openid</td> 
   <td>String</td> 
   <td>在被授权方应用内唯一标识用户</td> 
  </tr> 
  <tr> 
   <td>scope</td> 
   <td>String</td> 
   <td>权限范围</td> 
  </tr> 
 </tbody> 
</table>

### 3. 刷新accessToken ###

路径： [http://authserver/oauth2/refreshToken][http_authserver_oauth2_refreshToken]  
说明：此接口由被授权方服务端调用，定期刷新accessToken，目前accessToken有效期为2小时，refreshToken有效期为30天。  
方法：POST  
参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>grantType</td> 
   <td>String</td> 
   <td>是</td> 
   <td>此处的值固定为"refresh_token"</td> 
  </tr> 
  <tr> 
   <td>appid</td> 
   <td>String</td> 
   <td>是</td> 
   <td>表示客户端的ID，授权方分配</td> 
  </tr> 
  <tr> 
   <td>refreshToken</td> 
   <td>String</td> 
   <td>是</td> 
   <td>填写通过accessToken获取到的refreshToken参数</td> 
  </tr> 
 </tbody> 
</table>

返回值：

\#\#\#4. 获取用户信息  
路径： [http://resourceserver/oauth2/userInfo][http_resourceserver_oauth2_userInfo]  
说明：此接口由被授权方服务端调用获取用户信息。  
方法：GET  
参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>accessToken</td> 
   <td>String</td> 
   <td>是</td> 
   <td>授权令牌</td> 
  </tr> 
  <tr> 
   <td>openid</td> 
   <td>String</td> 
   <td>是</td> 
   <td>用户openid</td> 
  </tr> 
 </tbody> 
</table>

返回值：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>openid</td> 
   <td>String</td> 
   <td>用户openid</td> 
  </tr> 
  <tr> 
   <td>nickname</td> 
   <td>String</td> 
   <td>用户昵称</td> 
  </tr> 
  <tr> 
   <td>headImgUrl</td> 
   <td>String</td> 
   <td>用户头像</td> 
  </tr> 
 </tbody> 
</table>

注：目前，authserver==resourceserver。

--------------------

欢迎关注我的公众号“彤哥读源码”，查看更多“源码&架构&算法”系列文章, 与彤哥一起畅游源码的海洋。

![qrcode][]

[70]: /images/20220518/961d1796a2d447d0a72639dd2907512f.png
[http_authserver_oauth2_authorize]: http://authserver/oauth2/authorize
[http_authserver_oauth2_accessToken]: http://authserver/oauth2/accessToken
[http_authserver_oauth2_refreshToken]: http://authserver/oauth2/refreshToken
[http_resourceserver_oauth2_userInfo]: http://resourceserver/oauth2/userInfo
[qrcode]: /images/20220518/6614422ad9cd4c529bbef76c6ab39929.png