API-Dokumentation
Diese Seite verwendet dasselbe Payload-Modell wie der Homepage-Generator und sendet Anfragen an https://qrkit.io/api/v1/qr/generate, damit du das End-to-End-Verhalten an einem Ort testen kannst.
Unterstützte Typen
Felder für URL
| Feld | Typ | Erforderlich |
|---|---|---|
| url | url | ja |
cURL-Beispiel
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"}'Generate-API ausprobieren
Wird geladen...
Unterstützte Design-JSON-Schlüssel
Das Standard-Designbeispiel enthält jetzt die vollständige Objektstruktur. In der Referenz unten siehst du, welche verschachtelten Schlüssel du in `design` überschreiben kannst.
| Feld | Typ | Beispiel | Erlaubte Werte | Wirkung |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | Zeigt einen CTA-Rahmen um den Code an. |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | Wählt das CTA-Rahmen-Preset aus. |
| frame.text | string | "SCAN ME" | - | CTA-Beschriftung, die im Rahmen gerendert wird. |
| frame.fontFamily | string | "Space Grotesk" | - | Schriftfamilie des CTA-Texts. |
| frame.fontSize | number | 34 | - | Steuert die Größe des CTA-Texts. |
| frame.fontWeight | number | 800 | - | Steuert die Schriftstärke des CTA-Texts. |
| frame.backgroundColor | string | "#0f172a" | - | Füllfarbe des Rahmens. |
| frame.textColor | string | "#ffffff" | - | Textfarbe des CTA. |
| frame.qrPadding | number | 24 | - | Abstand zwischen QR-Körper und umgebendem Rahmen. |
| frame.paddingX | number | 16 | - | Horizontaler Innenabstand im CTA-Rahmen. |
| frame.paddingY | number | 12 | - | Vertikaler Innenabstand im CTA-Rahmen. |
| frame.borderRadius | number | 12 | - | Abrundung der Rahmenecken. |
| Feld | Typ | Beispiel | Erlaubte Werte | Wirkung |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | Legt die Form der QR-Module fest. |
| modules.color | string | "#111827" | - | Primäre Modulfarbe. |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | Optionaler Farbverlauf für die Module. |
| modules.gradient.from | string | "#111827" | - | Startfarbe des Farbverlaufs. |
| modules.gradient.to | string | "#10b981" | - | Endfarbe des Farbverlaufs. |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | Richtung des Farbverlaufs über die QR-Module. |
| background.color | string | "#ffffff" | - | Hintergrundfarbe der Fläche. |
| background.transparent | boolean | false | - | Macht den Hintergrund transparent. |
| Feld | Typ | Beispiel | Erlaubte Werte | Wirkung |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | Form des äußeren Finders. |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | Form des inneren Finder-Zentrums. |
| finder.outerColor | string | "#111827" | - | Farbe des äußeren Finder-Rings. |
| finder.innerColor | string | "#0ea5e9" | - | Farbe des Finder-Zentrums. |
| finder.borderColor | string | "#111827" | - | Akzentfarbe des Finder-Rands. |
| quietZone.size | number | 24 | - | Abstand der Ruhezone um den QR-Code. |
| quietZone.modules | number | 4 | - | Abstandssteuerung auf Modulbasis. |
| Feld | Typ | Beispiel | Erlaubte Werte | Wirkung |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | Aktiviert das Rendern des Logos. |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | Referenziert ein hochgeladenes Logo-Asset per ID. |
| logo.sizePercent | number | 18 | - | Logogröße relativ zum QR-Körper. |
| logo.padding | number | 6 | - | Zusätzlicher Abstand um das Logo. |
| logo.shape | string | "circle" | circle, square | Wählt die Maskenform des Logos. |
| logo.backgroundColor | string | "#ffffff" | - | Hintergrund unter dem Logo. |
| logo.removeBackgroundBehindLogo | boolean | true | - | Entfernt QR-Module hinter dem Logo. |
| logoDataUrl | string | "data:image/png;base64,..." | - | Inline-PNG/JPG/SVG-Data-URL für direktes Logo-Rendering. |