L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.
styles, frameOptions e logoOptions. Non contiene mai contenuti né link. I template sono condivisi da tutti i membri del workspace.
Applica un template
PassatemplateId quando crei un QR code. Il design del template viene applicato al nuovo QR code. Gli oggetti di design che invii nella stessa richiesta vengono uniti sopra di esso.
- Copiato, non collegato. Il QR code conserva una propria copia del design. Modificare o eliminare il template in seguito non lo cambia.
- Solo design personalizzati. Un template con
designKindbrandedoainon può essere applicato tramite l’API e restituisce422(art_template_unsupported). - Solo il tuo workspace. Un template sconosciuto, o di un altro workspace, restituisce
404.
Header
string
obbligatorio
Bearer seguito dalla tua chiave API. Consulta Autenticazione.string
application/json. Obbligatorio nelle richieste con un corpo.L’oggetto template
string
ID del template, ad esempio
qrt_8Hs2mQvKpLd4RtYw.string
Nome mostrato quando scegli un template.
string
Sola lettura.
custom è un design che l’API può modificare completamente. branded e ai sono un design Branded o un design AI creato nella dashboard: la sua immagine non può essere modificata tramite l’API e viene mantenuta quando modifichi gli altri campi di design.object
Il design salvato. Ogni campo ha la stessa struttura del campo della richiesta con lo stesso nome, così puoi reinviarlo.
string
Data di creazione, ISO 8601.
string
Data dell’ultimo aggiornamento, ISO 8601.
Elenca i template
GET /api/v1/templates
Restituisce i template del tuo workspace, dal più recente. L’elenco è paginato: consulta Paginazione.
integer
predefinito:"1"
Pagina da restituire, 1 o superiore.
integer
predefinito:"100"
Risultati per pagina, da 1 a 100.
Crea un template
POST /api/v1/templates
Salva un nuovo design. Risponde 201 Created. I campi di design vengono verificati sui cataloghi riportati in Personalizzazione, quindi una forma, una cornice o un logo sconosciuto viene rifiutato con 422.
string
obbligatorio
Nome mostrato quando scegli un template, da 1 a 40 caratteri.
object
Forme e colori di punti e angoli. Consulta Personalizzazione.
object
Cornice disegnata attorno al QR code e testo del suo invito all’azione. Consulta Personalizzazione.
object
Logo posizionato al centro: un logo suggerito, oppure un tuo file caricato con il target
logo di File. Consulta Personalizzazione.Ottieni un template
GET /api/v1/templates/{templateId}
string
obbligatorio
ID del template. Prendilo dalla risposta dell’elenco o della creazione.
Aggiorna un template
PATCH /api/v1/templates/{templateId}
Invia solo i campi che vuoi modificare. Gli oggetti di design vengono uniti al design salvato, quindi uno styles parziale mantiene il resto. I QR code già creati dal template mantengono il design con cui sono stati creati.
string
obbligatorio
ID del template.
string
Nuovo nome, da 1 a 40 caratteri.
object
Modifiche allo stile, unite allo
styles salvato.object
Modifiche alla cornice, unite alla cornice salvata.
object
Modifiche al logo, unite al logo salvato.
Elimina un template
DELETE /api/v1/templates/{templateId}
Elimina il template. I QR code creati a partire da esso mantengono il loro design.
string
obbligatorio
ID del template.
Duplica un template
POST /api/v1/templates/{templateId}/duplicate
Crea una copia chiamata <name> copy, con un proprio ID e un design indipendente che puoi modificare liberamente. Non richiede un corpo della richiesta. Risponde 201 Created.
string
obbligatorio
ID del template da copiare.
Problemi comuni
404 "QR template not found."
404 "QR template not found."
Il
templateId non corrisponde a un template del tuo workspace. Prendilo da Elenca i template.422 durante la creazione o l'aggiornamento di un template
422 durante la creazione o l'aggiornamento di un template
Un campo di design non corrisponde ai cataloghi, ad esempio un tipo di punto, una cornice o un logo suggerito sconosciuto. Il messaggio indica il campo. Consulta Personalizzazione.
422 art_template_unsupported durante la creazione di un QR code
422 art_template_unsupported durante la creazione di un QR code
Il template usa un design Branded o un design AI. Applica invece un template con
designKind custom.