GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
styles, frameOptions og logoOptions. Den inneholder aldri innhold eller en lenke. Maler deles av alle i arbeidsområdet.
Bruk en mal
SendtemplateId når du oppretter en QR-kode. Malens design brukes på den nye QR-koden. De av de tre designobjektene du sender i samme forespørsel, flettes oppå det.
- Kopiert, ikke koblet. QR-koden beholder sin egen kopi av designet. Redigerer eller sletter du malen senere, endres ikke QR-koden.
- Bare egendefinerte design. En mal med
designKindbrandedelleraikan ikke brukes via API-et og returnerer422(art_template_unsupported). - Bare ditt arbeidsområde. En ukjent mal, eller en fra et annet arbeidsområde, returnerer
404.
Headere
string
påkrevd
Bearer etterfulgt av API-nøkkelen din. Se Autentisering.string
application/json. Påkrevd ved forespørsler med body.Malobjektet
string
ID-en til malen, for eksempel
qrt_8Hs2mQvKpLd4RtYw.string
Navnet som vises når du velger mal.
string
Skrivebeskyttet.
custom er et design som API-et kan redigere fullt ut. branded og ai er et Branded design eller AI design laget i dashbordet: bildet kan ikke redigeres via API-et, og det beholdes når du endrer de andre designfeltene.object
Det lagrede designet. Hvert felt har samme form som feltet med samme navn i forespørselen, så du kan sende det tilbake.
string
Opprettelsesdato, ISO 8601.
string
Dato for siste oppdatering, ISO 8601.
Vis maler
GET /api/v1/templates
Returnerer malene i arbeidsområdet ditt, med de nyeste først. Listen er paginert: se Paginering.
integer
standard:"1"
Siden som skal returneres, 1 eller høyere.
integer
standard:"100"
Resultater per side, 1 til 100.
Opprett en mal
POST /api/v1/templates
Lagrer et nytt design. Svarer 201 Created. Designfeltene kontrolleres mot katalogene i Tilpasning, så en ukjent form, ramme eller logo avvises med 422.
string
påkrevd
Navnet som vises når du velger mal, 1 til 40 tegn.
object
Former og farger på prikker og hjørner. Se Tilpasning.
object
Rammen rundt QR-koden og teksten for handlingsoppfordringen. Se Tilpasning.
object
Logo i midten: en foreslått logo, eller din egen fil lastet opp med target
logo i Filer. Se Tilpasning.Hent en mal
GET /api/v1/templates/{templateId}
string
påkrevd
ID-en til malen. Hent den fra svaret på listen eller opprettelsen.
Oppdater en mal
PATCH /api/v1/templates/{templateId}
Send bare feltene du vil endre. Designobjekter flettes inn i det lagrede designet, så en delvis styles beholder resten. QR-koder som allerede er opprettet fra malen, beholder designet de ble laget med.
string
påkrevd
ID-en til malen.
string
Nytt navn, 1 til 40 tegn.
object
Stilendringer, flettet inn i den lagrede
styles.object
Rammeendringer, flettet inn i den lagrede rammen.
object
Logoendringer, flettet inn i den lagrede logoen.
Slett en mal
DELETE /api/v1/templates/{templateId}
Sletter malen. QR-koder som er opprettet fra den, beholder designet sitt.
string
påkrevd
ID-en til malen.
Dupliser en mal
POST /api/v1/templates/{templateId}/duplicate
Oppretter en kopi med navnet <name> copy, med egen ID og et uavhengig design som du kan redigere fritt. Tar ingen body. Svarer 201 Created.
string
påkrevd
ID-en til malen som skal kopieres.
Vanlige problemer
404 "QR template not found."
404 "QR template not found."
templateId samsvarer ikke med en mal i arbeidsområdet ditt. Hent den fra Vis maler.422 når jeg oppretter eller oppdaterer en mal
422 når jeg oppretter eller oppdaterer en mal
Et designfelt samsvarer ikke med katalogene, for eksempel en ukjent prikktype, ramme eller foreslått logo. Meldingen navngir feltet. Se Tilpasning.
422 art_template_unsupported når jeg oppretter en QR-kode
422 art_template_unsupported når jeg oppretter en QR-kode
Malen bruker et Branded design eller AI design. Bruk i stedet en mal med
designKind custom.