Authing 文档文档
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
元数据
应用集成
身份自动化
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
元数据
应用集成
身份自动化
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
旧版
开发集成
  • JavaScript SDK 索引
  • 单点登录(SSO)
  • 登录组件 (Guard)

  • 多因素认证组件(MFA)

  • JavaScript / Node.js

  • Java / Kotlin

  • Python

  • C#

  • PHP

  • Go

  • Ruby
  • Delphi
  • Android

    • 快速开始
    • 托管页
    • 超组件

    • APIs

      • 核心认证 API
      • 标准协议 API
      • 多因素认证 API
      • 扫码认证 API
      • 设备管理 API
      • 事件订阅 API
    • 第三方身份源

    • 典型场景

    • 私有化部署
    • Android Guard 更新日志
    • 合规使用指南
    • 返回码对照表
  • iOS

  • Flutter

  • 微信小程序
  • 微信网页授权
  • React Native
  • 框架集成

  • Radius
  • 错误代码

¶ 扫码认证 API

更新时间: 2025-05-14 08:32:28
编辑

要使用自建 App 扫码登录能力,请在 Authing 控制台勾选 "App 扫码登录" 选项。

当 Web 应用需要登录时,登录界面会显示一个可供 App 扫码的二维码,如下图:

二维码数据结构如下:

{
    "scene": "APP_AUTH",
    "random": "5e05f0c57fde537d950f7da5",
    "userPoolId": "5e04ae0d5f3cee22fb37612b",
    "createdAt": "2019-12-27T11:53:41.260Z",
    "expireAt": "2019-12-27T11:55:41.260Z"
}

在 App 侧,确保 App 处于登录状态,在需要授权登录时,依次调用下面 API

¶ 标记二维码

此接口调用成功后,网页的二维码上面会显示用户头像

注意:调用此接口前,App 必须处于登录状态

public static void markQRCodeScanned(String ticket, @NotNull AuthCallback<JSONObject> callback)

参数

  • ticket 二维码数据里面的 random 字段

示例

AuthClient.markQRCodeScanned(random, (code, message, data) -> {
    if (code == 200) {
        // notify user to authorize
    }
});

错误码

  • 500 无效二维码
  • 2020 未登录

¶ 确认二维码登录

使用二维码登录。分两步的好处是,App 可以在扫描之后给用户一个提示,待用户确认之后再授权登录。

注意:调用此接口之前必须先调用 标记二维码

public static void loginByScannedTicket(String ticket, @NotNull AuthCallback<JSONObject> callback)

参数

  • ticket 二维码数据里面的 random 字段

示例

AuthClient.loginByScannedTicket(random, (code, message, data) -> {
    if (code == 200) {
        // logged in
    }
});

错误码

  • 500 无效二维码
  • 2020 未登录

¶ 取消二维码登录

App 可以在扫描之后,若想取消授权登录,调用此接口。

public static void cancelByScannedTicket(String ticket, @NotNull AuthCallback<JSONObject> callback)

参数

  • ticket 二维码数据里面的 random 字段

示例

AuthClient.cancelByScannedTicket(random, (code, message, data) -> {
    if (code == 200) {
        // Success to cancel
    }
});

错误码

  • 500 无效二维码
  • 2020 未登录

上一篇: 多因素认证 API 下一篇: 设备管理 API
  • 标记二维码
  • 确认二维码登录
  • 取消二维码登录

用户身份管理

集成第三方登录
手机号闪验 (opens new window)
通用登录表单组件
自定义认证流程

企业内部管理

单点登录
多因素认证
权限管理

开发者

开发文档
框架集成
博客 (opens new window)
GitHub (opens new window)
社区用户中心 (opens new window)

公司

400 888 2106
sales@authing.cn
北京市朝阳区北辰世纪中心 B 座 16 层(总)
成都市高新区天府五街 200 号 1 号楼 B 区 4 楼 406 室(分)

京ICP备19051205号

beian京公网安备 11010802035968号

© 北京蒸汽记忆科技有限公司