二维码组件使用说明

SSO二维码功能说明

国双SSO目前已提供的二维码扫码登录功能,使用场景是:

PC端已登录,移动端未登录;在移动端扫描PC端提供的二维码,经授权后移动端可免输入用户名密码登录。

展示二维码

以SSO首页为例,在点击右侧的”扫一扫”后,便出现了可以扫描的二维码。

qrcode_1

扫描二维码

当在移动端扫描二维码后,PC页面会展示以下是否授权的选项。

qrcode_2

在移动端会出现等待授权的页面。

qrcode_3

授权二维码

当在PC端点击授权后,移动端会得知被授权而登录。

当在PC端点击而拒绝授权时,移动端此时因拒绝授权将会跳转到SSO首页。

过期二维码

二维码会在一段时间不使用(不扫描、打开地址)而失效,目前失效时长为180秒。

qrcode_4

在产品中使用二维码登录

SSO二维码登录功能目前已提供在各产品中使用的方法。

引入文件

在Html引入由SSO提供的两个文件:

<link rel="stylesheet" href="https://sso-cas.gridsumdissector.com/gridsum.qrcode/dist/css/gridsum.qrcode.min.css">
<script src="https://sso-cas.gridsumdissector.com/gridsum.qrcode/dist/js/gridsum.qrcode.min.js"></script>

初始化

在引入文件后,初始化组件:

var gQrCode = new GQrCode("some_id");

其中,SSO并不提供”扫一扫”的元素及样式,初始化时的参数some_id可以是dom中的某一元素的Id,也可以是某一dom对象,组件会绑定点击事件到给定的对象,当点击时便展现二维码等元素。

可配置选项

var gQrCode = new GQrCode("some_id", {
    toLocal: false
});

目前组件只提供了一个可配置选项:toLocal表示在移动端登录后是否跳转到当前扫码的页面(即引入组件的地址),默认选项为true。

手动调用

组件提供了下列方法以使使用者可以自定义显示、隐藏等的时机:

var gQrCode = new GQrCode("some_id");
gQrCode.show(callback); // callback 回调函数
gQrCode.hide(callback); // callback 回调函数