API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
styles, frameOptions și logoOptions. Nu conține niciodată conținut sau un link. Șabloanele sunt partajate de toți membrii spațiului de lucru.
Aplicarea unui șablon
TransmitețitemplateId când creați un cod QR. Designul șablonului se aplică noului cod QR. Oricare dintre cele trei obiecte de design trimise în aceeași cerere se aplică peste el.
- Copiat, nu legat. Codul QR își păstrează propria copie a designului. Editarea sau ștergerea ulterioară a șablonului nu îl modifică.
- Doar designuri personalizate. Un șablon cu
designKindbrandedsauainu poate fi aplicat prin API și returnează422(art_template_unsupported). - Doar spațiul dvs. de lucru. Un șablon necunoscut sau unul din alt spațiu de lucru returnează
404.
Anteturi
string
obligatoriu
Bearer urmat de cheia dvs. API. Consultați Autentificare.string
application/json. Obligatoriu pentru cererile cu corp.Obiectul șablon
string
ID-ul șablonului, de exemplu
qrt_8Hs2mQvKpLd4RtYw.string
Numele afișat la alegerea unui șablon.
string
Doar citire.
custom este un design pe care API-ul îl poate edita complet. branded și ai sunt un design Branded sau un design AI creat în panou: imaginea lui nu poate fi editată prin API și este păstrată când modificați celelalte câmpuri de design.object
Designul stocat. Fiecare câmp are aceeași formă ca și câmpul cu același nume din cerere, așa că îl puteți trimite înapoi.
string
Data creării, ISO 8601.
string
Data ultimei actualizări, ISO 8601.
Listarea șabloanelor
GET /api/v1/templates
Returnează șabloanele spațiului dvs. de lucru, cele mai noi primele. Lista este paginată: consultați Paginare.
integer
implicit:"1"
Pagina returnată, 1 sau mai mult.
integer
implicit:"100"
Rezultate pe pagină, de la 1 la 100.
Crearea unui șablon
POST /api/v1/templates
Salvează un design nou. Răspunde cu 201 Created. Câmpurile de design sunt verificate în raport cu cataloagele din Personalizare, așa că o formă, un cadru sau un logo necunoscut este respins cu 422.
string
obligatoriu
Numele afișat la alegerea unui șablon, între 1 și 40 de caractere.
object
Forma punctelor și a colțurilor și culorile. Consultați Personalizare.
object
Cadrul desenat în jurul codului QR și textul îndemnului la acțiune. Consultați Personalizare.
object
Logoul plasat în centru: un logo sugerat sau propriul fișier, încărcat cu targetul
logo din Fișiere. Consultați Personalizare.Obținerea unui șablon
GET /api/v1/templates/{templateId}
string
obligatoriu
ID-ul șablonului. Preluați-l din răspunsul listei sau al creării.
Actualizarea unui șablon
PATCH /api/v1/templates/{templateId}
Trimiteți doar câmpurile pe care vreți să le modificați. Obiectele de design sunt combinate cu designul stocat, așa că un styles parțial păstrează restul. Codurile QR deja create din șablon păstrează designul cu care au fost create.
string
obligatoriu
ID-ul șablonului.
string
Numele nou, între 1 și 40 de caractere.
object
Modificări de stil, combinate cu
styles stocat.object
Modificări ale cadrului, combinate cu cadrul stocat.
object
Modificări ale logoului, combinate cu logoul stocat.
Ștergerea unui șablon
DELETE /api/v1/templates/{templateId}
Șterge șablonul. Codurile QR create din el își păstrează designul.
string
obligatoriu
ID-ul șablonului.
Duplicarea unui șablon
POST /api/v1/templates/{templateId}/duplicate
Creează o copie numită <name> copy, cu propriul ID și un design independent, pe care îl puteți edita liber. Nu primește corp de cerere. Răspunde cu 201 Created.
string
obligatoriu
ID-ul șablonului care se copiază.
Probleme frecvente
404 "QR template not found."
404 "QR template not found."
templateId nu corespunde unui șablon din spațiul dvs. de lucru. Preluați-l din Listarea șabloanelor.422 la crearea sau actualizarea unui șablon
422 la crearea sau actualizarea unui șablon
Un câmp de design nu corespunde cataloagelor, de exemplu un tip de punct, un cadru sau un logo sugerat necunoscut. Mesajul indică câmpul. Consultați Personalizare.
422 art_template_unsupported la crearea unui cod QR
422 art_template_unsupported la crearea unui cod QR
Șablonul folosește un design Branded sau un design AI. Aplicați în schimb un șablon cu
designKind custom.