微信登录
登入登出
登入
SDK 提供了快速登录小程序的接口,省去使用微信登录接口时获取 code, session_key 等辅助操作。
danger 从 2022 年 11 月 8 日 24 时开始,小程序
wx.getUserProfile
和wx.getUserInfo
接口将被微信收回,其中获取用户头像将统一返回默认灰色头像,昵称将统一返回“微信用户”。请参考 小程序用户头像昵称获取规则调整公告。为应对微信的调整,小程序 SDK 提供更新头像和昵称支持。通过
wx.BaaS.auth.getCurrentUser()
获取当前用户,并执行内置的update()
方法即可达成更新。详见 设置头像和昵称。
danger 从 2021 年 4 月 28 日后发布的小程序新版本,无法通过 wx.getUserInfo 与
<button open-type="getUserInfo"/>
获取加密的用户个人信息,而需要通过新增的 getUserProfile 接口获取。请参考 小程序登录、用户信息相关接口调整说明。为应对微信的调整,小程序 SDK v3.18.0 中将会调整
wx.BaaS.auth.loginWithWechat()
登录方法,只保留静默登录和一键授权手机号登录两部分,并提供新的更新用户信息方法wx.BaaS.auth.updateUserInfo()
。弹框授权个人信息的执行时机将会返回给开发者自行判断。
info 注意:新发布的小程序中,开发者在用户登录时可直接获取到 unionID。
小程序建议的登录流程是,可通过 wx.BaaS.auth.loginWithWechat()
获取用户 openID,这时无需弹框授权,开发者拿到 openID 可以建立自身的帐号 ID。
静默登录
wx.BaaS.auth.loginWithWechat(null, { createUser })
该方法会进行简单的登录,不需要用户授权,即不会弹出授权框。
danger 从 1.x 升级的请阅读 1.x --> 2.x 迁移指南。
参数说明
参数 | 类型 | 说明 |
---|---|---|
createUser | Boolean | 是否创建用户,默认为 |
withUnionID | Boolean | (SDK version >= 3.8.0)是否使用 unionid 登录,默认为 |
createUser
参数决定了一个新的微信用户第一次登录时的服务端处理行为。 默认为 true
,服务端会有该用户创建一个知晓云用户记录。 当 createUser
为 false
时,服务端会终止登录过程,返回 404 错误码,开发者可根据该返回结果进行多平台账户绑定的处理。详见 多平台用户统一登录 说明
请求示例
登录成功返回示例 then 回调中的 user 对象为 currentUser 对象,请参考currentUser 小节 :
登录失败返回示例
err 对象结构请参考错误码和 HError 对象
设置用户名和邮箱
用户通过微信登录后,可以设置邮箱、用户名、密码,以便下次可以通过用户名或者邮箱登录。
用户一键授权手机号登录
开发者需要提供按钮的方式,令用户触发授权手机号操作,即可通过加密后的手机号,结合 wx.login()
获取到的 code
进行知晓云微信小程序登录。登录成功后用户表的 phone_verified
字段会更新为 true
,省掉了验证手机号的过程。
wx.BaaS.auth.loginWithWechat(data, {code, createUser})
参数说明
参数 | 类型 | 说明 |
---|---|---|
data | object | bindgetphonenumber 事件回调返回的参数 |
code | string | 调用 wx.login() 获取的临时登录凭证 |
createUser | Boolean | 是否创建用户,默认为 true |
code
参数说明:由于在回调中调用 wx.login()
登录,可能会刷新登录态,此时服务器使用 code
换取的 sessionKey
不是加密时使用的 sessionKey
, 导致解密失败。因此要求开发者提前进行 wx.login()
。
createUser
参数决定了一个新的微信用户第一次登录时的服务端处理行为。 默认为 true
,服务端会为该用户创建一个知晓云用户记录。 当 createUser
为 false
时,服务端会终止登录过程,返回 404 错误码,开发者可根据该返回结果进行多平台账户绑定的处理。详见 多平台用户统一登录 说明。
用户点击该按钮时,会触发 wxLogin()
获取到临时登录凭证 code
,同时弹出授权手机号面板;点击授权面板会触发 phoneNumberHandler()
方法,返回获取到的用户加密手机号信息;开发者需在回调中调用 wx.BaaS.auth.loginWithWechat
方法,以使用加密的手机号,结合 wx.login()
获取到的 code
进行知晓云微信小程序登录。
请求示例
用户同意授权返回示例 then 回调中的 user 对象为 currentUser 对象,请参考currentUser 小节 :
用户拒绝授权示例 catch 回调中的 HError 对象示例:
其他错误 catch 回调中的 res 对象示例:
res 对象结构请参考错误码和 HError 对象
更新用户手机号
开发者需要提供按钮的方式,令用户触发授权手机号操作。更新之后,用户表的 phone_verified 字段会更新为 true ,省掉了验证手机号的过程。
wx.BaaS.auth.updatePhoneNumber(data, {overwrite})
参数说明
参数 | 类型 | 说明 |
---|---|---|
data | object | bindgetphonenumber 事件回调返回的参数 |
overwrite | Boolean | 默认为 true。如果设置为 false,用户原本绑定了其他手机号会返回 400 错误 |
用户点击该按钮时,会返回获取到的用户加密手机号信息,开发者需在回调中调用 wx.BaaS.auth.updatePhoneNumber
方法,以更新用户手机号。
请求示例
用户同意授权返回示例 then 回调中的 user 对象为 currentUser 对象,请参考currentUser 小节 :
用户拒绝授权示例 catch 回调中的 HError 对象示例:
其他错误 catch 回调中的 res 对象示例:
res 对象结构请参考错误码和 HError 对象
info
wx.BaaS.auth.updatePhoneNumber
需要用户已登录,若未登录,该接口会返回 604 错误。
关联微信小程序
通过此方法可将通用注册登录用户(在已登录状态下)关联微信小程序账号。
UserRecord.linkWechat({withUnionID})
danger 从 2021 年 4 月 28 日后发布的小程序新版本,无法通过 wx.getUserInfo 与
<button open-type="getUserInfo"/>
获取加密的用户个人信息,而需要通过新增的 getUserProfile 接口获取。请参考 小程序登录、用户信息相关接口调整说明。为应对微信的调整,小程序 SDK v3.18.0 中将会调整关联微信小程序方法,只保留 unionid 登录,原有通过
getUserInfo
获取用户信息并作参数传入关联微信方法会被废弃。
参数说明
参数 | 类型 | 说明 |
---|---|---|
withUnionID | Boolean | (SDK version >= 3.8.0)是否使用 unionid 登录 并关联,默认为 |
请求示例
返回示例
多平台用户统一登录
假设开发者现在同时支持微信小程序和 web 端登录,需要微信小程序新用户关联到已经注册好的用户账户,才能登录成功。 可以通过 loginWithWechat
的参数 createUser
设置为 false
,此时,服务端会判断该用户是否已经有账户记录, 如果没有,则返回 404 状态码。开发者可根据此状态码,跳转到需要填写用户名密码页面,进行已有账户的关联或新的账户的创建, 完成后,调用 linkWechat
方法完成当前微信小程序用户与账户的绑定。下一次用户再次登录时,则会直接登录成功。
示例代码
静默登录时检查
请求用户授权后检查
若已经提前申请了用户授权,也可以在 wx.getUserInfo() 的 success 回调中进行关联账户
请求用户授权
开发者需要提供按钮的方式,令用户触发授权操作
wx.BaaS.auth.loginWithWechat(data, {createUser, syncUserProfile})
参数说明
参数 | 类型 | 说明 |
---|---|---|
data | object | bindgetuserinfo 事件回调返回的参数 |
createUser | Boolean | 是否创建用户,默认为 true |
syncUserProfile | String | 是否同步第一层级用户信息,可选值为 |
withUnionID | Boolean | (SDK version >= 3.8.0)是否使用 unionid 登录,默认为 |
createUser
参数决定了一个新的微信用户第一次登录时的服务端处理行为。 默认为 true
,服务端会有该用户创建一个知晓云用户记录。 当 createUser
为 false
时,服务端会终止登录过程,返回 404 错误码,开发者可根据该返回结果进行多平台账户绑定的处理。详见 多平台用户统一登录 说明
{{ userInfoAlert() }}
用户点击该按钮时,会返回获取到的用户信息,其中包括加密的敏感信息,开发者需在回调中调用 wx.BaaS.loginWithWechat
方法,以获得解密后的全部用户信息。
请求示例
用户同意授权返回示例 then 回调中的 user 对象为 currentUser 对象,请参考currentUser 小节 :
用户拒绝授权示例 catch 回调中的 HError 对象示例:
其他错误 catch 回调中的 res 对象示例:
res 对象结构请参考错误码和 HError 对象
info
wx.BaaS.auth.loginWithWechat
默认会检查用户是否已登录,若未登录,该接口默认会先执行登录操作
已废弃
更新用户信息
已废弃
更新用户信息开发者需要提前调用 wx.getUserProfile
获取用户信息,并调用以下方法更新。
wx.BaaS.auth.updateUserInfo(data, {code, syncUserProfile})
danger 注意:在微信开发者工具中使用基础库版本小于 2.16.0 并调用
wx.getUserProfile
时是无法获取到 iv、rawData、signature 和 encryptedData 等字段的。为应对微信的调整,小程序基础库版本大于等于 2.16.0 时开发者需要先通过wx.login
获取用户登录凭证code
,并调用wx.getUserProfile
获取用户信息,再传入updateUserInfo
方法。基础库版本小于 2.16.0 则无需调用 wx.login 方法,直接调用 wx.getUserProfile 即可。同时,由于微信限制了 wx.getUserProfile 不能直接在 wx.login 的回调中调用,因此开发者需注意调用方法的顺序。也就是说,先调用
wx.login
方法,再调用wx.getUserProfile
。SDK 推荐使用 Promise.all 的方式处理上述问题。
info 由于
wx.getUserProfile
必须在点击事件里触发,无法直接在回调中调用,因此开发者需要注意区分登录wx.BaaS.auth.loginWithWechat
和wx.getUserProfile
的调用时机。
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
data | Object | 是 | wx.getUserProfile 事件回调返回的参数 |
code | Object | 否 | 用户登录凭证,基础库大于等于 2.16.0 时必填 |
syncUserProfile | String | 否 | 是否同步第一层级用户信息,可选值为 |
请求示例
基础库版本大于等于 2.16.0
:
基础库小于 2.16.0
:
用户同意授权返回示例 then 回调中的 user 对象为 currentUser 对象,请参考currentUser 小节 :
用户拒绝授权示例 catch 回调中的 HError 对象示例:
其他错误 catch 回调中的 res 对象示例:
res 对象结构请参考错误码和 HError 对象
info
wx.BaaS.auth.updateUserInfo
需要用户已登录,若未登录,该接口会返回 604 错误。 如果未在控制台开启“允许在 SDK 更新用户信息”开关,该接口会返回 616 错误。
已废弃
登入登出(SDK < 3.18.0)
已废弃
登入登出(SDK < 3.18.0)danger 从 2018 年 4 月 30 日开始,在小程序的体验版和开发版调用 wx.getUserInfo 接口,将默认调用失败。为应对微信的调整,我们在 SDK v1.4.0 中增加了对新的登录流程的支持,因此也推荐你使用新的 SDK 接口来完成登录和获取用户信息功能。关于最佳的登录实践,可参考 微信登录能力优化
小程序建议的登录流程是,通过 wx.BaaS.auth.loginWithWechat()
获取用户 openID, 这时无需弹框授权,开发者拿到 openID 可以建立自身的帐号 ID。当必须要获得用户的头像昵称等信息时,才让用户点击 button(open-type="getUserInfo" ),弹框授权。
已废弃
登入登出(SDK < 2.0.0)
已废弃
登入登出(SDK < 2.0.0)info 目前 SDK 2.x 版本暂时兼容 1.x 版本的登录 API,开发者可以在不变动代码的情况下进行 SDK 版本升级,但强烈建议开发者根据指导对代码进行调整。
登录(旧)
小程序建议的登录流程是,通过 wx.login(false)
获取用户 openID, 这时无需弹框授权,开发者拿到 openID 可以建立自身的帐号 ID。当必须要获得用户的头像昵称等信息时,才让用户点击 button(open-type="getUserInfo" ),弹框授权。
wx.BaaS.login(false)
该方法会进行简单的登录,不需要用户授权,即不会弹出授权框。
info wx.BaaS.login(true) 或 wx.BaaS.login() 用于弹窗授权,由于微信规则更改,已被废弃。
返回字段说明
参数 | 类型 | 说明 |
---|---|---|
id | Integer | 用户在用户表中的 ID |
openid | String | 用户唯一标识,由微信生成 |
unionid | String | 用户在开放平台的唯一标识符,由微信生成 |
session_expires_at | Integer | 指示当前登录态的过期时间,由知晓云维护。该值为一个 unix 时间戳 |
请求示例
登录成功返回示例
登录失败返回示例
err 对象结构请参考错误码和 HError 对象
请求用户授权(旧)
开发者需要提供按钮的方式,令用户触发授权操作
用户点击该按钮时,会返回获取到的用户信息,其中包括加密的敏感信息,开发者需在回调中调用 wx.BaaS.handleUserInfo
方法,以获得解密后的全部用户信息。
请求示例
用户同意授权返回示例 then 回调中的 res 对象示例:
用户拒绝授权示例 catch 回调中的 res 对象示例:
其他错误 catch 回调中的 res 对象示例:
res 对象结构请参考错误码和 HError 对象
wx.BaaS.handleUserInfo
返回字段说明
当用户拒绝授权时:
参数 | 类型 | 说明 |
---|---|---|
id | Number | 用户在用户表中的 ID |
openid | String | 用户唯一标识,由微信生成 |
unionid | String | 用户在开放平台的唯一标识符,由微信生成 |
session_expires_at | Integer | 指示当前登录态的过期时间,由知晓云维护。该值为一个 unix 时间戳 |
当用户允许授权时,在上面返回参数的基础上,加上以下几个参数:
参数 | 类型 | 说明 |
---|---|---|
avatarUrl | String | 用户头像 |
city | String | 用户所在城市 |
country | String | 用户所在国家 |
gender | Number | 用户的性别,值为 1 时是男性,值为 2 时是女性,值为 0 时是未知 |
language | String | 用户的语言,简体中文为 zh_CN |
nickName | String | 用户昵称 (这里的 nickName 由微信登录接口直接返回,注意与 MyUser.get 方法返回的 nickname 字段拼写上的不同) |
province | String | 用户所在省份 |
info
wx.BaaS.handleUserInfo
默认会检查用户是否已登录,若未登录,该接口默认会先执行登录操作
Last updated