1. 程式人生 > >移動應用微信登入開發指南

移動應用微信登入開發指南

https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1419317851&token=&lang=zh_CN

準備工作

移動應用微信登入是基於OAuth2.0協議標準 構建的微信OAuth2.0授權登入系統。

在進行微信OAuth2.0授權登入接入之前,在微信開放平臺註冊開發者帳號,並擁有一個已稽核通過的移動應用,並獲得相應的AppID和AppSecret,申請微信登入且通過稽核後,可開始接入流程。

1、目前移動應用上微信登入只提供原生的登入方式,需要使用者安裝微信客戶端才能配合使用。

2、對於Android應用,建議總是顯示微信登入按鈕,當用戶手機沒有安裝微信客戶端時,請引導使用者下載安裝微信客戶端。

3、對於iOS應用,考慮到iOS應用商店稽核指南中的相關規定,建議開發者接入微信登入時,先檢測使用者手機是否已安裝微信客戶端(使用sdk中isWXAppInstalled函式 ),對未安裝的使用者隱藏微信登入按鈕,只提供其他登入方式(比如手機號註冊登入、遊客登入等)。

授權流程說明

微信OAuth2.0授權登入讓微信使用者使用微信身份安全登入第三方應用或網站,在微信使用者授權登入已接入微信OAuth2.0的第三方應用後,第三方可以獲取到使用者的介面呼叫憑證(access_token),通過access_token可以進行微信開放平臺授權關係介面呼叫,從而可實現獲取微信使用者基本開放資訊和幫助使用者實現基礎開放功能等。

微信OAuth2.0授權登入目前支援authorization_code模式,適用於擁有server端的應用授權。該模式整體流程為:

1. 第三方發起微信授權登入請求,微信使用者允許授權第三方應用後,微信會拉起應用或重定向到第三方網站,並且帶上授權臨時票據code引數;

2. 通過code引數加上AppID和AppSecret等,通過API換取access_token;

3. 通過access_token進行介面呼叫,獲取使用者基本資料資源或幫助使用者實現基本操作。

獲取access_token時序圖:

第一步:請求CODE

移動應用微信授權登入

開發者需要配合使用微信開放平臺提供的SDK進行授權登入請求接入。正確接入SDK後並擁有相關授權域(scope,什麼是授權域?)許可權後,開發者移動應用會在終端本地拉起微信應用進行授權登入,微信使用者確認後微信將拉起開發者移動應用,並帶上授權臨時票據(code)。

iOS平臺應用授權登入接入程式碼示例(請參考iOS接入指南):


-(void)sendAuthRequest
{
//構造SendAuthReq結構體
SendAuthReq* req =[[[SendAuthReq alloc]init]autorelease];
req.scope = @"snsapi_userinfo";
req.state = @"123";
//第三方向微信終端傳送一個SendAuthReq訊息結構
[WXApi sendReq:req];
}

Android平臺應用授權登入接入程式碼示例(請參考Android接入指南):

{
// send oauth request
Final SendAuth.Req req = new SendAuth.Req();
req.scope = "snsapi_userinfo";
req.state = "wechat_sdk_demo_test";
api.sendReq(req);
}

引數說明

引數 是否必須 說明
appid 應用唯一標識,在微信開放平臺提交應用稽核通過後獲得
scope 應用授權作用域,如獲取使用者個人資訊則填寫snsapi_userinfo( 什麼是授權域? )
state 用於保持請求和回撥的狀態,授權請求後原樣帶回給第三方。該引數可用於防止csrf攻擊(跨站請求偽造攻擊),建議第三方帶上該引數,可設定為簡單的隨機數加session進行校驗

返回示例:

appid: wxd477edab60670232
scope: snsapi_userinfo
state: wechat_sdk_demo

可拉起微信開啟授權登入頁:

返回說明

使用者點選授權後,微信客戶端會被拉起,跳轉至授權介面,使用者在該介面點選允許或取消,SDK通過SendAuth的Resp返回資料給呼叫方。

返回值 說明
ErrCode ERR_OK = 0(使用者同意) ERR_AUTH_DENIED = -4(使用者拒絕授權) ERR_USER_CANCEL = -2(使用者取消)
code 使用者換取access_token的code,僅在ErrCode為0時有效
state 第三方程式傳送時用來標識其請求的唯一性的標誌,由第三方程式呼叫sendReq時傳入,由微信終端回傳,state字串長度不能超過1K
lang 微信客戶端當前語言
country 微信使用者當前國家資訊

第二步:通過code獲取access_token

獲取第一步的code後,請求以下連結獲取access_token:

https://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"}

重新整理access_token有效期

access_token是呼叫授權關係介面的呼叫憑證,由於access_token有效期(目前為2個小時)較短,當access_token超時後,可以使用refresh_token進行重新整理,access_token重新整理結果有兩種:

1. 若access_token已超時,那麼進行refresh_token會獲取一個新的access_token,新的超時時間;
2. 若access_token未超時,那麼進行refresh_token不會改變access_token,但超時時間會重新整理,相當於續期access_token。

refresh_token擁有較長的有效期(30天),當refresh_token失效的後,需要使用者重新授權。

請求方法

獲取第一步的code後,請求以下連結進行refresh_token:

https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=APPID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

引數說明

引數 是否必須 說明
appid 應用唯一標識
grant_type 填refresh_token
refresh_token 填寫通過access_token獲取到的refresh_token引數

返回說明

正確的返回:

{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}
引數 說明
access_token 介面呼叫憑證
expires_in access_token介面呼叫憑證超時時間,單位(秒)
refresh_token 使用者重新整理access_token
openid 授權使用者唯一標識
scope 使用者授權的作用域,使用逗號(,)分隔

錯誤返回樣例:

{"errcode":40030,"errmsg":"invalid refresh_token"}

注意:


1、Appsecret 是應用介面使用金鑰,洩漏後將可能導致應用資料洩漏、應用的使用者資料洩漏等高風險後果;儲存在客戶端,極有可能被惡意竊取(如反編譯獲取Appsecret);
2、access_token 為使用者授權第三方應用發起介面呼叫的憑證(相當於使用者登入態),儲存在客戶端,可能出現惡意獲取access_token 後導致的使用者資料洩漏、使用者微信相關介面功能被惡意發起等行為;
3、refresh_token 為使用者授權第三方應用的長效憑證,僅用於重新整理access_token,但洩漏後相當於access_token 洩漏,風險同上。

建議將Appsecret、使用者資料(如access_token)放在App雲端伺服器,由雲端中轉介面呼叫請求。

第三步:通過access_token呼叫介面

獲取access_token後,進行介面呼叫,有以下前提:

  1. access_token有效且未超時;
  2. 微信使用者已授權給第三方應用帳號相應介面作用域(scope)。

對於介面作用域(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 獲取使用者個人資訊

其中snsapi_base屬於基礎介面,若應用已擁有其它scope許可權,則預設擁有snsapi_base的許可權。使用snsapi_base可以讓移動端網頁授權繞過跳轉授權登入頁請求使用者授權的動作,直接跳轉第三方網頁帶上授權臨時票據(code),但會使得使用者已授權作用域(scope)僅為snsapi_base,從而導致無法獲取到需要使用者授權才允許獲得的資料和基礎功能。

介面呼叫方法可查閱《微信授權關係介面呼叫指南》

F.A.Q

1. 什麼是授權臨時票據(code)?

答:第三方通過code進行獲取access_token的時候需要用到,code的超時時間為10分鐘,一個code只能成功換取一次access_token即失效。code的臨時性和一次保障了微信授權登入的安全性。第三方可通過使用https和state引數,進一步加強自身授權登入的安全性。

2. 什麼是授權作用域(scope)?

答:授權作用域(scope)代表使用者授權給第三方的介面許可權,第三方應用需要向微信開放平臺申請使用相應scope的許可權後,使用文件所述方式讓使用者進行授權,經過使用者授權,獲取到相應access_token後方可對介面進行呼叫。

3.開放平臺移動應用微信登入目前是否收費?

答:“微信登入”和第三方網站共享微信龐大的使用者價值,同時為微信使用者提供更便捷服務和更優質內容,實現雙向共贏,目前不收取任何費用。