# 开放登录平台


重要提示:所有请求建议使用https协议,当https协议无法使用时再尝试使用http协议

# 1、如何判断用户是否登录?

在需要用户登录的业务场景,我们需要先判断是否有上次登录获取的用户信息(uid、usrname等),如果不存在用户信息(或已失效),就需要引导用户前往登录.

# 2、如何让用户登录?

当您展示“登录入口”引导用户进行登录后,用户点击“入口”,您通过Url跳转“《开放登录平台》”即可

注意:跳转“《开放登录平台》”的Url配置如下:

// 跳转开放登录平台的url 
// 注意 u参数必须进行encodeURIComponent()编码处理,并且跳转域名需要申请加入白名单否则无法携带用户信息
http(s)://luckycola.com.cn/public/dist/#/allLoginPage?u=encodeURIComponent(登录成功后的回跳地址)

1
2
3
4

参数说明:

序号 参数 是否必须 说明
1 u 登录后跳转的回调地址,登录成功后会在这个url上拼接有用户参数(这个url请encodeURIComponent)处理

# 举个例子:

如果我我的网站地址是“http://test.com”,我需要引导用户进行登录,就直接跳转下面这个“登录开放平台”的地址即可(注意:u是经过encodeURIComponent处理的)

https://luckycola.com.cn/public/dist/#/allLoginPage?u=http%3A%2F%2Ftest.com
1

跳转成功至“《开放登录平台》”后用户就可以自行选择登录的方式或者注册

# 3、登录成功后如何拿到用户数据?

当用户在“《开放登录平台》 (opens new window)”完成登录后,平台将会自动跳转回您的回调地址(u参数),并且在您的回调地址上拼接上“登录状态”、“用户名”等

参数,具体参数如下

序号 参数 说明
1 isLoginOk 用户登录是否成功,值是1或者0(1表示成功,0表示失败)
2 uid 登录用户的唯一id,您可以自己存储这个id处理更多的业务场景
3 usrname 登录用户的用户名
4 userInfoUrl 查看登录用户更多信息的url地址

举个例子: 如果我通过下面这个url跳转《登录开放平台》 (opens new window)

https://luckycola.com.cn/public/dist/#/allLoginPage?u=http%3A%2F%2Ftest.com
1

并且用户登录成功了,那么跳回您的回调地址是这样的:

http://test.com?isLoginOk=1&uid=(用户唯一标识)&usrname=(用户名称)&userInfoUrl=(经过encodeURIComponent后的查看用户信息的地址)
1

所以在您的网站或者应用通过获取url上的这些参数即可,您获取到这些用户信息就需要自行[缓存]这些[用户信息],来维护这个用户的[登录态].

# 4、如何维护用户的登录态?

当用户登录成功后,您就可以在跳转回来的Url上获取到用户的(uid、usrname等)相关信息,您需要自行维护登录态,您可以在本地缓存住这些用户信息(有用户信息代表用户已经登录了),您也可以设置登录态的过期时间(比如您可以用户信息设置有效期3天,过期后清除,那么用户就需要重新登录来获取用户信息了).

# 二、注意点

1、处于安全性考虑,如果您需要接入《开放登录平台》 (opens new window),请您登录LuckCola官网 (opens new window)后进入[个人中心]点击[开放登录平台域名申请]进行申请,申请结果平台将以邮件形式回复即可接入使用啦~


重要的事情说三遍

  • u参数跳转地址的域名需要申请加入白名单否则无法携带用户信息
  • u参数跳转地址的域名需要申请加入白名单否则无法携带用户信息
  • u参数跳转地址的域名需要申请加入白名单否则无法携带用户信息 [个人中心]----[开放登录平台域名申请]----进行申请 在这里插入图片描述
Last Updated: 12/13/2023, 1:18:54 PM