A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.
styles, frameOptions és logoOptions. Soha nem tartalmaz tartalmat vagy linket. A sablonokon a munkaterület minden tagja osztozik.
Sablon alkalmazása
Adja meg atemplateId értékét, amikor QR-kódot hoz létre. A sablon dizájnja az új QR-kódra kerül. A három dizájnobjektum közül azok, amelyeket ugyanabban a kérésben küld, erre olvadnak rá.
- Másolat, nem kapcsolat. A QR-kód a dizájn saját másolatát tartja meg. A sablon későbbi szerkesztése vagy törlése nem módosítja.
- Csak Custom dizájnok. A
brandedvagyaidesignKindértékű sablon az API-n keresztül nem alkalmazható, és422(art_template_unsupported) választ ad. - Csak a saját munkaterület. Ismeretlen vagy más munkaterülethez tartozó sablon esetén
404a válasz.
Fejlécek
string
kötelező
Bearer, majd az API-kulcsa. Lásd: Hitelesítés.string
application/json. Törzzsel rendelkező kéréseknél kötelező.A sablon objektum
string
A sablon azonosítója, például
qrt_8Hs2mQvKpLd4RtYw.string
A sablon választásakor megjelenő név.
string
Csak olvasható. A
custom olyan dizájn, amelyet az API teljes egészében szerkeszthet. A branded és az ai az irányítópulton készült Branded vagy AI dizájn: a képe az API-n keresztül nem szerkeszthető, és megmarad, amikor a többi dizájnmezőt módosítja.object
A tárolt dizájn. Minden mező felépítése megegyezik az azonos nevű kérésmezőével, így vissza is küldheti.
string
Létrehozás dátuma, ISO 8601.
string
Utolsó frissítés dátuma, ISO 8601.
Sablonok listázása
GET /api/v1/templates
A munkaterület sablonjait adja vissza, a legújabbal kezdve. A lista lapozható: lásd Lapozás.
integer
alapértelmezett:"1"
A visszaadandó oldal, 1 vagy nagyobb.
integer
alapértelmezett:"100"
Találatok oldalanként, 1 és 100 között.
Sablon létrehozása
POST /api/v1/templates
Új dizájnt ment. 201 Created kóddal válaszol. A dizájnmezőket a rendszer a Testreszabás oldalon felsorolt katalógusokhoz méri, így az ismeretlen formát, keretet vagy logót 422 hibával elutasítja.
string
kötelező
A sablon választásakor megjelenő név, 1–40 karakter.
object
Pont- és sarokformák és színek. Lásd: Testreszabás.
object
A QR-kód köré rajzolt keret és a cselekvésre ösztönző szöveg. Lásd: Testreszabás.
object
Középre helyezett logó: javasolt logó, vagy saját, a Fájlok végpont
logo céljával feltöltött fájl. Lásd: Testreszabás.Sablon lekérése
GET /api/v1/templates/{templateId}
string
kötelező
A sablon azonosítója. A lista vagy a létrehozás válaszából veheti.
Sablon frissítése
PATCH /api/v1/templates/{templateId}
Csak a módosítani kívánt mezőket küldje el. A dizájnobjektumok a tárolt dizájnba olvadnak, így egy részleges styles a többit megtartja. A sablonból már létrehozott QR-kódok megtartják azt a dizájnt, amellyel készültek.
string
kötelező
A sablon azonosítója.
string
Új név, 1–40 karakter.
object
Stílusmódosítások, a tárolt
styles objektumba olvasztva.object
Keretmódosítások, a tárolt keretbe olvasztva.
object
Logómódosítások, a tárolt logóba olvasztva.
Sablon törlése
DELETE /api/v1/templates/{templateId}
Törli a sablont. A belőle létrehozott QR-kódok megtartják a dizájnjukat.
string
kötelező
A sablon azonosítója.
Sablon másolása
POST /api/v1/templates/{templateId}/duplicate
Másolatot készít <name> copy néven, saját azonosítóval és önálló dizájnnal, amelyet szabadon szerkeszthet. Nem vár kéréstörzset. 201 Created kóddal válaszol.
string
kötelező
A másolandó sablon azonosítója.
Gyakori problémák
404 "QR template not found."
404 "QR template not found."
A
templateId nem egyezik a munkaterület egyik sablonjával sem. Vegye a Sablonok listázása válaszából.422-es hiba sablon létrehozásakor vagy frissítésekor
422-es hiba sablon létrehozásakor vagy frissítésekor
Egy dizájnmező nem felel meg a katalógusoknak, például ismeretlen pontstílus, keret vagy javasolt logó. Az üzenet megnevezi a mezőt. Lásd: Testreszabás.
422 art_template_unsupported QR-kód létrehozásakor
422 art_template_unsupported QR-kód létrehozásakor
A sablon Branded vagy AI dizájnt használ. Helyette
custom designKind értékű sablont alkalmazzon.