QF.EDU

Docs
Qr 码应用程序接口

Qr 码应用程序接口

为任何 URL 生成可定制的 QR 代码

通过该应用程序接口，您可以创建具有可定制选项（如尺寸、颜色、纠错级别和包含徽标）的 QR 代码。生成的 QR 代码将以图片形式返回。

应用程序接口端点

Base URL: https://qf.edu.kg/api/v1/scraping/qrcode

HTTP Methods:

  • GET: Generate a QR code image.
  • OPTIONS: Check CORS support.

使用方法

基本申请格式

https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com

认证

  • 所有请求都需要使用 key 参数。您可以从 "控制面板 "的 "设置 "中获取 API 密钥。

查询参数

参数类型需要默认值说明
keyStringYes-您用于身份验证的 API 密钥。从控制面板 → 设置中获取。
urlStringYes-要在 QR 代码中编码的 URL。必须是有效的 URL。
logoStringNoWRDO_QR_LOGO嵌入 QR 代码的自定义徽标的 URL。需要 Dub 上的付费计划。
sizeNumberNo600QR 码的大小（宽度和高度），单位为像素。
levelStringNo"L"纠错级别。选项： "l"、"m"、"q"、"h"。
bgColorStringNo#FFFFFFQR 码的背景颜色，十六进制格式（如 #FFFFFF）。
marginNumberNo2二维码周围的边距大小（像素）。
hideLogoBooleanNofalse是否在二维码中隐藏徽标。需要 Dub 上的付费计划。

误差修正水平（"水平）

  • L: 低（7% 误差修正）
  • M: 中（15% 误差修正）
  • Q: 四分位数（25% 误差修正）
  • H: 高（30% 误差修正）

回应

successes

  • Status Code: 200 OK
  • Content-Type: image/png
  • Body: A PNG image of the generated QR code.
  • Headers:
    • Access-Control-Allow-Origin: *
    • Access-Control-Allow-Methods: GET, OPTIONS

错误

状态代码留言说明
400API key required ...缺少 key 参数。
401Invalid API key...提供的 key 无效。
500Server error服务器出现意外错误。

实例

基本二维码

为 URL 生成默认 QR 码：

https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com

定制尺寸和颜色

创建一个前景为蓝色、背景为黄色的 400x400 QR 码：

https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com&size=400&fgColor=%230066FF&bgColor=%23FFFF00

带定制徽标和高纠错功能

添加自定义徽标并使用高纠错 (H)：

https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com&logo=https://your-logo-url.com/logo.png&level=H

隐藏徽标并添加边距

隐藏徽标，增加页边距：

https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com&hideLogo=true&margin=10

嵌入 HTML

您可以直接在"[img]"标记中使用 API URL 来显示二维码：

<img
  src="https://qf.edu.kg/api/v1/scraping/qrcode?key=your_api_key&url=https://example.com&size=300&fgColor=%230000FF"
  alt="QR Code for example.com"
img>

说明

  • CORS 支持： 应用程序接口支持 CORS，允许跨源请求。
  • 弃用通知： includeMargin 参数已被弃用。请使用 margin 代替。

支持

如有问题或疑问，请发送电子邮件至 admin@mail.qf.edu.kg 或访问我们的帮助中心联系技术支持。

链接到文本 APISvg 图标应用程序接口