# vk.userCenter 用户中心 API
该 API 仅适用于前端使用，无法在云函数中使用。
注意事项
- 对于
nvue页面、支付宝小程序、百度小程序，需要在js中使用uni.vk替代vk，或者在页面<script>标签的第一行增加代码var vk = uni.vk;
<script>
var vk = uni.vk;
export default {
data() {
// 页面数据变量
return {
}
},
// 其他代码
}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 公共请求参数
| 参数 | 说明 | 类型 |
|---|---|---|
| data | 发送到云函数的参数数据 | Object |
| title | 遮罩层提示语，为空或不传则代表不显示遮罩层 | String |
| loading | 自定义loading 查看详情 | Boolean、Object |
| needAlert | 请求错误时是否弹窗提示，默认true | Boolean |
| success | 请求成功时的回调函数 | Function |
| fail | 请求失败时的回调函数 | Function |
| complete | 请求完成时的回调函数 | Function |
# loading
loading 参数详细说明
若
loading的值为false，则不显示默认遮罩层提示语若
loading的值为true，则不显示默认遮罩层提示语，同时在请求时，会自动设置页面变量loading=true，请求完成时，自动设置页面变量loading=false若
loading的值类型为Object，如下方代码效果是：请求时，会自动执行this.loading2=true，请求完成时，会自动执行this.loading2=false
loading:{ that:this, name:"loading2"}
1
- name 属性支持使用
.表示嵌套变量，如下方代码效果是：请求时，会自动执行this.page.loading=true，请求完成时，会自动执行this.page.loading=false
loading:{ that:this, name:"page.loading"}
1
# 公共返回信息
| 参数 | 说明 | 类型 |
|---|---|---|
| code | 错误码 | Number |
| msg | 错误提示 | String |
# 监听
# vk.onRefreshToken（监听token更新事件）
在App.vue里全局监听示例：
onLaunch: function() {
// 监听token的更新
uni.vk.onRefreshToken((data)=>{
if (data.token) {
// 有新的token
console.log('token更新监听：', data);
} else {
// token失效或过期
console.log('token失效监听：', data);
}
});
},
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
在某个页面里局部监听示例：
在 onLoad 时写监听，在 onUnload 时移除监听，在 methods 内写监听的回调函数。
export default {
// 监听 - 页面每次【加载时】执行(如：前进)
onLoad(options = {}) {
// 监听token的更新
uni.vk.onRefreshToken(this.onRefreshToken);
},
// 监听 - 页面每次【卸载时】（一般用于取消页面上的监听器）
onUnload(){
// 页面卸载时需要手动移除监听
uni.vk.offRefreshToken(this.onRefreshToken);
},
// 函数
methods: {
onRefreshToken(data){
if (data.token) {
// 有新的token
console.log('token更新监听：', data);
} else {
// token失效或过期
console.log('token失效监听：', data);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# vk.offRefreshToken（移除监听token更新事件）
一般只有在某个页面里局部监听时才需要用到
在 onLoad 时写监听，在 onUnload 时移除监听，在 methods 内写监听的回调函数。
export default {
// 监听 - 页面每次【加载时】执行(如：前进)
onLoad(options = {}) {
// 监听token的更新
uni.vk.onRefreshToken(this.onRefreshToken);
},
// 监听 - 页面每次【卸载时】（一般用于取消页面上的监听器）
onUnload(){
// 页面卸载时需要手动移除监听
uni.vk.offRefreshToken(this.onRefreshToken);
},
// 函数
methods: {
onRefreshToken(data){
if (data.token) {
// 有新的token
console.log('token更新监听：', data);
} else {
// token失效或过期
console.log('token失效监听：', data);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 通用
# vk.userCenter.register（注册）
通过用户名+密码方式进行注册，注册成功则自动登录。
框架会自动保存 token，无需你再手动去保存。
/**
* 用户注册(用户名+密码)
* @param {Object} data 请求参数
* @param {String} data.username 用户名
* @param {String} data.password 密码
* @param {Function} success 成功回调函数，参数为请求成功后的数据
* @param {Function} fail 失败回调函数，参数为请求失败后的错误信息
* @param {Function} complete 无论请求成功与否，都会执行的回调函数
* @returns 返回参数说明
* @returns {String} token 注册完成自动登录之后返回的token信息
* @returns {String} tokenExpired token过期时间
* @returns {Object} userInfo 用户信息
* @returns {String} uid 用户ID
*/
vk.userCenter.register({
data: {
username: "",
password: ""
},
success: (data) => {
// 注册成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# vk.userCenter.login（登录）
用户名+密码
框架会自动保存 token，无需你再手动去保存。
/**
* 用户登陆(用户名+密码)
* data 请求参数 说明
* @param {String} username 用户名
* @param {String} password 密码
* res 返回参数说明
* @param {String} token 注册完成自动登录之后返回的token信息
* @param {String} tokenExpired token过期时间
* @param {Object} userInfo 用户信息
* @param {String} uid 用户ID
*/
vk.userCenter.login({
data: {
username: "",
password: ""
},
success: (data) => {
// 登录成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# vk.userCenter.updatePwd（修改密码）
/**
* 修改密码
* @description 修改成功后，需要重新登录获取新的token
* data 请求参数 说明
* @param {String} oldPassword 旧密码
* @param {String} newPassword 新密码
*/
vk.userCenter.updatePwd({
data: {
oldPassword: "123456",
newPassword: "654321",
password_confirmation: "654321"
},
success: (data) => {
// 修改成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# vk.userCenter.logout（登出）
/**
* 登出(退出)
*/
vk.userCenter.logout({
success: (data) => {
// 退出登录成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.resetPwd（重置密码）
/**
* 重置密码
* data 请求参数 说明
* @param {String} password 重置后的密码
*/
vk.userCenter.resetPwd({
data: {
password: "123456"
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# vk.userCenter.setAvatar（设置头像）
/**
* 设置头像
* data 请求参数 说明
* @param {String} avatar 头像地址
* @param {Boolean} deleteOldFile 是否同时删除云储存内的旧头像文件
*/
vk.userCenter.setAvatar({
data: {
avatar: "https://www.aa.com/1.jpg",
deleteOldFile: false, // 是否同时删除云储存内的旧头像文件，true代表是
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.updateUser（设置昵称等）
/**
* 设置昵称等用户展示的个人信息
* data 请求参数 说明
* @param {String} nickname 昵称
* @param {String} avatar 头像
* @param {Number} gender 性别
*/
vk.userCenter.updateUser({
data: {
nickname: "剑圣李白",
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.getCurrentUserInfo（取用户信息）
/**
* 获取用户最新信息
* res 返回参数说明
* @param {Object} userInfo 用户信息
*/
vk.userCenter.getCurrentUserInfo({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# vk.userCenter.checkToken（token云端校验）
注意：实际开发过程中，无需你主动执行这个api来判断用户tokne是否有效
/**
* token校验
* res 返回参数说明
* @param {String} uid 当前token对应的用户uid
* @param {Object} userInfo 当前用户信息
* @param {Array} role 当前用户角色
* @param {Array} permission 当前用户权限
*/
vk.userCenter.checkToken({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# vk.checkToken（token本地校验）
此api无网络请求，无延迟
前端校验原理（宽松模式）：只判断token是否存在，且未过期（不解密token内容）（对前端来说，token存在且未过期，就代表用户已经登录）
云端校验原理（严格模式）：解密token内容，判断token真实性，获得uid，并判断是否过期
你无需担心本地校验用户会伪造的可能，因为用户只要请求云函数，云端最终还会再校验一遍的
if (!vk.checkToken()) {
// token无效
} else {
// token有效
}
1
2
3
4
5
6
7
2
3
4
5
6
7
if (vk.checkToken()) {
// token有效
}
1
2
3
4
2
3
4
if (!vk.checkToken()) {
// token无效
return false;
}
// token有效
1
2
3
4
5
6
2
3
4
5
6
# vk.getToken（获取本地token）
注意：token会自动传给云函数，云函数也会自动解析token，故一般情况下，无需调用此api，如真需要，可使用此api获取。
let uni_id_token = vk.getToken();
1
# 手机号
# vk.userCenter.bindMobile（绑定手机）
/**
* 绑定手机号
* data 请求参数 说明
* @param {String} mobile 手机号
* @param {String} code 手机收到的验证码
*/
vk.userCenter.bindMobile({
data: {
mobile: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.unbindMobile（解绑手机）
/**
* 绑定手机号
* data 请求参数 说明
* @param {String} mobile 手机号
* @param {String} code 手机收到的验证码
*/
vk.userCenter.unbindMobile({
data: {
mobile: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.bindNewMobile（换绑手机号）
/**
* 绑定新的手机号（换绑手机号）
* data 请求参数 说明
* @param {String} oldMobile 旧手机号码
* @param {String} oldMobileCode 旧手机收到的验证码
* @param {String} mobile 新手机号码
* @param {String} code 新手机收到的验证码
* res 返回参数说明
* @param {Number} code 错误码，0表示成功
* @param {String} msg 详细信息
*/
vk.userCenter.bindNewMobile({
data: {
oldMobile: '',
oldMobileCode: '',
mobile: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# vk.userCenter.loginBySms（手机号登录）
框架会自动保存 token，无需你再手动去保存。
/**
* 手机号登录（手机号+手机验证码）
* data 请求参数 说明
* @param {String} mobile 手机号（必填）
* @param {String} code 验证码（必填）
* @param {String} type 指定操作类型，不传：存在则登录不存在则注册 login：只能登录 register：只能注册
* @param {String} password 密码，当前用户为新注册时生效
* @param {String} inviteCode 邀请人的邀请码，当前用户为新注册时生效
* @param {String} myInviteCode 设置当前注册用户自己的邀请码，当前用户为新注册时生效（不传会自动生成）
* @param {Boolean} needPermission 设置为true时会在checkToken时返回用户权限（permission），如果是在admin端，需传true
* @param {Array} role 设定用户角色，当前用户为新注册时生效
* res 返回参数说明
* @param {String} token 注册完成自动登录之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginBySms({
data: {
mobile: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# vk.userCenter.sendSmsCode（发送手机号验证码）
/**
* 发送手机号验证码
* data 请求参数 说明
* @param {String} mobile 手机号
* @param {String} type 验证码类型，用于防止不同功能的验证码混用，目前支持的类型login登录、register注册、bind绑定手机、unbind解绑手机、reset-pwd重置密码
* res 返回参数说明
* @param {Object} requestRes 原始返回数据
* @param {Object} requestParam 包含服务供应商和发送的手机号
*/
vk.userCenter.sendSmsCode({
data: {
mobile: '',
type: 'login',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# vk.userCenter.resetPasswordByMobile（根据手机验证码重置账号密码）
/**
* 根据手机验证码重置账号密码
* data 请求参数 说明
* @param {String} password 重置后的密码
* @param {String} code 验证码
* @param {String} mobile 手机号
*/
vk.userCenter.resetPasswordByMobile({
data: {
password: "123456",
code: "",
mobile: ""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
注意
- 对应发送短信验证码接口
type为reset-pwd
# vk.userCenter.loginByUniverify（手机一键登录）
只有 APP 端可以用
框架会自动保存 token，无需你再手动去保存。
/**
* APP端 手机一键登录
* data 请求参数 说明
* @param {String} type 指定操作类型，可选值为login、register，不传此参数时表现为手机号已注册则登录，手机号未注册则进行注册
* @param {String} password 密码，type为register时生效
* @param {String} inviteCode 邀请人的邀请码，type为register时生效
* @param {String} access_token uni.login登录成功后，返回的access_token参数（此参数自动获取，无需填写）
* @param {String} openid uni.login登录成功后，返回的openid参数（此参数自动获取，无需填写）
* @param {String} myInviteCode 设置当前注册用户自己的邀请码，type为register时生效（此参数自动生成，无需填写）
* res 返回参数说明
* @param {Number} code 错误码，0表示成功
* @param {String} msg 详细信息
* @param {String} uid 当前token对应的用户uid
* @param {String} type 操作类型，login为登录、register为注册
* @param {String} mobile 登录者手机号
* @param {String} userInfo 用户全部信息
* @param {String} token 登录成功之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginByUniverify({
// 更多配置请查看 https://uniapp.dcloud.io/univerify
univerifyStyle: {
"fullScreen": true, // 是否全屏显示(hbx3.1.5起支持全屏)，true表示全屏模式，false表示非全屏模式，默认值为false。
"backgroundColor": "#f5f5f5", // 授权页面背景颜色，默认值：#ffffff
"authButton": {
"normalColor": "#19be6b", // 授权按钮正常状态背景颜色 默认值：#3479f5
"highlightColor": "#18b566", // 授权按钮按下状态背景颜色 默认值：#2861c5（仅ios支持）
"disabledColor": "#71d5a1", // 授权按钮不可点击时背景颜色 默认值：#73aaf5（仅ios支持）
"textColor": "#ffffff", // 授权按钮文字颜色 默认值：#ffffff
"title": "本机号码一键登录" // 授权按钮文案 默认值：“本机号码一键登录”
},
"privacyTerms": {
"suffix": "使用本机号码登录", // 条款后的文案 默认值：“并使用本机号码登录”
"termsColor": "#555555"
}
},
data: {
},
success: (data) => {
uni.closeAuthView();
setTimeout(() => {
vk.alert(data.msg);
}, 300);
},
fail: (res) => {
uni.closeAuthView();
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# 邮箱
# vk.userCenter.bindEmail（绑定邮箱）
/**
* 绑定邮箱
* data 请求参数 说明
* @param {String} email 邮箱
* @param {String} code 邮箱收到的验证码
*/
vk.userCenter.bindEmail({
data: {
email: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.unbindEmail（解绑邮箱）
/**
* 解绑邮箱
* @param {String} email 邮箱
* @param {String} code 邮箱收到的验证码
*/
vk.userCenter.unbindEmail({
data: {
email: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# vk.userCenter.bindNewEmail（换绑邮箱）
/**
* 绑定新的邮箱（换绑邮箱）
* @param {String} oldEmail 旧邮箱码
* @param {String} oldEmailCode 旧邮箱收到的验证码
* @param {String} email 新邮箱码
* @param {String} code 新邮箱收到的验证码
*/
vk.userCenter.bindNewEmail({
data: {
oldEmail: '',
oldEmailCode: '',
email: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# vk.userCenter.loginByEmail（邮箱登录）
框架会自动保存 token，无需你再手动去保存。
/**
* 邮箱登录（邮箱+邮箱验证码）
* data 请求参数 说明
* @param {String} email 邮箱
* @param {String} code 邮箱收到的验证码
* @param {String} type 指定操作类型，不传：存在则登录不存在则注册 login：只能登录 register：只能注册
* @param {String} password 密码，当前用户为新注册时生效
* @param {String} myInviteCode 设置当前注册用户自己的邀请码，当前用户为新注册时生效（不传会自动生成）
* @param {Boolean} needPermission 设置为true时会在checkToken时返回用户权限（permission），如果是在admin端，需传true
* @param {Array} role 设定用户角色，当前用户为新注册时生效
* res 返回参数说明
* @param {String} token 注册完成自动登录之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginByEmail({
data: {
email: '',
code: '',
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# vk.userCenter.sendEmailCode（发送邮件验证码）
/**
* 发送邮件验证码
* data 请求参数 说明
* @param {String} email 邮箱
* @param {String} type 验证码类型，用于防止不同功能的验证码混用，目前支持的类型login登录、register注册、bind绑定邮箱、unbind解绑邮箱、reset-pwd重置密码
* @param {String} serviceType 邮件服务类型，默认为qq，可自定义，与uni-config-center/vk-unicloud/index.js内配置的一致即可。
* res 返回参数说明
* @param {String} email 邮箱
* @param {String} verifyCode 验证码
*/
vk.userCenter.sendEmailCode({
data: {
email: '',
type: 'login',
serviceType: 'qq'
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# vk.userCenter.resetPasswordByEmail（根据邮箱证码重置账号密码）
/**
* 根据邮箱证码重置账号密码
* data 请求参数 说明
* @param {String} password 重置后的密码
* @param {String} code 验证码
* @param {String} email 邮箱号码
*/
vk.userCenter.resetPasswordByEmail({
data: {
password: "123456",
code: "",
email: ""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
注意
- 对应发送邮件验证码接口
type为reset-pwd
# 微信
# vk.userCenter.loginByWeixin（微信登录）
框架会自动保存 token，无需你再手动去保存。
注意：
微信小程序登录配置
- 配置
common/uni-config-center/uni-id/config.json内mp-weixin的appid和appsecret
- 在
manifest.json内配置微信小程序的appid
APP登录配置
- 在
manifest.json的APP模块配置微信登录用appid
- 打包并使用自定义基座（注意一定要在
manifest.json填写微信appid后再制作自定义基座）自定义基座使用说明 (opens new window) - 配置
common/uni-config-center/uni-id/config.json内app-plus.oauth.weixin的appid和appsecret
微信公众号H5登录配置
- 配置
common/uni-config-center/uni-id/config.json内h5-weixin的appid和appsecret
注意1：h5的路由模式必须配置为 history，因为微信公众号登录的回调地址不支持 hash 模式。
注意2：你的前端托管那需要设置404指向的页面为index.html
注意3：网页授权时拼接的scope参数的值必须是snsapi_userinfo，同时再绑定开放平台，才能获取到unionid
注意：自 2.11.0（2022-08-22）版本起，不再返回 sessionKey 和 accessToken 取而代之的是返回 encryptedKey（加密后的数据，云函数解密后可获得 sessionKey）
不要将 sessionKey 和 accessToken 暴露给前端，否则会有安全隐患
/**
* 用户登录(微信授权)
* @description 用户登录(微信授权)
* data 请求参数 说明
* @param {String} type 可传login或register，若为login：则不存在不会自动注册，若为register，则用户存在会报错，不传，则存在自动登录，不存在，则注册。
* res 返回参数说明
* @param {String} token 登录成功之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginByWeixin({
data: {
type: ""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
云函数端解密 encryptedKey
// 解密 sessionKey 示例
let decryptedRes = vk.crypto.aes.decrypt({
data: encryptedKey, // 待解密的原文
});
let sessionKey = decryptedRes.sessionKey;
1
2
3
4
5
2
3
4
5
# vk.userCenter.code2SessionWeixin（获取微信openid）
注意：自 2.11.0（2022-08-22）版本起，不再返回 sessionKey 和 accessToken 取而代之的是返回 encryptedKey（加密后的数据，云函数解密后可获得 sessionKey）
不要将 sessionKey 和 accessToken 暴露给前端，否则会有安全隐患
/**
* 获取微信openid
* res 返回参数说明
* @param {String} openid 用户openid
* @param {String} unionid 用户unionid，可以取到此值时返回
* @param {String} sessionKey 客户端为微信小程序时返回
* @param {String} accessToken 客户端为APP时返回
* @param {String} expiresIn 客户端为APP时返回，accessToken 接口调用凭证超时时间，单位（秒）
* @param {String} refreshToken 客户端为APP时返回，用于刷新accessToken
* @param {String} encryptedKey 密钥的加密数据
*
*/
vk.userCenter.code2SessionWeixin({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
云函数端解密 encryptedKey
// 解密 sessionKey 示例
let decryptedRes = vk.crypto.aes.decrypt({
data: encryptedKey, // 待解密的原文
});
let sessionKey = decryptedRes.sessionKey;
1
2
3
4
5
2
3
4
5
# vk.userCenter.bindWeixin（绑定微信）
/**
* 绑定微信
*/
vk.userCenter.bindWeixin({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.unbindWeixin（解绑微信）
/**
* 解绑微信
*/
vk.userCenter.unbindWeixin({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.getPhoneNumber（获取微信绑定的手机号）
注意事项：
- 此接口需要
隐私条款中包含获取用户手机号 - 需要已微信认证的企业小程序（含个体户）
<button type="default" open-type="getPhoneNumber" @getphonenumber="getPhoneNumber">获取微信绑定的手机号</button>
1
// 需要先在onLoad内执行此函数
vk.userCenter.code2SessionWeixin({
data: {
needCache: true
},
success: (data) => {
this.encryptedKey = data.encryptedKey;
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
// 获取微信绑定的手机号码
getPhoneNumber(e) {
let { encryptedData, iv } = e.detail;
if (!encryptedData || !iv) {
return false;
}
vk.userCenter.getPhoneNumber({
data: {
encryptedData,
iv,
encryptedKey: this.encryptedKey
},
success: (data) => {
vk.alert("手机号:" + data.phone);
}
});
},
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# vk.userCenter.loginByWeixinPhoneNumber（通过微信小程序绑定的手机号登录）
注意事项：
- 此接口需要
隐私条款中包含获取用户手机号 - 需要已微信认证的企业小程序（含个体户）
<button type="default" open-type="getPhoneNumber" @getphonenumber="loginByWeixinPhoneNumber">使用微信绑定的手机号登录/注册</button>
1
// 需要先在onLoad内执行此函数
vk.userCenter.code2SessionWeixin({
data: {
needCache: true
},
success: (data) => {
this.encryptedKey = data.encryptedKey;
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
// 使用微信绑定的手机号登录/注册
loginByWeixinPhoneNumber(e) {
let { encryptedData, iv } = e.detail;
if (!encryptedData || !iv) {
return false;
}
vk.userCenter.loginByWeixinPhoneNumber({
data: {
encryptedData,
iv,
encryptedKey: this.encryptedKey
},
success: (data) => {
// 成功后的逻辑
}
});
},
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# vk.userCenter.getWeixinMPqrcode（生成微信小程序码）
/**
* 生成微信小程序码
* @param {String} scene 自定义参数最大32个可见字符 只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~
* @param {String} page 必须是已经发布的小程序存在的页面（否则报错），例如 pages/index/index, 根路径前不要填加 /,不能携带参数（参数请放在scene字段里），如果不填写这个字段，默认跳主页面
* @param {boolean} check_path 默认是true，检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用。
* @param {String} env_version 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"。默认是正式版。
* @param {number} width 二维码的宽度，单位 px，最小 280px，最大 1280px
* @param {boolean} auto_color 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false
* @param {Object} line_color auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
* @param {boolean} is_hyaline 是否需要透明底色，为 true 时，生成透明底色的小程序
*/
vk.userCenter.getWeixinMPqrcode({
data: {
page: "pages/index/index",
scene: "a=1&b=2",
check_path: false,
env_version: "release", // 默认值"release"。要打开的小程序版本。正式版为 "release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。
},
success:(data) =>{
console.log("imageUrl", data.base64)
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# vk.userCenter.getWeixinMPscheme（生成微信小程序scheme码）
/**
* 生成微信小程序scheme码
* data 请求参数 说明
* @param {String} path 小程序页面路径
* @param {String} query 小程序页面参数
*/
vk.userCenter.getWeixinMPscheme({
data: {
query: "a=1&b=2",
path: "pages/index/index",
env_version: "release", // 默认值"release"。要打开的小程序版本。正式版为 "release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。
},
success: (data) => {
console.log("url", data.openlink)
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# vk.userCenter.getWeixinMPurl（生成微信小程序url链接）
/**
* 生成微信小程序scheme码
* data 请求参数 说明
* @param {String} path 小程序页面路径
* @param {String} query 小程序页面参数
*/
vk.userCenter.getWeixinMPurl({
data: {
path: "pages/index/index",
query: "a=1&b=2",
env_version: "release", // 默认值"release"。要打开的小程序版本。正式版为 "release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。
},
success:(data) =>{
console.log("url", data.url_link)
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 支付宝
# vk.userCenter.loginByAlipay（支付宝登录）
框架会自动保存 token，无需你再手动去保存。
注意：
- 需要在
common/uni-config-center/uni-id/config.json内支付宝平台下配置appid和privateKey（应用私钥）
注意：自 2.11.0（2022-08-22）版本起，不再返回 sessionKey 和 accessToken 取而代之的是返回 encryptedKey（加密后的数据，云函数解密后可获得 sessionKey）
不要将 sessionKey 和 accessToken 暴露给前端，否则会有安全隐患
/**
* 支付宝登录
* data 请求参数 说明
* @param {String} type 可传login或register，若为login：则不存在不会自动注册，若为register，则用户存在会报错，不传，则存在自动登录，不存在，则注册。
* res 返回参数说明
* @param {String} token 登录成功之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginByAlipay({
data: {
type: ""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
云函数端解密 encryptedKey
// 解密 sessionKey 示例
let decryptedRes = vk.crypto.aes.decrypt({
data: encryptedKey, // 待解密的原文
});
let sessionKey = decryptedRes.sessionKey;
1
2
3
4
5
2
3
4
5
# vk.userCenter.code2SessionAlipay（获取支付宝openid）
注意：自 2.11.0（2022-08-22）版本起，不再返回 sessionKey 和 accessToken 取而代之的是返回 encryptedKey（加密后的数据，云函数解密后可获得 sessionKey）
不要将 sessionKey 和 accessToken 暴露给前端，否则会有安全隐患
/**
* 获取支付宝openid
* res 返回参数说明
* @param {String} openid 用户openid
* @param {String} accessToken 客户端为APP时返回
* @param {String} expiresIn 客户端为APP时返回，accessToken 接口调用凭证超时时间，单位（秒）
* @param {String} refreshToken 客户端为APP时返回，用于刷新accessToken
* @param {String} reExpiresIn refreshToken超时时间，单位（秒）
*/
vk.userCenter.code2SessionAlipay({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
云函数端解密 encryptedKey
// 解密 sessionKey 示例
let decryptedRes = vk.crypto.aes.decrypt({
data: encryptedKey, // 待解密的原文
});
let sessionKey = decryptedRes.sessionKey;
1
2
3
4
5
2
3
4
5
# vk.userCenter.bindAlipay（绑定支付宝）
/**
* 绑定支付宝
*/
vk.userCenter.bindAlipay({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.unbindAlipay（解绑支付宝）
/**
* 解绑支付宝
*/
vk.userCenter.unbindAlipay({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.loginByQQ（QQ登录）
目前仅支持app和小程序的qq登录
框架会自动保存 token，无需你再手动去保存。
注意：
QQ小程序登录配置
- 配置
common/uni-config-center/uni-id/config.json内mp-qq的appid和appsecret - 在
manifest.json内配置QQ小程序的appid
APP登录配置
- 在
manifest.json的APP模块配置QQ登录用appid - 打包并使用自定义基座（注意一定要在
manifest.json填写QQappid后再制作自定义基座）自定义基座使用说明 (opens new window) - 配置
common/uni-config-center/uni-id/config.json内app-plus.oauth.qq的appid和appsecret
/**
* QQ登录
* data 请求参数 说明
* @param {String} type 可传login或register，若为login：则不存在不会自动注册，若为register，则用户存在会报错，不传，则存在自动登录，不存在，则注册。
* res 返回参数说明
* @param {String} token 登录成功之后返回的token信息
* @param {String} tokenExpired token过期时间
*/
vk.userCenter.loginByQQ({
data: {
type: ""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# vk.userCenter.bindQQ（绑定QQ）
/**
* 绑定QQ
*/
vk.userCenter.bindQQ({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# vk.userCenter.unbindQQ（解绑QQ）
/**
* 解绑QQ
*/
vk.userCenter.unbindQQ({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# 裂变分销
# vk.userCenter.setUserInviteCode（设置邀请码）
/**
* 设置用户邀请码(自动生成)
* @description 针对未生成邀请码的用户使用此方法生成邀请码(自动生成)
* res 返回参数说明
* @param {String} myInviteCode 最终设置的邀请码
*/
vk.userCenter.setUserInviteCode({
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# vk.userCenter.acceptInvite（用户接受邀请）
/**
* 用户接受邀请
* @description 此接口用于在注册之后再填写邀请码的场景，多数情况下不会用到此接口而是在注册时填写邀请码
* data 请求参数 说明
* @param {String} inviteCode 邀请人的邀请码
*/
vk.userCenter.acceptInvite({
data: {
inviteCode :""
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# vk.userCenter.getInvitedUser（获取接受邀请的用户列表）
/**
* 获取接受邀请的用户清单
* data 请求参数 说明
* @param {Number} pageIndex 当前页码
* @param {Number} pageSize 每页显示数量
* @param {Array<Object>} sortRule 排序规则
* @param {object} formData 查询条件数据源
* @param {Array<Object>} columns 查询条件规则
*/
vk.userCenter.getInvitedUser({
data: {
pageIndex: 1,
pageSize: 100
},
success: (data) => {
// 成功后的逻辑
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# token介绍
以下仅为介绍 token，实际开发过程中，即使你不了解 token 的实现逻辑，也不影响你开发项目（框架已经处理完 token 的逻辑）。
token是云函数用来识别用户身份的令牌。用户登录成功后，云函数会返回
token给前端，前端会自动将token保存到本地缓存。在客户端，
token的值存在localStorage的uni_id_token键值中，token的过期时间存在uni_id_token_expired键值中。在云函数端，
token存在uni-id-users表的token字段中，云函数端解密token可以获得用户ID和过期时间当你访问需要登录的云函数时，框架会自动检测
token是否有效，有效则放行，无效则拦截，无需手动传递和验证tokenuni-id配置中，tokenExpiresIn参数代表新生成的token有效期，单位为秒uni-id配置中，tokenExpiresThreshold参数代表token在满足条件的情况下会自动续期，前端也会自动更新token到本地缓存。uni-id配置中，tokenMaxLimit参数代表单一用户最大token数量。当该用户token数量达到此值时，会淘汰旧的token，即使未过期也会淘汰。