二维码登录设计

登录流程

获取二维码->app扫描二维码->点击确认登录->登录成功

接口说明:

1. 获取二维码code图片(PC调用)

获取二维码code图片

  • 参数

           qrSize 二维码大小 最大512 默认 94
           logoSize logo大小 最大256 默认32
           logo  logo编号 如需定制请联系开发者
    
  • 返回:image数据流

  • 异常:errorCode:-1 系统异常

  • 使用场景:页面加载二维码时,调用此接口获取二维码图片。

  • 示例:<img src="https://xxx.xxx.com/qr/loginpic/?qrSize=513&logo=2"></img>

2.获取二维码code(PC调用)

获取二维码code

  • 参数:无

  • 返回:code 二维码内容加密信息

  • 异常:errorCode:-1 系统异常

  • 使用场景:页面加载二维码时,调用此接口获取二维码内容,并将code转换成二维码图片展示到页面。

3.请求登录****(PC调用)

请求登录接口

  • 参数:*无

  • 返回

           statusflag:0 此时二维码处于待扫描状态
           statusflag:1 此时二维码处于已扫描状态
           statusflag:2 登录成功;url:跳转页面
           statusflag:-2 二维码失效
           statusflag:-1 错误 (包括运行时异常和鉴权)
    
  • 异常:errorCode:-1 系统异常

  • 使用场景:页面加载二维码后,轮询调用此接口,查询二维码此时状态,根据不同状态进行不同的页面展现和处理。建议2~3秒调用一次,不允许间隔时间太短,防止被封杀

  • 页面处理

                  statusflag:0 继续轮询登录接口
                  statusflag:1 遮盖二维码;提示用户“二维码已被扫描,请在app点击确认登录”;继续轮询登录接口
                  statusflag:2 停止轮询登录接口;跳转到接口返回的url;增加扩展字段ext,内容为app端在lockcode时埋入的内容
                  statusflag:-2 遮盖二维码;提示用户“二维码已失效,请重新获取”;停止轮询登录接口
                  statusflag:-1 建议与二维码失效同样处理
    

4. app激活二维码****(APP调用)

app锁定二维码接口

  • 参数:String code 从二维码图片中扫面出的信息;String ext 扩展字段(可空)

  • 返回

           statusflag:0 成功 ;type:二维码类型
           statusflag:-2 二维码失效
           statusflag:-1 错误 (包括运行时异常和鉴权)
    
  • 异常:*errorCode:-1 系统异常

  • 使用场景:app扫描二维码后,从二维码中获取code值,调用此接口,使二维码绑定app。

5. app激活二维码****(APP调用)

app激活二维码接口

  • 参数:String code 从二维码图片中扫面出的信息

  • 返回

           statusflag:0 成功
           statusflag:-2 二维码失效
           statusflag:-1 错误 (包括运行时异常和鉴权)
    
  • 异常:errorCode:-1 系统异常

  • 使用场景:app锁定二维码成功后,用户点击确认后,调用此接口,允许pc登录成功。

6.app取消操作****(APP调用)

app取消操作

  • 参数:String code 从二维码图片中扫面出的信息

  • 返回

           statusflag:0 成功
           statusflag:-2 二维码失效
           statusflag:-1 错误 (包括运行时异常和鉴权)
    
  • 异常:*errorCode:-1 系统异常

  • 使用场景:app锁定二维码成功后,用户点击取消后,调用此接口,使二维码过期。

image.png
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容