Vai al contenuto principale
L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.
Ogni QR code ha un qrType, e il tipo stabilisce cosa deve contenere data. Questa guida riporta il formato di ogni tipo, un corpo della richiesta funzionante e cosa puoi ancora modificare dopo aver stampato il codice. Gli esempi sono corpi della richiesta per Crea un QR code. Inviali così:

Tutti i tipi in sintesi

Come si risolve un QR code

Ogni QR code è un link breve più un payload. Due campi contengono il contenuto: Regole valide per tutti i tipi:
  • Valori predefiniti. In creazione, un link.url omesso o vuoto diventa data, e puoi tralasciare l’intero oggetto link. Se li invii entrambi e sono diversi, prevale link.url. Inviali uguali, oppure invia solo data.
  • Cosa codifica l’immagine. L’immagine codifica il link breve per tutti i tipi tranne wifi. Così puoi cambiare dove porta un codice stampato e le sue scansioni vengono tracciate. Un QR code WiFi codifica direttamente la rete: non puoi modificarlo dopo la stampa e le sue scansioni non vengono tracciate.
  • Schemi. link.url accetta solo http:, https:, wifi:, mailto:, sms: e begin:. Tutto il resto, compresi geo:, smsto:, matmsg: e tel:, riceve 422 Invalid destination URL, anche quando data lo accetta.
  • Dati vuoti. Un data vuoto salta la verifica del tipo. Per un tipo con reindirizzamento, in quel caso link.url deve essere impostato, altrimenti la chiamata riceve 400 Missing destination URL.
  • Struttura. Oltre alla verifica del tipo, il server non convalida il payload. A un tipo JSON basta essere interpretabile come oggetto JSON, e a una vCard basta iniziare con BEGIN:VCARD.
I limiti contrassegnati con Builder qui sotto sono quelli imposti dall’editor della dashboard. L’API accetta payload che non li rispettano, ma potrebbero essere visualizzati in modo strano nella landing page o nell’editor.

Website

qrType: "website". Guida della dashboard: QR code Website.
Request body
Errori:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Feedback

qrType: "feedback". Guida della dashboard: QR code Feedback. data è l’URL http(s) del modulo di feedback, ad esempio un Google Form o una pagina di recensioni. Tutto il resto funziona come per Website.
Request body

Payment

qrType: "payment". Guida della dashboard: QR code Payment. data è l’URL di pagamento del fornitore, ad esempio:
L’editor della dashboard riconosce questi host: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link e payoneer.com. Per PayPal, l’importo è l’ultimo segmento del percorso. Funziona anche qualsiasi altro URL http(s), ma l’editor non lo scompone in fornitore e importo. Tutto il resto funziona come per Website.
Request body

WhatsApp

qrType: "whatsapp". Guida della dashboard: QR code WhatsApp. data è un link wa.me: il numero internazionale in cifre senza +, con un testo precompilato facoltativo.
Il server verifica solo che sia un URL http(s). La dashboard legge anche i link api.whatsapp.com/send. Tutto il resto funziona come per Website.
Request body

Location

qrType: "location". Guida della dashboard: QR code Location. data è l’URL di una mappa. Usa questo formato per mantenere il QR code modificabile nella dashboard (query_place_id è facoltativo):
Anche qualsiasi altro URL http(s) reindirizza. Un URI geo: supera la verifica di data ma viene rifiutato come destinazione, quindi non usarlo. Tutto il resto funziona come per Website.
Request body
qrType: "app". Guida della dashboard: QR code App Link.
Request body
Errori:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". Guida della dashboard: QR code Email.
Request body
Errori:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Guida della dashboard: QR code SMS.
Request body
Errori:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Guida della dashboard: QR code WiFi.
Request body
Errori:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Non cambiare il tipo di un QR code WiFi già stampato. I codici stampati mantengono la rete precedente.

PDF, Image e Video

qrType: "pdf", "image" o "video". Guide della dashboard: PDF, Image, Video. Un solo file per QR code: raccolte di PDF e gallerie di immagini non sono disponibili tramite l’API. Consulta Non supportato dall’API.
Per caricare il file e ottenere il suo fileId, consulta File.

vCard

qrType: "vcard". Guida della dashboard: QR code vCard. La landing page e l’editor leggono solo le forme di riga riportate qui sotto. Altre varianti, come TEL;CELL: o EMAIL;TYPE=INTERNET:, vengono salvate ma non compaiono nella pagina.
  • N:<last>;<first>;;;: cognome e nome. Builder: entrambi obbligatori, fino a 40 caratteri.
  • FN:<first> <last>: non letto dalla pagina. Da qui viene l’etichetta nell’elenco della dashboard.
  • ORG:<company> e TITLE:<role>: azienda e ruolo. Builder: fino a 40 caratteri.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: numeri di telefono, cellulare, lavoro e fax (+ e cifre).
  • EMAIL:<email>: indirizzo email.
  • URL:<url>: sito web.
  • NOTE:<text>: riepilogo. Fai l’escape di \\, \n, \; e \,. Builder: fino a 200 caratteri.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: indirizzo.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> o URL;TYPE=<PLATFORM>:<url>: link social, una riga per piattaforma.
  • PHOTO;VALUE=URI:<url>: URL dell’immagine del profilo. Ha la precedenza su qualsiasi ID di file.
  • X-GETQR-IMAGE-FILEID:<fileId>: immagine del profilo (target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: logo della pagina (target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> o X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: tema della landing page, un indice di preset (da 0 a 4) oppure colori personalizzati di sfondo, pulsanti e icone.
Piattaforme social: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Errori:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Guida della dashboard: QR code Social Media. Campi di data:
Request body
Errori:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Guida della dashboard: QR code Multi-Link. I campi di data sono quelli di Social Media, tranne firstName, lastName e summary, sostituiti da: In customItems, logoFileId è facoltativo: viene mostrata un’icona di riserva. Builder: almeno un link social o un elemento personalizzato non vuoto.
Request body
Errori:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". Guida della dashboard: QR code Event. Campi di data:
conference, seminar, workshop, training, webinar, meetup, networking, corporateEvent, productLaunch, tradeShow, jobFair, fundraiser, charity, wedding, engagement, birthday, anniversary, babyShower, graduation, reunion, party, religious, funeralMemorial, ceremony, concert, festival, clubNight, theater, comedy, filmScreening, exhibition, sports, tournament, raceMarathon, fitnessClass, foodDrink, market, openHouse, community, schoolEvent, kids, travelTour
Request body
Errori:
  • 422 Expected a JSON object describing the event page for qrType "event".

File nei QR code

Registra un file con File, caricalo e poi passa il suo fileId. Usa il target adatto all’uso:
  • pdf, image, video. Il contenuto di un QR code PDF, Image o Video.
  • logo. Immagini del profilo, loghi della pagina, icone dei link personalizzati e loghi centrali.
I file che non vengono mai collegati a un QR code vengono eliminati dopo un periodo di tolleranza. Errori di fileId, restituiti in creazione e in PATCH quando invii fileId: Gli ID di file all’interno di un payload (fileId, pageLogoFileId, customItems[].logoFileId, righe X-GETQR-*-FILEID) non vengono convalidati. Vengono visualizzati solo se caricati con il target logo. Il QR code li rivendica, quindi la pulizia automatica non li tocca.

Cambiare tipo

Puoi cambiare qrType con Aggiorna un QR code. Invia un data adatto al nuovo tipo: il payload salvato appartiene al tipo precedente, quindi un cambio di tipo senza di esso viene rifiutato. Dopo un aggiornamento, la destinazione viene determinata in questo ordine:
  1. vcard, social, multilink, event: sempre la pagina ospitata.
  2. Una raccolta di PDF o una galleria di immagini creata nella dashboard: la sua landing page.
  3. pdf, image, video: l’URL del file (un nuovo fileId, altrimenti quello salvato).
  4. link.url, se inviato.
  5. Il data modificato.
  6. L’URL salvato.
Cosa comporta ogni cambio:
  • Da pdf, image o video a un altro tipo. fileId ed eventuali raccolte o gallerie vengono cancellati.
  • Verso pdf, image o video. Invia anche fileId, altrimenti viene riutilizzato quello salvato, che potrebbe essere la foto di una vCard.
  • Da app a un altro tipo. Il nome dell’app, link.ios e link.android vengono cancellati, quindi i telefoni seguono la nuova destinazione.
  • Verso wifi. L’immagine passa al payload grezzo. I codici già stampati contengono ancora il link breve, che ora reindirizza a un URL wifi:.
  • Da wifi a un altro tipo. I codici stampati mantengono la rete precedente.
  • Verso vcard, social, multilink o event. Il link breve viene indirizzato alla nuova pagina ospitata.
  • Da vcard, social, multilink o event a un altro tipo. Invia il nuovo data. La destinazione lo segue.
I QR code statici creati nella dashboard non hanno un link breve, quindi la modifica del loro link.url riceve 422.

Non supportato dall’API

Queste funzionalità della dashboard non fanno parte dell’API v1. I campi sconosciuti vengono scartati senza errori, quindi inviarli non ha alcun effetto. Le raccolte e le gallerie create nella dashboard possono comunque essere lette, messe in pausa ed eliminate tramite l’API, ma i loro file non possono essere modificati tramite l’API.

Problemi comuni

link.url usa uno schema verso cui il link breve non può reindirizzare, come geo:, smsto:, matmsg: o tel:. Usa i formati riportati in questa pagina.
data è vuoto e non c’è un link.url. Per app, imposta almeno uno tra link.ios, link.android, link.url e data.
La pagina legge solo i campi e le forme di riga elencati per il tipo. Gli altri campi vengono salvati ma non mostrati.

Passaggi successivi

QR code

File

Personalizzazione

Regole di accesso