微信開放平臺的使用介紹,配置流程
阿新 • • 發佈:2019-01-10
1、OAuth2.0
OAuth(開放授權)是一個開放標準,允許使用者讓第三方應用訪問該使用者在某一網站上儲存的私密的資源(如照片,視訊,聯絡人列表),而無需將使用者名稱和密碼提供給第三方應用。
允許使用者提供一個令牌,而不是使用者名稱和密碼來訪問他們存放在特定服務提供者的資料。每一個令牌授權一個特定的網站(例如,視訊編輯網站)在特定的時段(例如,接下來的2小時內)內訪問特定的資源(例如僅僅是某一相簿中的視訊)。這樣,OAuth允許使用者授權第三方網站訪問他們儲存在另外的服務提供者上的資訊,而不需要分享他們的訪問許可或他們資料的所有內容。2、目標3、前期準備(獲取微信開發者許可權) 我們這裡主要講的是網站(Web)應用,網站應用微信登入是基於OAuth2.0協議標準構建的微信OAuth2.0授權登入系統(即上面的協議)。在微信客戶端授權登入(獲取使用者資訊)的可以檢視:在進行微信OAuth2.在進行微信OAuth2.0授權登入接入之前,在微信開放平臺註冊開發者帳號,並擁有一個已稽核通過的網站應用,並獲得相應的AppID和AppSecret,申請微信登入且通過稽核後,可開始接入流程。
3.1、註冊開發者賬號3.2、提交網站應用稽核 在已經登入的介面中選擇“管理中心”——》網站應用——》建立網站應用 將會彈出下面的介面 填寫過後,還有有一個頁面需要填寫,提交一份紙質版申請書掃描件(會提供模板,我們下載再來填寫後,需蓋章,簽名),配置回撥域名(掃碼登入後會跳轉的頁面)等。 之後提交稽核即可,等微信稽核通過,我們即可獲得我們需要的網頁應用的appid和AppSecret,並配置後回撥的域名了微信OAuth2.0授權登入目前支援authorization_code模式,適用於擁有server端的應用授權。該模式整體流程為:
1. 第三方發起微信授權登入請求,微信使用者允許授權第三方應用後,微信會拉起應用或重定向到第三方網站,並且帶上授權臨時票據code引數; 2. 通過code引數加上AppID和AppSecret等,通過API換取access_token; 3. 通過access_token進行介面呼叫,獲取使用者基本資料資源或幫助使用者實現基本操作。
獲取access_token時序圖:
5、獲取網頁的二維碼 當我們通過微信的認證,獲取到了appid和AppSecret,並配置了回撥的域名。我們就已經可以獲取屬於我們網頁的二維碼了,獲取的方式很簡單,只需開啟一個微信的連結,加上我們的appid和回撥域名即可在網頁上面開啟二維碼,使用者用微信客戶端掃碼並授權登入之後即會跳轉到我們配置的回撥域名下。注意:1、這裡填寫的是域名(是一個字串),而不是URL,因此請勿加http://等協議頭; 2、授權回撥域名配置規範為全域名,比如需要網頁授權的域名為:www.qq.com,配置以後此域名下面的頁面http://www.qq.com/music.html 、 http://www.qq.com/login.html 都可以進行OAuth2.0鑑權。但http://pay.qq.com 、 http://music.qq.com 、 http://qq.com無法進行OAuth2.0鑑權
5.1、請求url說明
第三方使用網站應用授權登入前請注意已獲取相應網頁授權作用域(scope=snsapi_login),則可以通過在PC端開啟以下連結:
https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect引數說明
引數 | 是否必須 | 說明 |
---|---|---|
appid | 是 | 應用唯一標識(前面認證網頁應用中獲得) |
redirect_uri | 是 | 重定向地址,需要進行UrlEncode(前面認證網頁應用中獲得) |
response_type | 是 | 填code |
scope | 是 | 應用授權作用域,擁有多個作用域用逗號(,)分隔,網頁應用目前僅填寫snsapi_login即可 |
state | 否 | 用於保持請求和回撥的狀態,授權請求後原樣帶回給第三方。該引數可用於防止csrf攻擊(跨站請求偽造攻擊),建議第三方帶上該引數,可設定為簡單的隨機數加session進行校驗 |
redirect_uri?code=CODE&state=STATE
若使用者禁止授權,則重定向後不會帶上code引數,僅會帶上state引數
redirect_uri?state=STATE
5.2、事例:
一號店的微信二維碼連結如下:
https://open.weixin.qq.com/connect/qrconnect?appid=wxbdc5610cc59c1631&redirect_uri=https%3A%2F%2Fpassport.yhd.com%2Fwechat%2Fcallback.do&response_type=code&scope=snsapi_login&state=3d6be0a4035d839573b04816624a415e#wechat_redirect
將其複製到瀏覽器中開啟即可獲得一號店的二維碼,二維碼頁面如下:
通過使用微信客戶端的掃一掃功能,掃描該二維碼,即會跳轉到上面填寫redirect_uri所在的地址上。假如使用者同意授權,這裡就獲得了微信返回的code引數了。
6、獲取使用者資訊
假如前面已經獲得code。我們可以通過code引數去獲取使用者openid和access_token,進而獲得使用者的資訊。6.1、通過code引數獲取access_tokenhttps://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code
引數說明
引數 | 是否必須 | 說明 |
---|---|---|
appid | 是 | 應用唯一標識,在微信開放平臺提交應用稽核通過後獲得 |
secret | 是 | 應用金鑰AppSecret,在微信開放平臺提交應用稽核通過後獲得 |
code | 是 | 填寫第一步獲取的code引數 |
grant_type | 是 | 填authorization_code |
返回說明
正確的返回:
{ "access_token":"ACCESS_TOKEN", "expires_in":7200, "refresh_token":"REFRESH_TOKEN", "openid":"OPENID", "scope":"SCOPE", "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL" }
引數 | 說明 |
---|---|
access_token | 介面呼叫憑證 |
expires_in | access_token介面呼叫憑證超時時間,單位(秒) |
refresh_token | 使用者重新整理access_token |
openid | 授權使用者唯一標識 |
scope | 使用者授權的作用域,使用逗號(,)分隔 |
unionid | 當且僅當該網站應用已獲得該使用者的userinfo授權時,才會出現該欄位。 |
錯誤返回樣例:
{"errcode":40029,"errmsg":"invalid code"}注意:
- code引數的超時時間是5分鐘,且每次請求的code引數的值都不一樣。
- access_token的超時時間是32分鐘。
- access_token有效且為超時;
- 微信使用者已授權給第三方應用賬號相應介面作用域(scope)【在二維碼生成連線那裡填寫】
授權作用域(scope) | 介面 | 介面說明 |
---|---|---|
snsapi_base | /sns/oauth2/access_token | 通過code換取access_token、refresh_token和已授權scope |
/sns/oauth2/refresh_token | 重新整理或續期access_token使用 | |
/sns/auth | 檢查access_token有效性 | |
snsapi_userinfo | /sns/userinfo | 獲取使用者個人資訊 |
https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&openid=OPENID
引數說明
引數 | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 呼叫憑證(上一個請求中獲得) |
openid | 是 | 普通使用者的標識,對當前開發者帳號唯一(上一個請求中獲得) |
lang | 否 | 國家地區語言版本,zh_CN 簡體,zh_TW 繁體,en 英語,預設為zh-CN |
返回說明
正確的Json返回結果:
{ "openid":"OPENID", "nickname":"NICKNAME", "sex":1, "province":"PROVINCE", "city":"CITY", "country":"COUNTRY", "headimgurl": "http://wx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/0", "privilege":[ "PRIVILEGE1", "PRIVILEGE2" ], "unionid": " o6_bmasdasdsad6_2sgVt7hMZOPfL" }
引數 | 說明 |
---|---|
openid | 普通使用者的標識,對當前開發者帳號唯一 |
nickname | 普通使用者暱稱 |
sex | 普通使用者性別,1為男性,2為女性 |
province | 普通使用者個人資料填寫的省份 |
city | 普通使用者個人資料填寫的城市 |
country | 國家,如中國為CN |
headimgurl | 使用者頭像,最後一個數值代表正方形頭像大小(有0、46、64、96、132數值可選,0代表640*640正方形頭像),使用者沒有頭像時該項為空 |
privilege | 使用者特權資訊,json陣列,如微信沃卡使用者為(chinaunicom) |
unionid | 使用者統一標識。針對一個微信開放平臺帳號下的應用,同一使用者的unionid是唯一的。 |
錯誤的Json返回示例:
{ "errcode":40003,"errmsg":"invalid openid" }
7、總結
最近著手開發了微信網頁掃碼登入和公眾號授權登入收穫頗豐,兩者的開發很類似。以下是我個人摸索過程中發現的兩者的異同:
- 兩者都可以通過微信客戶端掃碼授權的方式,讓第三方頁面獲得微信使用者的一些基本資訊(暱稱、性別、所在地、在微信唯一標示等……)。他們都是通過提供一個連結讓使用者授權的方式。但網頁版需要在頁面開啟二維碼之後授權,而公眾號則需要使用者先關注了我們的公眾號,然後點開公眾號裡面的連結,確認授權即可。
- 網頁掃碼登入需要將授權的連結(二維碼連結)在網頁中開啟、而公眾號授權登入的連結必須要微信客戶端中開啟。
- 無論網頁掃碼登入還是在公眾號中授權登入,都是通過授權的方式獲得一個code引數,之後通過code引數獲取access_token和openid和通過access_token和openid去獲取使用者的基本資訊的請求連結是一樣的。
- 在開發公眾號授權登入的過程中,我發現了有測試賬號的提供,足以滿足我們的測試和開發,但在開發網頁掃碼時,暫時未發現哪裡能獲取測試賬號,我是通過申請獲取的。(希望知道哪裡有測試賬號的請求高手賜教)。