𝐗𝐀𝐈 𝐗𝐀𝐏𝐈

X-QRCODE 二维码生成服务

产品简介

X-QRCODE 为产品推广、线下活动、文档分发提供高性能二维码生成与管理能力，支持自定义尺寸、容错等级、有效期及批量查询。

快速体验

  1. 准备 sk- 前缀的 XAPI 私钥。
  2. 调用 POST /x-qrcode，传入目标 URL、尺寸、有效天数等参数，即可获得 Base64 图片数据。
  3. 通过 GET /x-qrcode 列出账户下的二维码，或使用 GET /x-qrcode/{id} 查看单个详情。
  4. 当活动结束时使用 DELETE /x-qrcode/{id} 及时清理。

核心能力

  • 即时生成：毫秒级生成 PNG，支持尺寸 128-1024px。
  • 长效管理：可设置最长 10 年有效期，自动过期清理。
  • 容错可控：支持 L/M/Q/H 容错等级，以平衡图像复杂度与识别率。
  • 批量维护：列表接口支持分页与过滤，便于统一管理库存二维码。

API 参考

方法路径说明
POST/x-qrcode创建二维码，参数包含 url、title、size、days、level
GET/x-qrcode列出当前账户所有二维码（支持分页参数）
GET/x-qrcode/{id}查看单个二维码详情及 Base64 图片
DELETE/x-qrcode/{id}删除二维码

示例：生成推广二维码

export XAPI_KEY="你的XAPI-KEY" # sk- 开头的密钥

curl -X POST https://api.xabcstack.com/x-qrcode \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $XAPI_KEY" \
  -d '{
      "url": "https://yoursite.com/promo",
      "title": "限时活动",
      "size": 512,
      "days": 30,
      "level": "M"
    }'

响应中的 qrcode.image_data 即可直接嵌入 <img> 标签或生成打印文件。

常见问题

  • 支持哪些格式？ 目前输出 PNG，并以 Base64 编码返回。
  • 可以自定义 LOGO？ 当前版本未内置 LOGO 叠加，可在客户端使用图像库合成。
  • 如何维护有效期？ 通过 days 参数设置，过期后服务会自动从存储清理。