📡 API 文档

除网页界面外,本工具还提供简单的 HTTP API,方便在自动化脚本、CI 流水线或测试环境中获取 TOTP 验证码。

⚠️ 安全提醒:通过 API 使用时,密钥会包含在请求 URL 中发送到服务器。请只对测试用途的密钥使用 API;生产账号的密钥建议使用首页的本地生成方式,密钥不会离开你的浏览器。

生成验证码

GET /api/2fa/:secret

示例:

GET /api/2fa/67A36O5ATRYFEVUG

返回:

{
  "success": true,
  "code": "123456",
  "key": "67A36O5ATRYFEVUG",
  "timestamp": 1234567890,
  "expiresIn": 25
}

校验验证码

GET /api/2fa/verify/:secret/:token

示例:

GET /api/2fa/verify/67A36O5ATRYFEVUG/123456

返回:

{
  "success": true,
  "valid": true,
  "token": "123456",
  "key": "67A36O5ATRYFEVUG"
}

参数说明

  • secret:Base32 编码的 TOTP 密钥,16~64 位,仅包含 A-Z 与 2-7,空格会被自动忽略。
  • token:待校验的 6 位数字验证码。

错误返回

参数不合法时返回 HTTP 400,格式如下:

{ "success": false, "message": "密钥太短,至少需要16位" }