準(zhǔn)備工作
在微信開放平臺注冊開發(fā)者帳號唤殴,并擁有一個已審核通過的網(wǎng)站應(yīng)用档痪,并獲得相應(yīng)的AppID和AppSecret廊勃,申請微信登錄且通過審核后辉饱,可開始接入流程搬男。
大概流程可參照我的另一篇日記(微博登錄)
授權(quán)流程說明
微信OAuth2.0授權(quán)登錄讓微信用戶使用微信身份安全登錄第三方應(yīng)用或網(wǎng)站拣展,在微信用戶授權(quán)登錄已接入微信OAuth2.0的第三方應(yīng)用后彭沼,第三方可以獲取到用戶的接口調(diào)用憑證(access_token),通過access_token可以進(jìn)行微信開放平臺授權(quán)關(guān)系接口調(diào)用备埃,從而可實(shí)現(xiàn)獲取微信用戶基本開放信息和幫助用戶實(shí)現(xiàn)基礎(chǔ)開放功能等姓惑。
微信OAuth2.0授權(quán)登錄目前支持authorization_code模式褐奴,適用于擁有server端的應(yīng)用授權(quán)。該模式整體流程為:
- 第三方發(fā)起微信授權(quán)登錄請求于毙,微信用戶允許授權(quán)第三方應(yīng)用后敦冬,微信會拉起應(yīng)用或重定向到第三方網(wǎng)站,并且?guī)鲜跈?quán)臨時(shí)票據(jù)code參數(shù)唯沮;
- 通過code參數(shù)加上AppID和AppSecret等脖旱,通過API換取access_token;
- 通過access_token進(jìn)行接口調(diào)用介蛉,獲取用戶基本數(shù)據(jù)資源或幫助用戶實(shí)現(xiàn)基本操作萌庆。
第一步:請求CODE
第三方使用網(wǎng)站應(yīng)用授權(quán)登錄前請注意已獲取相應(yīng)網(wǎng)頁授權(quán)作用域(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
若提示“該鏈接無法訪問”币旧,請檢查參數(shù)是否填寫錯誤践险,如redirect_uri的域名與審核時(shí)填寫的授權(quán)域名不一致或scope不為snsapi_login。
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
appid | 是 | 應(yīng)用唯一標(biāo)識 |
redirect_uri | 是 | 重定向地址(請使用urlEncode對鏈接進(jìn)行處理) |
response_type | 是 | 填code |
scope | 是 | 應(yīng)用授權(quán)作用域吹菱,擁有多個作用域用逗號(,)分隔巍虫,網(wǎng)頁應(yīng)用目前僅填寫snsapi_login即 |
state | 否 | 用于保持請求和回調(diào)的狀態(tài),授權(quán)請求后原樣帶回給第三方鳍刷。該參數(shù)可用于防止csrf攻擊(跨站請求偽造攻擊)占遥,建議第三方帶上該參數(shù),可設(shè)置為簡單的隨機(jī)數(shù)加session進(jìn)行校驗(yàn) |
返回說明
用戶允許授權(quán)后输瓜,將會重定向到redirect_uri的網(wǎng)址上筷频,并且?guī)蟘ode和state參數(shù)
redirect_uri?code=CODE&state=STATE
若用戶禁止授權(quán),則重定向后不會帶上code參數(shù)前痘,僅會帶上state參數(shù)
redirect_uri?state=STATE
請求示例
登錄一號店網(wǎng)站應(yīng)用
https://passport.yhd.com/wechat/login.do
打開后凛捏,一號店會生成state參數(shù),跳轉(zhuǎn)到
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
微信用戶使用微信掃描二維碼并且確認(rèn)登錄后芹缔,PC端會跳轉(zhuǎn)到
https://passport.yhd.com/wechat/callback.do?code=CODE&state=3d6be0a4035d839573b04816624a415e
為了滿足網(wǎng)站更定制化的需求坯癣,我們還提供了第二種獲取code的方式,支持網(wǎng)站將微信登錄二維碼內(nèi)嵌到自己頁面中最欠,用戶使用微信掃碼授權(quán)后通過JS將code返回給網(wǎng)站示罗。
JS微信登錄主要用途:網(wǎng)站希望用戶在網(wǎng)站內(nèi)就能完成登錄,無需跳轉(zhuǎn)到微信域下登錄后再返回芝硬,提升微信登錄的流暢性與成功率蚜点。 網(wǎng)站內(nèi)嵌二維碼微信登錄JS實(shí)現(xiàn)辦法:
步驟1:在頁面中先引入如下JS文件(支持https):
http://res.wx.qq.com/connect/zh_CN/htmledition/js/wxLogin.js
步驟2:在需要使用微信登錄的地方實(shí)例以下JS對象:
var obj = new WxLogin({
self_redirect:true,
id:"login_container",
appid: "",
scope: "",
redirect_uri: "",
state: "",
style: "",
href: ""
});
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
self_redirect | 否 | true:手機(jī)點(diǎn)擊確認(rèn)登錄后可以在 iframe 內(nèi)跳轉(zhuǎn)到 redirect_uri,false:手機(jī)點(diǎn)擊確認(rèn)登錄后可以在 top window 跳轉(zhuǎn)到 redirect_uri拌阴。默認(rèn)為 false绍绘。 |
id | 是 | 第三方頁面顯示二維碼的容器id (即頁面div的id) |
appid | 是 | 應(yīng)用唯一標(biāo)識,在微信開放平臺提交應(yīng)用審核通過后獲得 |
scope | 是 | 應(yīng)用授權(quán)作用域,擁有多個作用域用逗號(,)分隔陪拘,網(wǎng)頁應(yīng)用目前僅填寫snsapi_login即可 |
redirect_uri | 是 | 重定向地址厂镇,需要進(jìn)行UrlEncode |
state | 否 | 用于保持請求和回調(diào)的狀態(tài),授權(quán)請求后原樣帶回給第三方左刽。該參數(shù)可用于防止csrf攻擊(跨站請求偽造攻擊)捺信,建議第三方帶上該參數(shù),可設(shè)置為簡單的隨機(jī)數(shù)加session進(jìn)行校驗(yàn) |
style | 否 | 提供"black"欠痴、"white"可選迄靠,默認(rèn)為黑色文字描述。 |
href | 否 | 自定義樣式鏈接喇辽,第三方可根據(jù)實(shí)際需求覆蓋默認(rèn)樣式梨水。 |
第二步:通過code獲取access_token
通過code獲取access_token
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
appid | 是 | 應(yīng)用唯一標(biāo)識 |
secret | 是 | 應(yīng)用密鑰AppSecret,在微信開放平臺提交應(yīng)用審核通過后獲得 |
code | 是 | 填寫第一步獲取的code參數(shù) |
grant_type | 是 | 填authorization_code |
返回說明
正確的返回:
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE",
"unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"
}
參數(shù)說明
參數(shù) | 說明 |
---|---|
access_token | 接口調(diào)用憑證 |
expires_in | access_token接口調(diào)用憑證超時(shí)時(shí)間茵臭,單位(秒) |
refresh_token | 用戶刷新access_token |
openid | 授權(quán)用戶唯一標(biāo)識 |
scope | 用戶授權(quán)的作用域疫诽,使用逗號(,)分隔 |
unionid | 當(dāng)且僅當(dāng)該網(wǎng)站應(yīng)用已獲得該用戶的userinfo授權(quán)時(shí),才會出現(xiàn)該字段旦委。 |
錯誤返回樣例:
{"errcode":40029,"errmsg":"invalid code"}
刷新access_token有效期
access_token是調(diào)用授權(quán)關(guān)系接口的調(diào)用憑證奇徒,由于access_token有效期(目前為2個小時(shí))較短,當(dāng)access_token超時(shí)后缨硝,可以使用refresh_token進(jìn)行刷新摩钙,access_token刷新結(jié)果有兩種:
- 若access_token已超時(shí),那么進(jìn)行refresh_token會獲取一個新的access_token查辩,新的超時(shí)時(shí)間胖笛;
- 若access_token未超時(shí),那么進(jìn)行refresh_token不會改變access_token宜岛,但超時(shí)時(shí)間會刷新长踊,相當(dāng)于續(xù)期access_token。
refresh_token擁有較長的有效期(30天)萍倡,當(dāng)refresh_token失效的后身弊,需要用戶重新授權(quán)。
請求方法
獲取第一步的code后列敲,請求以下鏈接進(jìn)行refresh_token:
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
appid | 是 | 應(yīng)用唯一標(biāo)識 |
grant_type | 是 | 填refresh_token |
refresh_token | 是 | 填寫通過access_token獲取到的refresh_token參數(shù) (上一步獲取的refresh_token) |
返回說明
正確的返回:
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}
參數(shù)說明
參數(shù) | 說明 |
---|---|
access_token | 接口調(diào)用憑證 |
expires_in | access_token接口調(diào)用憑證超時(shí)時(shí)間阱佛,單位(秒) |
refresh_token | 用戶刷新access_token |
openid | 授權(quán)用戶唯一標(biāo)識 |
scope | 用戶授權(quán)的作用域,使用逗號(,)分隔 |
<u> ** 注意: ** </u>
1戴而、Appsecret 是應(yīng)用接口使用密鑰凑术,泄漏后將可能導(dǎo)致應(yīng)用數(shù)據(jù)泄漏、應(yīng)用的用戶數(shù)據(jù)泄漏等高風(fēng)險(xiǎn)后果所意;存儲在客戶端淮逊,極有可能被惡意竊却呤住(如反編譯獲取Appsecret);
2壮莹、access_token 為用戶授權(quán)第三方應(yīng)用發(fā)起接口調(diào)用的憑證(相當(dāng)于用戶登錄態(tài))翅帜,存儲在客戶端姻檀,可能出現(xiàn)惡意獲取access_token 后導(dǎo)致的用戶數(shù)據(jù)泄漏命满、用戶微信相關(guān)接口功能被惡意發(fā)起等行為;
3绣版、refresh_token 為用戶授權(quán)第三方應(yīng)用的長效憑證胶台,僅用于刷新access_token,但泄漏后相當(dāng)于access_token 泄漏杂抽,風(fēng)險(xiǎn)同上诈唬。
建議將secret、用戶數(shù)據(jù)(如access_token)放在App云端服務(wù)器缩麸,由云端中轉(zhuǎn)接口調(diào)用請求铸磅。
第三步:通過access_token調(diào)用接口
獲取access_token后,進(jìn)行獲取用戶信息接口調(diào)用杭朱,有以下前提:(條件)
- access_token有效且未超時(shí)阅仔;
- 微信用戶已授權(quán)給第三方應(yīng)用帳號相應(yīng)接口作用域(獲取用戶信息時(shí)scope =snsapi_userinfo)。
接口地址
https://api.weixin.qq.com/sns/userinfo?access_token=access_token&openid=openid
請求方式:GET
接口說明
此接口用于獲取用戶個人信息弧械。開發(fā)者可通過OpenID來獲取用戶基本信息八酒。特別需要注意的是,如果開發(fā)者擁有多個移動應(yīng)用刃唐、網(wǎng)站應(yīng)用和公眾帳號羞迷,可通過獲取用戶基本信息中的unionid來區(qū)分用戶的唯一性,因?yàn)橹灰峭粋€微信開放平臺帳號下的移動應(yīng)用画饥、網(wǎng)站應(yīng)用和公眾帳號衔瓮,用戶的unionid是唯一的。換句話說抖甘,同一用戶报辱,對同一個微信開放平臺下的不同應(yīng)用单山,unionid是相同的。請注意米奸,在用戶修改微信頭像后,舊的微信頭像URL將會失效悴晰,因此開發(fā)者應(yīng)該自己在獲取用戶信息后逐工,將頭像圖片保存下來,避免微信頭像URL失效后的異常情況漂辐。
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證(上一步獲取的) |
openid | 是 | 普通用戶的標(biāo)識泪喊,對當(dāng)前開發(fā)者帳號唯一(上一步獲取的) |
返回值
{
"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"
}
參數(shù) | 說明 |
---|---|
openid | 普通用戶的標(biāo)識,對當(dāng)前開發(fā)者帳號唯一 |
nickname | 普通用戶昵稱 |
sex | 普通用戶性別髓涯,1為男性袒啼,2為女性 |
province | 普通用戶個人資料填寫的省份 |
city | 普通用戶個人資料填寫的城市 |
country | 國家,如中國為CN |
headimgurl | 用戶頭像纬纪,最后一個數(shù)值代表正方形頭像大序驹佟(有0摘仅、46娃属、64、96、132數(shù)值可選豺旬,0代表640*640正方形頭像),用戶沒有頭像時(shí)該項(xiàng)為空 |
privilege | 用戶特權(quán)信息坦刀,json數(shù)組鲤遥,如微信沃卡用戶為(chinaunicom) |
unionid | 用戶統(tǒng)一標(biāo)識。針對一個微信開放平臺帳號下的應(yīng)用究孕,同一用戶的unionid是唯一的。 |
建議:
開發(fā)者最好保存用戶unionID信息微酬,以便以后在不同應(yīng)用中進(jìn)行用戶信息互通埋心。
錯誤的Json返回示例:
{
"errcode":40003,"errmsg":"invalid openid"
}
完!
官方文檔請參照: