uamsdk
统一账户管理(Unified Account Manager) Javascript SDK
域名:sso.bdfint.com
安装和引入方式
直接引用文件(推荐)
在你的项目的 html 文件中引入
使用 npm 安装
$ npm install uamsdk
; // ES5; // ES6
使用方法
step1: 拷贝 example/callback.html 到您的 web 服务器中并确保可访问
init
step2: 文档加载完毕时调用uamsdk;
login / createLoginIframe,参考下面四种登录模式的例子)
step3: 根据业务场景手动调用登录函数(根据登录模式传递不同的display参数或者调用不同的函数login
例子1: 弹窗登录(弹出一个固定大小的window窗口)uamsdk;uamsdk;
login
例子2: 弹出遮罩层登录(弹出一个带遮罩的iframe)uamsdk;uamsdk;
createLoginIframe
例子3: 自定义嵌入登录页(用户提供容器来容纳登录部分)uamsdk;uamsdk
login
例子4: 跳转到登录页登录uamsdk;uamsdk
step4: 退出
uamsdk// 或者是uamsdk
方法列表
display已修改为默认iframe模式 登录 // 嵌入登录页的iframe,并加入自定义样式 // 获取登录用户的信息,返回promise 退出登录 是否已登录 true | false 是否正在登陆 true | false 获取token String 关闭登录弹层option参数解释: 不传option默认值是action: 'destroy' action为'destroy'时删除弹层元素,否则隐藏弹层元素如果弹层是window窗口,则无视option参数 调用接口 使用 get 方式调用接口 使用 post 方式调用接口
init
// @param option {object} 初始化配置参数uamsdk{ ... }// opition详细配置:option = display: '登录模式(uamsdk.POPUP/uamsdk.IFRAME/uamsdk.REDIRECT)' client_id: '你的客户端ID' redirect_uri: '你的callback.html访问地址' loginUrl: '你要使用的登录地址,没有则不填由sdk提供默认' logoutUrl: '你要使用的登出地址,没有则不填由sdk提供默认'
login
// @param callbackOrRedirectUrl 登录成功后回调函数或者是重定向地址// @param keepSession {boolean} 是否保持会话(重新打开浏览器是否保持登录状态),不传则默认为true,即重新打开浏览器依然保持登录uamsdk{ ... }
createLoginIframe
// 创建登录的iframe// @param wrapperId {string} iframe容器的ID// @param styleObj {object} 用户自定义iframe样式// @param callback {function} 登录成功后回调函数// @param keepSession {boolean} 是否保持会话(重新打开浏览器是否保持登录状态),不传则默认为true,即重新打开浏览器依然保持登录uamsdk{ ... }
logout
// @param callbackOrRedirectUrl 可以是回调函数或者是合法的跳转链接uamsdk{ ... }
display参数可取值说明:
- 'popup': 弹窗模式,弹出新的window窗口
- 'redirect': 跳转模式,当前窗口跳转到登录页
- 'iframe': 弹出类似于模态框的iframe,不打开新的window窗口,默认居中显示
- 'customIframe': 自定义嵌入的iframe, 可调整sdk嵌入的iframe样式,需要提供容器给iframe,使用uamsdk.createLoginIframe方法