文档

JustQRs 公开 API

以编程方式管理您的二维码。在控制台的API 密钥页面创建 API 密钥(仅限账户所有者)。

基础 URL

https://api.justqrs.com

身份验证

在每个请求中以 Bearer 令牌的形式发送您的 API 密钥:

Authorization: Bearer jqr_xxxxxxxxxxxxxxxx

密钥仅在创建时完整显示一次。要轮换密钥,请创建新密钥并删除旧密钥。

接口

方法路径说明
GET
/v1/qrcodes
列出您的二维码。
Response: { qrcodes: QrResponse[] }
POST
/v1/qrcodes
创建一个二维码。
Request: CreateQrRequest { name, mode, content, design? } · Response: QrResponse
GET
/v1/qrcodes/{qrId}
获取单个二维码。
Response: QrResponse
PATCH
/v1/qrcodes/{qrId}
更新二维码(仅限动态二维码)。
Request: UpdateQrRequest { name?, content?, design? } · Response: QrResponse
DELETE
/v1/qrcodes/{qrId}
删除二维码。
Response: 204 No Content
GET
/v1/qrcodes/{qrId}/stats?days=7|30|90
获取动态二维码的扫描分析数据。
Response: QrStats { totalScans, rangeScans, rangeUniques, series, breakdowns }

示例:创建一个 URL 二维码

curl -X POST "https://api.justqrs.com/v1/qrcodes" \ -H "Authorization: Bearer jqr_xxxxxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "name": "My link", "mode": "dynamic", "content": { "kind": "url", "url": "https://example.com" } }'

示例:获取扫描统计

curl "https://api.justqrs.com/v1/qrcodes/{qrId}/stats?days=30" \ -H "Authorization: Bearer jqr_xxxxxxxxxxxxxxxx"

错误

错误响应为 JSON 格式:{ "error": string, "code"?: string }。

状态码错误代码含义
400(validation)请求体未通过验证,详情请参阅错误信息。
401—缺少 Authorization 请求头。
403—API 密钥被拒绝:无效、已撤销或已过期。
402upgrade_required您的账户为免费套餐,使用 API 需要付费套餐。
404—该二维码不存在或不属于此账户。
409qr_limit_reached账户已达到动态二维码上限(基础套餐 500 个,可通过附加包增加)。