GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
styles, frameOptions og logoOptions. Den indeholder aldrig indhold eller et link. Skabeloner deles af alle i arbejdsområdet.
Anvend en skabelon
AngivtemplateId, når du opretter en QR-kode. Skabelonens design anvendes på den nye QR-kode. Designobjekter, du sender i samme forespørgsel, flettes oven på det.
- Kopieret, ikke forbundet. QR-koden beholder sin egen kopi af designet. Redigerer eller sletter du skabelonen senere, ændres QR-koden ikke.
- Kun tilpassede designs. En skabelon med
designKindbrandedelleraikan ikke anvendes via API’et og returnerer422(art_template_unsupported). - Kun dit arbejdsområde. En ukendt skabelon eller en fra et andet arbejdsområde returnerer
404.
Headere
string
påkrævet
Bearer efterfulgt af din API-nøgle. Se Godkendelse.string
application/json. Påkrævet ved forespørgsler med en body.Skabelonobjektet
string
Skabelonens id, f.eks.
qrt_8Hs2mQvKpLd4RtYw.string
Navnet, der vises, når du vælger en skabelon.
string
Skrivebeskyttet.
custom er et design, som API’et kan redigere fuldt ud. branded og ai er et Branded design eller AI design lavet i dashboardet: Dets billede kan ikke redigeres via API’et, og det bevares, når du ændrer de andre designfelter.object
Det gemte design. Hvert felt har samme form som forespørgselsfeltet med samme navn, så du kan sende det tilbage.
string
Oprettelsesdato, ISO 8601.
string
Dato for seneste opdatering, ISO 8601.
Vis skabeloner
GET /api/v1/templates
Returnerer skabelonerne i dit arbejdsområde med de nyeste først. Listen er pagineret: se Paginering.
integer
standard:"1"
Siden, der returneres, 1 eller højere.
integer
standard:"100"
Resultater pr. side, 1 til 100.
Opret en skabelon
POST /api/v1/templates
Gemmer et nyt design. Svarer 201 Created. Designfelterne kontrolleres mod katalogerne i Tilpasning, så en ukendt form, ramme eller et ukendt logo afvises med 422.
string
påkrævet
Navnet, der vises, når du vælger en skabelon, 1 til 40 tegn.
object
Former og farver på prikker og hjørner. Se Tilpasning.
object
Rammen rundt om QR-koden og dens handlingstekst. Se Tilpasning.
object
Logo i midten: et foreslået logo eller din egen fil uploadet med target
logo i Filer. Se Tilpasning.Hent en skabelon
GET /api/v1/templates/{templateId}
string
påkrævet
Skabelonens id. Hent det fra svaret på listen eller oprettelsen.
Opdater en skabelon
PATCH /api/v1/templates/{templateId}
Send kun de felter, du vil ændre. Designobjekter flettes ind i det gemte design, så et delvist styles bevarer resten. QR-koder, der allerede er oprettet ud fra skabelonen, beholder det design, de blev lavet med.
string
påkrævet
Skabelonens id.
string
Nyt navn, 1 til 40 tegn.
object
Ændringer i stil, flettet ind i de gemte
styles.object
Ændringer i rammen, flettet ind i den gemte ramme.
object
Ændringer i logoet, flettet ind i det gemte logo.
Slet en skabelon
DELETE /api/v1/templates/{templateId}
Sletter skabelonen. QR-koder, der er oprettet ud fra den, beholder deres design.
string
påkrævet
Skabelonens id.
Duplikér en skabelon
POST /api/v1/templates/{templateId}/duplicate
Opretter en kopi med navnet <name> copy, med sit eget id og et uafhængigt design, du frit kan redigere. Tager ingen body. Svarer 201 Created.
string
påkrævet
Id’et på den skabelon, der skal kopieres.
Almindelige problemer
404 "QR template not found."
404 "QR template not found."
templateId matcher ikke en skabelon i dit arbejdsområde. Hent det fra Vis skabeloner.422 ved oprettelse eller opdatering af en skabelon
422 ved oprettelse eller opdatering af en skabelon
Et designfelt passer ikke til katalogerne, f.eks. en ukendt prikform, ramme eller et ukendt foreslået logo. Beskeden nævner feltet. Se Tilpasning.
422 art_template_unsupported ved oprettelse af en QR-kode
422 art_template_unsupported ved oprettelse af en QR-kode
Skabelonen bruger et Branded design eller AI design. Anvend i stedet en skabelon med
designKind custom.