插件支持的接口
通过以下方式引入接口进行使用:
const { changePassWord, loginOut, unbindWechat, isMultiRole } = require('@tencent/miniapp-epaas-sdk/api')
接口列表:
1、changePassWord: 修改密码
请求参数 |
类型 |
描述 |
username |
String |
用户账号 |
old_pw |
String |
旧密码 |
new_pw |
String |
新密码 |
返回参数 |
类型 |
描述 |
success |
Boolean |
true: 修改成功; false: 修改失败 |
const username = 'user';
const old_pw = 'old_pw';
const new_pw = 'new_pw';
const success = await changePassWord(username, old_pw, new_pw);
if (success) {
console.log('success');
} else {
console.log('fail');
}
2、loginOut: 退出登录
返回参数 |
类型 |
描述 |
code |
Number |
参考下方code表 |
msg |
String |
响应消息描述 |
requestid |
String |
请求id |
code取值及描述列表
code |
描述 |
0 |
退出登录成功 |
3 |
服务异常 |
12 |
login-token已过期,请重新登录 |
49 |
没有权限跳转目标应用 |
const resp = await loginOut();
console.log(resp);
3、unbindWechat: 解绑微信
注意:解绑微信成功会同时清楚当前登录态cookie
返回参数 |
类型 |
描述 |
code |
Number |
参考下方code表 |
msg |
String |
响应消息描述 |
requestid |
String |
请求id |
code取值及描述列表
code |
描述 |
0 |
解绑微信成功 |
3 |
服务异常 |
12 |
login-token已过期,请重新登录 |
49 |
没有权限跳转目标应用 |
const resp = await unbind();
console.log(resp);
4、subAppLogin: 子应用登录
4.1、子应用教育号应用id登录
请求参数 |
类型 |
描述 |
sub_appid |
String |
子应用教育号应用id(服务商后台应用详情的SuiteId) |
4.2、子应用企业微信应用id登录
请求参数 |
类型 |
描述 |
sub_qywx_suite_id |
String |
子应用企业微信应用id |
4.3、响应参数
成功返回参数 |
类型 |
描述 |
code |
String |
登录授权code |
appid |
String |
教育号应用id(服务商后台应用详情的SuiteId) |
失败返回参数 |
类型 |
描述 |
errorcode |
String |
响应消息描述 |
msg |
String |
响应消息描述 |
requestid |
String |
请求id |
errorcode错误码及描述列表
errorcode |
描述 |
3 |
服务异常 |
12 |
login-token已过期,请重新登录 |
49 |
没有权限跳转目标应用 |
const opts = {
sub_appid: 800178
}
const resp = await subAppLogin(opts);
console.log(resp);
5、isMultiRole: 是否可以多身份登录
返回参数 |
类型 |
描述 |
success |
Boolean |
true: 是; false: 否 |
const success = await isMultiRole();
if (success) {
console.log('success');
} else {
console.log('fail');
}