1.1.1 • Published 2 years ago
bdfint-auth-sdk v1.1.1
bdfint-auth-sdk
统一账户管理(Unified Account Manager) Javascript SDK
域名:base-sso.stable-test.bdfint.cn
安装和引入方式
使用 npm 或者 yarn 安装
$ npm install bdfint-auth-sdk
$ yarn add bdfint-auth-sdk
const AuthSdk = require("bdfint-auth-sdk").default; // ES5
import AuthSdk from "bdfint-auth-sdk"; // ES6
使用方法
step1: 组件加载完毕时调用inituseEffect,或者 componentDidMounted 中调用
AuthSdk.init({
clientKey: "客户端ID", // 必填
redirect_uri: "登录成功后跳转的地址", // 必填
baseUrl:"登录页面地址"//必填 //http://base-sso.stable-test.bdfint.cn/login
display: 'POP' //设置为POP时为弹窗登录,不设置display时默认为打开新页面登录
});
step2: 根据业务场景手动调用登录函数(根据登录模式传递不同的 display 参数)
例子 1: 弹出遮罩层登录(弹出一个带遮罩的 iframe)login
AuthSdk.init({
baseUrl:"登录页面地址"//必填 //http://base-sso.stable-test.bdfint.cn/login
client_id: "客户端ID", // 必填
display: 'POP', // 必填
redirect_uri: "登录成功后跳转的地址", // 必填
});
AuthSdk.login()
例子 2: 跳转到登录页登录login
AuthSdk.init({
baseUrl:"登录页面地址"//必填 //http://base-sso.stable-test.bdfint.cn/login
client_id: "客户端ID", // 必填
redirect_uri: "登录成功后跳转的地址", // 必填
});
AuthSdk.login();
step3: 获取用户信息
AuthSdk.getCurrentUser(); //返回一个Promise
step4: 退出
AuthSdk.logout(); //返回一个Promise
方法列表
name | 说明 | 返回值 |
---|---|---|
init | 初始化配置 | |
login | 登录 | |
getCurrentUser | 获取登录用户的信息,返回 promise | promise |
logout | 退出登录 | |
register | 跳转到注册页,baseUrl | |
toUserInfo | 跳转到个人中心页面 |
init
// @param option {object} 初始化配置参数
AuthSdk.init = function(options){ ... }
// opition详细配置:
options = {
display: '登录模式(POP/其他)设置为POP则为弹窗登录,不设置或设置为其他值则跳转到登录页面登录',
clientKey: '你的客户端ID',
redirectUrl: '登录成功后的回调地址',
baseUrl: '你要使用的登录/注册地址',
}
init 方法参数对象说明
key | 说明 | 类型 | 默认值 |
---|---|---|---|
display | 以哪种方式进行登录 | ||
clientKey | 调用 uamsdk 的业务平台 ID | string | |
redirectUrl | 你的 callback.html 访问地址 | string | |
baseUrl | 自定义登录页地址 | string | http://base-sso.stable-test.bdfint.cn/login |
1.1.1
2 years ago
1.1.0
2 years ago
1.0.17
2 years ago
1.0.16
2 years ago
1.0.15
2 years ago
1.0.14
2 years ago
1.0.13
2 years ago
1.0.12
2 years ago
1.0.11
2 years ago
1.0.10
2 years ago
1.0.9
2 years ago
1.0.8
2 years ago
1.0.7
2 years ago
1.0.6
2 years ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago