> 演示Demo站點 http://sso.exrick.cn ### 準備工作 - 進入系統“開放平臺-接入網站管理”菜單，添加要接入的第三方網站，獲得相應的clientId和clientSecret ### 授權流程簡介 - 時序圖 <img src=https://ooo.0o0.ooo/2019/11/26/zoKNi1ZsWkw4g6O.png width=800/> - 對于第三方應用簡而言之即兩步 1. 獲取 Code 2. 通過 Code 獲取 Access Token ### 流程詳解 #### 第一步：獲取 Code **請求地址**： 本地運行前端：http://127.0.0.1:9999/authorize 在線Demo： http://xboot.exrick.cn/authorize **請求方法**： GET **請求參數**： | 參數 | 是否必須 | 含義 | | --- | --- | --- | | response\_type | 必須 | 授權類型，此值固定為“code”。 | | client\_id | 必須 | 接入成功后，分配給應用的clientId。 | | redirect\_uri | 必須 | 成功授權后的回調地址，必須是接入時填寫的地址，建議設置為網站首頁或網站的用戶中心。建議將url進行URLEncode。 | | state | 必須 | client端的狀態值。用于第三方應用防止CSRF攻擊，成功授權后回調時會原樣帶回。請務必嚴格按照流程檢查用戶與state參數狀態的綁定。 | **真實鏈接示例** http://xboot.exrick.cn/authorize?client_id=211260981215498241&redirect_uri=http://sso.exrick.cn&state=1234&response_type=code **返回說明**： 1. 如果用戶成功登錄并授權，則會跳轉到指定的回調地址，并在redirect\_uri地址后帶上code和原始的state值。如回調地址示例： PC網站：http://demo.cn/callback?code=9A5F\*\*\*\*\*06AF&state=1234 注意：此code會在5分鐘內過期。 #### 第二步：通過Code獲取Access Token **請求地址**： 本地運行后端：http://127.0.0.1:8888/xboot/oauth2/token 在線Demo： http://xboot.exrick.cn/xboot/oauth2/token **請求方法**： GET **請求參數**： | 參數 | 是否必須 | 含義 | | --- | --- | --- | | grant\_type | 必須 | 授權類型，在本步驟中，此值為“authorization\_code”。 | | client\_id | 必須 | 接入成功后，分配給應用的clientId。 | | client\_secret | 必須 | 接入成功后，應用填寫的clientSecret。 | | code | 必須 | 上一步返回的code。 如果用戶成功登錄并授權，則會跳轉到指定的回調地址，并在URL中帶上Code。例如，回調地址為demo.com/callback，則跳轉到：http://demo.com/callback?code=520D\*\*\*\*\*\* 注意此code會在5分鐘內過期。 | | redirect\_uri | 必須 | 與上面一步中傳入的redirect\_uri保持一致。 | **返回說明**： 如果成功返回，即可在返回包中獲取到Access Token。 如： ``` json { "success": true, "message": "success", "code": 200, "timestamp": 1574751441247, "result": { "access_token": "a4d75327ec5e4b96bfd244bf73afb79a", "refresh_token": "b8ee0d83b5d14ec68505047063807e78", "expires_in": 2591009 } } ``` | **參數說明** | **描述** | | --- | --- | | access\_token | 授權令牌，Access\_Token。 | | expires\_in | 該access token的有效期，單位為秒。 | | refresh\_token | 在授權自動續期步驟中，獲取新的Access\_Token時需要提供的參數。 注：refresh\_token僅一次有效 <img src=https://ooo.0o0.ooo/2019/11/26/ro3OyZd4LSmNRgt.png width=800/> #### （可選步驟）權限自動續期，獲取Access Token Access\_Token的有效期默認是1個月，過期后需要用戶重新授權才能獲得新的Access\_Token。本步驟可以實現授權自動續期，避免要求用戶再次授權的操作，提升用戶體驗。 **請求地址**： 本地運行后端：http://127.0.0.1:8888/xboot/oauth2/token 在線Demo： http://xboot.exrick.cn/xboot/oauth2/token **請求方法**： GET **請求參數**： | 參數 | 是否必須 | 含義 | | --- | --- | --- | | grant\_type | 必須 | 授權類型，在本步驟中，此值為“refresh\_token”。 | | client\_id | 必須 | 接入成功后，分配給應用的clientId。 | | client\_secret | 必須 | 接入成功后，應用填寫的clientSecret。 | | refresh\_token | 必須 | 首次：使用在【第二步】中獲取到的最新的refresh\_token。后續：使用刷新后返回的最新refresh\_token | **返回說明**： 如果成功返回，即可在返回包中獲取到Access Token。 如同上一步即【第二步】 | **參數說明** | **描述** | | --- | --- | | access\_token | 授權令牌，Access\_Token。 | | expires\_in | 該access token的有效期，單位為秒。 | | refresh\_token | 在授權自動續期步驟中，獲取新的Access\_Token時需要提供的參數。每次生成最新的refresh\_token，且僅一次有效 | ### 請求開放接口 獲取了Accees_Token后即可用于請求XBoot平臺開放的接口，目前僅有獲取授權用戶基本信息接口 **請求地址**： 本地運行后端：http://127.0.0.1:8888/xboot/oauth2/user 在線Demo： http://xboot.exrick.cn/xboot/oauth2/user **請求方法**： GET **請求參數**： | 參數 | 是否必須 | 含義 | | --- | --- | --- | | access\_token | 必須 | 在【第二步】中獲取到的最新的access\_token。 | **返回說明** ``` json { "success": true, "message": "success", "code": 200, "timestamp": 1574751447930, "result": { "sex": "男", "avatar": "https://s1.ax1x.com/2018/05/19/CcdVQP.png", "username": "admin" } } ``` <img src=https://ooo.0o0.ooo/2019/11/26/xsGI4bSTRV7oH3U.png width=800/> > 你也可以開放更多你自己業務的接口供第三方調用