API 文档
此页面使用与主页生成器相同的负载模型，并向 https://qrkit.io/api/v1/qr/generate 发送请求，以便您可以在一个地方测试端到端行为。
支持的类型
URL 的字段
| 字段 | 类型 | 必填 |
|---|---|---|
| url | url | 是 |
cURL 示例
curl -X POST https://qrkit.io/api/v1/qr/generate \
-H "Content-Type: application/json" \
-d '{"type":"url","payload":{"url":"https://www.example.com"},"design":{"frame":{"enabled":false,"type":"none","text":"","fontFamily":"sans-serif","fontSize":34,"fontWeight":700,"textColor":"#ffffff","backgroundColor":"#000000","qrPadding":24,"paddingX":16,"paddingY":10,"borderRadius":12},"modules":{"shape":"square","color":"#000000","gradient":null},"background":{"color":"#ffffff","transparent":false},"finder":{"style":"square","centerStyle":"square","outerColor":"#000000","innerColor":"#000000","borderColor":"#000000"},"logo":{"enabled":false,"assetId":null,"sizePercent":20,"padding":0,"backgroundColor":"#ffffff","shape":"square","removeBackgroundBehindLogo":true},"quietZone":{"modules":2,"size":16}},"format":"svg","size":512,"errorCorrection":"M"}'尝试生成 API
加载中...
支持的设计 JSON 字段
默认设计示例包括完整的对象形状。使用下面的参考来了解您可以在“设计”中覆盖哪些嵌套键。
| 字段 | 类型 | 示例 | 允许值 | 改变了什么 |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | 在代码周围显示 CTA 框架。 |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | 选择 CTA 框架预设。 |
| frame.text | string | "SCAN ME" | - | 框架内渲染的 CTA 标签。 |
| frame.fontFamily | string | "Space Grotesk" | - | 用于 CTA 文本的字体系列。 |
| frame.fontSize | number | 34 | - | 控制 CTA 文本比例。 |
| frame.fontWeight | number | 800 | - | 控制 CTA 文本粗细。 |
| frame.backgroundColor | string | "#0f172a" | - | 框架填充颜色。 |
| frame.textColor | string | "#ffffff" | - | CTA 文本颜色。 |
| frame.qrPadding | number | 24 | - | QR 主体与周围框架之间的间距。 |
| frame.paddingX | number | 16 | - | CTA 框架内的水平填充。 |
| frame.paddingY | number | 12 | - | CTA 框架内的垂直填充。 |
| frame.borderRadius | number | 12 | - | 框架的角倒圆。 |
| 字段 | 类型 | 示例 | 允许值 | 改变了什么 |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | 设置 QR 模块形状。 |
| modules.color | string | "#111827" | - | 主要模块颜色。 |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | 可选模块渐变。 |
| modules.gradient.from | string | "#111827" | - | 渐变起始颜色。 |
| modules.gradient.to | string | "#10b981" | - | 渐变结束颜色。 |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | QR 模块的梯度流向。 |
| background.color | string | "#ffffff" | - | 画布背景颜色。 |
| background.transparent | boolean | false | - | 使背景透明。 |
| 字段 | 类型 | 示例 | 允许值 | 改变了什么 |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | 外侧定位图案形状。 |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | 中心定位图案形状。 |
| finder.outerColor | string | "#111827" | - | 定位图案外圈颜色。 |
| finder.innerColor | string | "#0ea5e9" | - | 定位图案中心颜色。 |
| finder.borderColor | string | "#111827" | - | 定位图案边框颜色。 |
| quietZone.size | number | 24 | - | 二维码周围的留白区大小。 |
| quietZone.modules | number | 4 | - | 基于模块的间距控制。 |
| 字段 | 类型 | 示例 | 允许值 | 改变了什么 |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | 打开徽标渲染。 |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | 通过 ID 引用上传的徽标资源。 |
| logo.sizePercent | number | 18 | - | 相对于 QR 正文的徽标尺寸。 |
| logo.padding | number | 6 | - | 徽标周围有额外的空间。 |
| logo.shape | string | "circle" | circle, square | 选择徽标蒙版形状。 |
| logo.backgroundColor | string | "#ffffff" | - | 标志下的背景。 |
| logo.removeBackgroundBehindLogo | boolean | true | - | 删除徽标后面的 QR 模块。 |
| logoDataUrl | string | "data:image/png;base64,..." | - | 内联 PNG/JPG/SVG 数据 URL 用于直接徽标渲染。 |