Personalizzazione

L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.

Personalizza un QR code con gli oggetti facoltativi styles, frameOptions e logoOptions quando lo crei o lo aggiorni. Tutti i campi sono facoltativi e per tutto ciò che ometti valgono i valori predefiniti. Gli stessi tre oggetti funzionano su QR code, template e creazioni in blocco. Forme, cornici o loghi sconosciuti vengono rifiutati con 422.

Esempio di oggetto di design

{
  "styles": {
    "dotsOptions": { "type": "rounded", "color": "#000000" },
    "backgroundOptions": { "color": "#ffffff" },
    "cornersSquareOptions": { "type": "dot", "color": "#000000" },
    "cornersDotOptions": { "type": "dot", "color": "#000000" }
  },
  "frameOptions": { "id": "card", "text": "Scan me!", "color": "#000000", "textColor": "#ffffff" },
  "logoOptions": { "type": "suggested", "id": "logo-google", "scalePercent": 25 }
}

Invialo insieme al resto del QR code:

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" } },
    "frameOptions": { "id": "card", "text": "Scan me!" },
    "logoOptions": { "type": "suggested", "id": "logo-website-3" }
  }'

Stili

L’oggetto styles imposta le forme e i colori del motivo.

Campo	Valori
`dotsOptions.type`	Forma dei punti del corpo: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded`
`cornersSquareOptions.type`	Forma del quadrato d’angolo (cornice dell’occhio): `square`, `rounded`, `dot`, `classy-rounded`
`cornersDotOptions.type`	Forma del punto d’angolo (pupilla dell’occhio): `square`, `dot`, `dots`, `rounded`, `classy`
`dotsOptions.color`	Colore di primo piano. Predefinito `#000000`.
`backgroundOptions.color`	Colore di sfondo. Predefinito `#ffffff`.
`cornersSquareOptions.color`, `cornersDotOptions.color`	Accettati ma senza effetto: gli angoli usano sempre `dotsOptions.color`.

Colori. Solo valori esadecimali: #RGB o #RRGGBB.
Correzione degli errori. Sempre Q, e non è un parametro di input. Inviare styles.qrOptions restituisce 422.
Design Branded e AI. Non si possono impostare tramite l’API. Inviare styles.logoQrArt restituisce 422.
Contenuto. styles.data viene ignorato. L’immagine codifica sempre il contenuto del QR code.

Mantieni un contrasto sufficiente tra il colore di primo piano e quello di sfondo, con un primo piano scuro su uno sfondo chiaro. I codici a basso contrasto potrebbero non essere letti. Consulta Colori.

Cornici

L’oggetto frameOptions aggiunge attorno al QR code una cornice decorativa con un invito all’azione.

Campo	Descrizione
`id`	Obbligatorio quando invii `frameOptions`. Il tipo di cornice, dagli elenchi sotto. `none` significa nessuna cornice.
`text`	Etichetta dell’invito all’azione, fino a 12 caratteri. Predefinito `Scan me!`.
`color`	Colore della cornice, esadecimale.
`textColor`	Colore dell’etichetta, esadecimale. Deve essere diverso da `color` quando la cornice mostra un’etichetta, a meno che la coppia non sia uno dei preset di colore integrati della cornice.
`borderColor`	Colore del bordo, esadecimale.
`fingerPrintColor`	Colore d’accento dell’icona della cornice, esadecimale.

Cornici generali

none, card, card-1, card-2, card-3, card-4, card-5, card-7, card-8, card-9, card-10, card-11, card-12, card-13, card-14, card-15, card-hor, wreath, envelope, waitress, coffee-cup, scooter, clipboardcard-hor non mostra alcuna etichetta.

Cornici per tipo di QR code

Tipo	Cornici con etichetta	Cornici senza etichetta
App Link	`app-3`	`app-1`, `app-2`
vCard	`contact-1`, `contact-5`	`contact-2`, `contact-3`, `contact-4`
Email	`email-1`	`email-2`, `email-3`, `email-4`, `email-5`
Feedback	—	`feedback-1`, `feedback-2`, `feedback-3`, `feedback-4`, `feedback-5`
Image	—	`image-1`, `image-2`, `image-3`, `image-4`, `image-5`, `image-6`
Location	`location-3`	`location-1`, `location-2`, `location-4`, `location-5`, `location-6`
Multi-Link	`multilink-3`	`multilink-1`, `multilink-2`
Payment	—	`payment-1`, `payment-2`, `payment-3`, `payment-4`, `payment-5`
PDF	`pdf-1`	`pdf-2`, `pdf-3`, `pdf-4`
SMS	`sms-3`, `sms-5`, `sms-7`	`sms-1`, `sms-2`, `sms-4`, `sms-6`
Social Media	`social-3`	`social-1`, `social-2`, `social-4`
Video	`video-1`, `video-3`	`video-2`, `video-4`, `video-5`, `video-6`
Website	`website-1`	`website-2`, `website-3`, `website-4`, `website-5`
WhatsApp	`whatsapp-2`	`whatsapp-1`, `whatsapp-3`, `whatsapp-4`
WiFi	—	`wifi-1`, `wifi-2`, `wifi-3`, `wifi-4`

Qualsiasi cornice funziona con qualsiasi tipo di QR code. Il raggruppamento corrisponde a quello della dashboard.

Le cornici senza etichetta non hanno un campo per l’invito all’azione nella dashboard, e per loro non vale la regola secondo cui textColor deve essere diverso da color.

Loghi

L’oggetto logoOptions posiziona un logo al centro del QR code. Imposta type per scegliere il tipo di logo.

Logo suggerito

Imposta type su suggested e scegli un id dal catalogo. Usa logo-none per nessun logo.

{ "logoOptions": { "type": "suggested", "id": "logo-instagram", "scalePercent": 25 } }

Tutti gli ID dei loghi suggeriti

logo-none, logo-website-3, logo-website-4, logo-link, logo-pdf-1, logo-pdf-2, logo-pdf-3, logo-picture-1, logo-picture-2, logo-picture-3, logo-picture-5, logo-picture-7, logo-picture-8, logo-video-1, logo-video-5, logo-whatsapp-1, logo-whatsapp-2, logo-whatsapp, logo-wifi-1, logo-wifi-2, logo-wifi-3, logo-wifi, logo-airbnb, logo-apple, logo-binance, logo-bitcoin, logo-bolt-food, logo-booking, logo-facebook, logo-glovo, logo-google, logo-google-maps, logo-google-play, logo-instagram, logo-linkedin, logo-location, logo-mail, logo-paypal, logo-stripe, logo-venmo, logo-cashapp, logo-braintree, logo-square, logo-verifone, logo-google-pay, logo-apple-pay, logo-klarna, logo-ayden, logo-giropay, logo-cartes-bancaires, logo-restaurant, logo-scan-me, logo-tripadvisor, logo-trustpilot, logo-uber-eats, logo-youtube, logo-spotify, logo-spotify-black

Il tuo logo

Carica l'immagine

Registrala con File usando "target": "logo", poi carica il file sull’uploadUrl restituito.

Fai riferimento al file

Imposta type su uploaded e fileId sul fileId restituito. fileId è obbligatorio e deve essere un ID restituito dall’endpoint File.

{ "logoOptions": { "type": "uploaded", "fileId": "file_7bQ2xR9mKp", "scalePercent": 35 } }

Un file sconosciuto, un caricamento non completato o un file caricato per un altro target viene rifiutato.

Dimensione del logo

scalePercent imposta la dimensione del logo come percentuale del QR code. Accetta un numero intero da 15 a 45. Il valore predefinito è 25. Gli altri valori, compresi i rapporti come 0.25, restituiscono 422.

Aggiornare un design

Aggiornamenti parziali. Con Aggiorna un QR code, styles, frameOptions e logoOptions vengono uniti al design salvato. Un oggetto parziale modifica solo ciò che indica.
Cambiare il logo. Se scegli un altro logo, sostituisce quello salvato ma mantiene il suo scalePercent.
Template. Con templateId in creazione, i campi che invii vengono uniti sopra il design del template. Consulta Template.
Design Branded e AI. Un QR code con designKind branded o ai è stato creato nella dashboard. L’API non può modificarne l’immagine, ma la mantiene quando modifichi altri campi.
Leggere un design. Le risposte restituiscono il design salvato in design, con la stessa struttura dei campi della richiesta, così puoi reinviarlo.

Problemi comuni

422 "Error correction is always Q and is not an input"

Rimuovi styles.qrOptions dalla richiesta.

422 "Frame caption is at most 12 characters"

Accorcia frameOptions.text a 12 caratteri o meno.

422 "Frame caption color must differ from the frame color"

textColor e color sono uguali su una cornice che mostra un’etichetta. Scegli un textColor a contrasto.

422 "Logo scale is a whole number from 15 to 45"

Invia scalePercent come percentuale intera, ad esempio 25, non 0.25.

Il colore degli angoli non cambia

Gli angoli usano sempre dotsOptions.color. cornersSquareOptions.color e cornersDotOptions.color non hanno alcun effetto.

API

Esempio di oggetto di design

Stili

Cornici

Loghi

Logo suggerito

Il tuo logo

Dimensione del logo

Aggiornare un design

Problemi comuni

Passaggi successivi

QR code

Template

File

Panoramica del design

​Esempio di oggetto di design

​Stili

​Cornici

​Loghi

​Logo suggerito

​Il tuo logo

​Dimensione del logo

​Aggiornare un design

​Problemi comuni

​Passaggi successivi

QR code

Template

File

Panoramica del design

Esempio di oggetto di design

Stili

Cornici

Loghi

Logo suggerito

Il tuo logo

Dimensione del logo

Aggiornare un design

Problemi comuni

Passaggi successivi