OBJECT参数说明:javascript
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success返回参数说明:java
参数名 | 类型 | 说明 |
---|---|---|
errMsg | String | 调用结果 |
code | String | 用户容许登陆后,回调内容会带上 code(有效期五分钟),开发者须要将 code 发送到开发者服务器后台,使用code 换取 session_key api,将 code 换成 openid 和 session_key |
示例代码:小程序
//app.js App({ onLaunch: function() { wx.login({ success: function(res) { if (res.code) { //发起网络请求 wx.request({ url: 'https://test.com/onLogin', data: { code: res.code } }) } else { console.log('获取用户登陆态失败!' + res.errMsg) } } }); } })
这是一个 HTTPS 接口,开发者服务器使用登陆凭证 code 获取 session_key 和 openid。其中 session_key 是对用户数据进行加密签名的密钥。为了自身应用安全,session_key 不该该在网络上传输。api
接口地址:安全
https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
请求参数:服务器
参数 | 必填 | 说明 |
---|---|---|
appid | 是 | 小程序惟一标识 |
secret | 是 | 小程序的 app secret |
js_code | 是 | 登陆时获取的 code |
grant_type | 是 | 填写为 authorization_code |
返回参数:微信
参数 | 说明 |
---|---|
openid | 用户惟一标识 |
session_key | 会话密钥 |
unionid | 用户在开放平台的惟一标识符。本字段在知足必定条件的状况下才返回。具体参看UnionID机制说明 |
返回说明:网络
//正常返回的JSON数据包 { "openid": "OPENID", "session_key": "SESSIONKEY" "unionid": "UNIONID" } //错误时返回JSON数据包(示例为Code无效) { "errcode": 40029, "errmsg": "invalid code" }
经过上述接口得到的用户登陆态拥有必定的时效性。用户越久未使用小程序,用户登陆态越有可能失效。反之若是用户一直在使用小程序,则用户登陆态一直保持有效。具体时效逻辑由微信维护,对开发者透明。开发者只须要调用wx.checkSession接口检测当前用户登陆态是否有效。登陆态过时后开发者能够再调用wx.login获取新的用户登陆态。session
OBJECT参数说明:app
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数,登录态未过时 |
fail | Function | 否 | 接口调用失败的回调函数,登录态已过时 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
wx.checkSession({
success: function(){ //session 未过时,而且在本生命周期一直有效 }, fail: function(){ //登陆态过时 wx.login() //从新登陆....
}
})
经过wx.login()
获取到用户登陆态以后,须要维护登陆态。开发者要注意不该该直接把 session_key、openid 等字段做为用户的标识或者 session 的标识,而应该本身派发一个 session 登陆态(请参考登陆时序图)。对于开发者本身生成的 session,应该保证其安全性且不该该设置较长的过时时间。session 派发到小程序客户端以后,可将其存储在 storage ,用于后续通讯使用。
经过wx.checkSession()
检测用户登陆态是否失效。并决定是否调用wx.login() 从新获取登陆态