Documentazione API
Questa pagina utilizza lo stesso modello di payload del generatore della homepage e invia richieste a https://qrkit.io/api/v1/qr/generate per testare il comportamento end-to-end in un unico posto.
Tipi supportati
Campi per URL
| Campo | Tipo | Obbligatorio |
|---|---|---|
| url | url | sì |
Esempio 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"}'Prova l'API di generazione
Caricamento...
Chiavi JSON di design supportate
L’esempio di design predefinito ora include l’intera struttura dell’oggetto. Usa il riferimento qui sotto per capire quali chiavi annidate puoi sovrascrivere in `design`.
| Campo | Tipo | Esempio | Valori consentiti | Cosa cambia |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | Mostra una cornice CTA attorno al codice. |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | Seleziona il preset della cornice CTA. |
| frame.text | string | "SCAN ME" | - | Etichetta CTA renderizzata all’interno della cornice. |
| frame.fontFamily | string | "Space Grotesk" | - | Famiglia di font usata per il testo CTA. |
| frame.fontSize | number | 34 | - | Controlla la scala del testo CTA. |
| frame.fontWeight | number | 800 | - | Controlla lo spessore del testo CTA. |
| frame.backgroundColor | string | "#0f172a" | - | Colore di riempimento della cornice. |
| frame.textColor | string | "#ffffff" | - | Colore del testo CTA. |
| frame.qrPadding | number | 24 | - | Spazio tra il corpo QR e la cornice circostante. |
| frame.paddingX | number | 16 | - | Padding orizzontale dentro la cornice CTA. |
| frame.paddingY | number | 12 | - | Padding verticale dentro la cornice CTA. |
| frame.borderRadius | number | 12 | - | Arrotondamento degli angoli della cornice. |
| Campo | Tipo | Esempio | Valori consentiti | Cosa cambia |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | Definisce la forma dei moduli QR. |
| modules.color | string | "#111827" | - | Colore principale dei moduli. |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | Gradiente opzionale dei moduli. |
| modules.gradient.from | string | "#111827" | - | Colore iniziale del gradiente. |
| modules.gradient.to | string | "#10b981" | - | Colore finale del gradiente. |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | Direzione del gradiente sui moduli QR. |
| background.color | string | "#ffffff" | - | Colore di sfondo dell’area. |
| background.transparent | boolean | false | - | Rende trasparente lo sfondo. |
| Campo | Tipo | Esempio | Valori consentiti | Cosa cambia |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | Forma del finder esterno. |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | Forma del centro del finder. |
| finder.outerColor | string | "#111827" | - | Colore dell’anello esterno del finder. |
| finder.innerColor | string | "#0ea5e9" | - | Colore del centro del finder. |
| finder.borderColor | string | "#111827" | - | Colore di accento del bordo del finder. |
| quietZone.size | number | 24 | - | Spaziatura della quiet zone attorno al QR. |
| quietZone.modules | number | 4 | - | Controllo della spaziatura basato sui moduli. |
| Campo | Tipo | Esempio | Valori consentiti | Cosa cambia |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | Attiva il rendering del logo. |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | Riferisce un asset logo caricato tramite ID. |
| logo.sizePercent | number | 18 | - | Dimensione del logo rispetto al corpo del QR. |
| logo.padding | number | 6 | - | Spazio aggiuntivo attorno al logo. |
| logo.shape | string | "circle" | circle, square | Sceglie la forma della maschera del logo. |
| logo.backgroundColor | string | "#ffffff" | - | Sfondo sotto il logo. |
| logo.removeBackgroundBehindLogo | boolean | true | - | Rimuove i moduli QR dietro il logo. |
| logoDataUrl | string | "data:image/png;base64,..." | - | Data URL inline PNG/JPG/SVG per il rendering diretto del logo. |