跳到正文
生成二维码
面向开发者的集成

REST API 和 Webhook 已经可用

使用带权限范围的 API 密钥，从您的系统创建二维码和短链接。

创建账户查看当前状态
  • 密钥使用 qrw_live_ 前缀
  • 每个密钥每分钟 300 次请求
  • 链接变更 Webhook
curl -X POST https://app.smartqrcodes.io/api/v1/qr-codes \
  -H "Authorization: Bearer qrw_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Autumn menu",
    "type": "URL",
    "content": "https://cafe.example/menu",
    "isDynamic": true,
    "slug": "autumn"
  }'

→ 201 Created
{
  "id": "8b1e27d3-2b57-4b6f-b6c4-a9f6cf79ea31",
  "shortLink": { "slug": "autumn" },
  "isActive": true
}

API 密钥仅拥有所选权限。创建密钥时请保存完整密钥内容。

功能可用性

现在已经能用的部分

/api/v1 使用 qrw_live_… API 密钥、Bearer 身份验证和 scope。每个密钥每分钟最多 300 次请求。

密钥使用 qrw_live_ 前缀

完整密钥仅在创建或轮换时显示一次。请立即保存到安全的存储中；如果密钥丢失，请轮换密钥。

每个密钥每分钟 300 次请求

API 密钥的 scope 决定可访问的资源和操作。每个请求都会单独校验。

链接变更 Webhook

使用带权限范围的 API 密钥，从您的系统创建二维码和短链接。

当前 API 能访问哪些内容

API 密钥的 scope 决定可访问的资源和操作。每个请求都会单独校验。

按 scope 验证

密钥以 Authorization: Bearer qrw_live_… 方式传入，只能访问被授权的资源和操作。

微站与项目

独立的读写 scope 让你只给集成方开必要的权限。

请求隔离

每个请求都会根据 API 密钥及其 scope 单独授权。

密钥的生命周期

密钥可以创建、配置、轮换和吊销；密钥列表里不会再返回完整明文。

文档的边界

路由参考和请求示例在控制台中提供；OpenAPI 文件、官方 SDK 和客户端库尚未发布。

密钥明文只显示一次

轮换会吊销上一把密钥并签发替代密钥，而吊销则直接终止该密钥的后续鉴权。

使用 API 密钥进行 Bearer 身份验证

在 Authorization: Bearer 标头中传入以 qrw_live_… 开头的密钥。Scope 限制可用操作，每个密钥每分钟最多 300 次请求。

  • API 密钥的创建、查看与配置
  • 密钥的轮换与吊销
  • 完整明文只展示一次
  • Authorization: Bearer qrw_live_…
当前 API

Authorization: Bearer qrw_live_YOUR_KEY

完整密钥仅在创建或轮换时显示一次。请立即保存到安全的存储中；如果密钥丢失，请轮换密钥。

API 请求约定

下表列出当前外部 API 的必填参数。

身份验证
要求
API 密钥
当前 API
Bearer qrw_live_…
请求头
要求
Authorization
当前 API
Bearer qrw_live_…
访问控制
要求
API 密钥 scope
当前 API
每个请求都会校验
请求限制
要求
每个 API 密钥
当前 API
每分钟 300 次请求

快速上手

如何接入服务端集成

创建一把权限最小的密钥，保存好那次仅显示一次的明文，并且只在可信环境中传输它。

  1. 1

    创建密钥

    获取用于服务器集成的密钥，设置所需的最小 scope，并将密钥保存在受保护的位置。

  2. 2

    选择 scope

    只保留集成方真正需要的读写权限。

  3. 3

    保存明文密钥

    立刻复制明文：它不会再次显示。一旦丢失，请执行轮换。

  4. 4

    传入请求头

    在受支持的 /api/v1 路由上使用 Authorization: Bearer qrw_live_…。

常见问题

常见问题

API 密钥是什么格式？

密钥以 qrw_live_… 开头。请只在受保护的服务器环境中保存完整密钥，不要将其暴露在客户端代码中。

API 密钥应该怎么传？

请在 Authorization 请求头中以 Bearer 凭据传入密钥，或使用 X-API-Key 请求头。访问权限受密钥 scope 限制。

请求限制是多少？

每个 API 密钥每分钟最多 300 次请求。

Webhook 会发送哪些事件？

创建、更新或删除短链接时会发送 Webhook：link.created、link.updated 和 link.deleted。

为服务端集成创建一把密钥

选择最小的 scope，签发时立刻保存明文，并且只在可信环境中使用它。

创建账户沟通具体场景