¶ APP 扫码登录完整接口列表
更新时间: 2024-10-10 07:28:40
Authing 提供基于 REST 的扫码登录接口,开发者可以直接调用。
¶ 生成二维码
POST
https://core.authing.cn/api/v2/qrcode/gene
该接口会返回二维码 ID (random) 和二维码链接。
生成的二维码示例:
使用在线二维码解码工具 (opens new window) 查看二维码数据如下:
{
"scene": "APP_AUTH",
"random": "SzZrszCJNCFfVBDUCKLDtAYNBR96SK",
"userPoolId": "5fae2648201cfd526f0ec354",
"createdAt": "2020-11-13T06:23:25.396Z",
"expiresIn": 120,
"customData": {}
}
¶ 查询二维码状态
GET
https://core.authing.cn/api/v2/qrcode/check
请求结果字段说明:
- status
- 0: 未扫码。
- 1: 已经扫码但用户还没有点击同意授权或者取消授权,此时会返回用户的头像和昵称,但不包含其他机密信息,可用于前端头像展示。
- 2: 用户同意授权
- 3: 用户取消授权
- -1: 过期
- userInfo:
- 默认情况下,在用户扫码之后,会包含昵称(nickname)和头像(photo)两个字段
- 开发者也可以配置返回完整用户信息(包括登录凭证 token)
- ticket:用于换取完整用户资料。**此字段只有在用户同意授权之后才会出现。**详情见下文。
¶ 使用 ticket 换取用户信息
POST
https://core.authing.cn/api/v2/qrcode/userinfo
注意:默认情况下,此接口只允许在服务器端调用,即需要使用用户池密钥初始化之后。
ticket 默认有效时间为 300 s。
开发者可在 Authing 控制台 (opens new window) 基础配置 -> 基础设置 -> App 扫码登录 Web 自定义配置 处修改。详情见自定义配置项页。
¶ APP 端标记已扫码
POST
https://core.authing.cn/api/v2/qrcode/scanned
APP 端标记已扫码,标记扫码之后 Web 端将可以获取到当前用户的昵称和头像。
APP 端需要满足两个条件:
- 用户必须处于登录态
- 用户的用户池 ID 和二维码用户池 ID 匹配。
¶ APP 端同意授权
POST
https://core.authing.cn/api/v2/qrcode/confirm
APP 端同意授权,调用此接口前需要先调用 scanned 接口。
APP 端需要满足两个条件:
- 用户必须处于登录态
- 用户的用户池 ID 和二维码用户池 ID 匹配。
¶ APP 端取消授权
POST
https://core.authing.cn/api/v2/qrcode/cancel
APP 端取消授权,调用此接口前需要先调用 scanned 接口。
APP 端需要满足两个条件:
- 用户必须处于登录态
- 用户的用户池 ID 和二维码用户池 ID 匹配。