GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
styles, frameOptions och logoOptions. Den innehåller aldrig innehåll eller en länk. Mallar delas av alla i arbetsytan.
Tillämpa en mall
SkickatemplateId när du skapar en QR-kod. Mallens design tillämpas på den nya QR-koden. De av de tre designobjekten som du skickar i samma begäran slås samman ovanpå den.
- Kopieras, länkas inte. QR-koden behåller en egen kopia av designen. Om du redigerar eller tar bort mallen senare påverkas den inte.
- Bara anpassade designer. En mall med
designKindbrandedelleraikan inte tillämpas via API:et och returnerar422(art_template_unsupported). - Bara din arbetsyta. En okänd mall, eller en från en annan arbetsyta, returnerar
404.
Huvuden
string
obligatorisk
Bearer följt av din API-nyckel. Se Autentisering.string
application/json. Krävs för begäranden med body.Mallobjektet
string
Mallens id, till exempel
qrt_8Hs2mQvKpLd4RtYw.string
Namnet som visas när du väljer mall.
string
Skrivskyddat.
custom är en design som API:et kan redigera helt. branded och ai är en varumärkesdesign eller AI-design som skapats i instrumentpanelen: dess bild kan inte redigeras via API:et, och den behålls när du ändrar de andra designfälten.object
Den sparade designen. Varje fält har samma form som fältet med samma namn i begäran, så du kan skicka tillbaka det.
string
Datum då den skapades, ISO 8601.
string
Datum för senaste uppdatering, ISO 8601.
Lista mallar
GET /api/v1/templates
Returnerar arbetsytans mallar, med de nyaste först. Listan är paginerad: se Paginering.
integer
standard:"1"
Sidan som returneras, 1 eller högre.
integer
standard:"100"
Resultat per sida, 1 till 100.
Skapa en mall
POST /api/v1/templates
Sparar en ny design. Svarar 201 Created. Designfälten kontrolleras mot katalogerna i Anpassning, så en okänd form, ram eller logotyp avvisas med 422.
string
obligatorisk
Namnet som visas när du väljer mall, 1 till 40 tecken.
object
Former och färger för prickar och hörn. Se Anpassning.
object
Ramen runt QR-koden och dess uppmaningstext. Se Anpassning.
object
Logotyp i mitten: en föreslagen logotyp, eller din egen fil uppladdad med target
logo i Filer. Se Anpassning.Hämta en mall
GET /api/v1/templates/{templateId}
string
obligatorisk
Mallens id. Hämta det från svaret på listningen eller skapandet.
Uppdatera en mall
PATCH /api/v1/templates/{templateId}
Skicka bara de fält du vill ändra. Designobjekten slås samman med den sparade designen, så en partiell styles behåller resten. QR-koder som redan har skapats från mallen behåller den design de skapades med.
string
obligatorisk
Mallens id.
string
Nytt namn, 1 till 40 tecken.
object
Stiländringar, sammanslagna med den sparade
styles.object
Ramändringar, sammanslagna med den sparade ramen.
object
Logotypändringar, sammanslagna med den sparade logotypen.
Ta bort en mall
DELETE /api/v1/templates/{templateId}
Tar bort mallen. QR-koder som skapats från den behåller sin design.
string
obligatorisk
Mallens id.
Duplicera en mall
POST /api/v1/templates/{templateId}/duplicate
Skapar en kopia med namnet <name> copy, med ett eget id och en oberoende design som du kan redigera fritt. Tar ingen body. Svarar 201 Created.
string
obligatorisk
Id för mallen som ska kopieras.
Vanliga problem
404 "QR template not found."
404 "QR template not found."
templateId matchar ingen mall i din arbetsyta. Hämta det från Lista mallar.422 när en mall skapas eller uppdateras
422 när en mall skapas eller uppdateras
Ett designfält matchar inte katalogerna, till exempel en okänd pricktyp, ram eller föreslagen logotyp. Meddelandet anger fältet. Se Anpassning.
422 art_template_unsupported när en QR-kod skapas
422 art_template_unsupported när en QR-kod skapas
Mallen använder en varumärkesdesign eller AI-design. Tillämpa i stället en mall med
designKind custom.