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.
QR-kód-adatok típusonként
A
data formátuma mind a 16 típushoz.Testreszabás
Pontstílusok, színek, keretek és logók.
Hozzáférési szabályok
Ütemezés, beolvasási korlát és jelszó.
A QR-kód objektum
Minden QR-kód-végpont ezzel az objektummal válaszol, kivéve a törlést és a letöltést. A lista ilyen objektumok tömbjét adja vissza.string
A QR-kód egyedi azonosítója, például
qr_1EPcVfeHZAY2iNoVLsgW2Aqf.string
A QR-kód típusa, például
website. Mind a 16 értéket lásd: QR-kód-adatok típusonként.string | null
A QR-kód neve, amely az irányítópulton jelenik meg.
string | null
Szabad szöveges megjegyzés a QR-kódhoz.
string
A tárolt tartalom. A
wifi, vcard, social, multilink, event és sms típusnál az Ön által küldött tartalom. Minden más típusnál a rövid link, ezért a célt az url mezőből olvassa ki.boolean
true, ha a QR-kód szünetel.boolean
true egy irányítópulton készült statikus QR-kódnál, amelynek nincs rövid linkje. Az API mindig dinamikus QR-kódokat hoz létre.string | null
A teljes rövid link, például
https://getqr.sh/x7Kd2p1.string | null
A rövid link domainje.
string | null
A rövid link azonosítója (slug).
boolean
true, ha az azonosítót választották, nem generálták.string | null
A cél, ahová a rövid link átirányít.
string | null
Cél az iOS-es látogatóknak,
app QR-kódoknál.string | null
Cél az androidos látogatóknak,
app QR-kódoknál.integer
A beolvasások teljes száma.
object
Hozzáférési szabályok. Magát a jelszót a rendszer soha nem adja vissza. Lásd: Hozzáférési szabályok.
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. Az API nem tudja szerkeszteni a képét, de megtartja, amikor más mezőket módosít.object
A tárolt dizájn:
styles, frameOptions és logoOptions, mindegyik objektum vagy null. Felépítésük megegyezik a kérésmezőkével, így vissza is küldheti őket. Lásd: Testreszabás.object | null
Egy
pdf, image vagy video QR-kód fájlja: id, name és size (bájtban).string | null
Csak olvasható. Egy irányítópulton készült
app QR-kód megjelenített neve.object | null
Csak olvasható. Az irányítópulton készült, több fájlt tartalmazó
pdf QR-kód: title, layout és files.object | null
Csak olvasható. Az irányítópulton készült, több képet tartalmazó
image QR-kód: title, layout és files.string
Létrehozás dátuma, ISO 8601.
string
Utolsó frissítés dátuma, ISO 8601.
password, userId, workspaceId, projectId) a rendszer soha nem adja vissza.
QR-kódok listázása
GET /api/v1/qrs
A munkaterület QR-kódjait adja vissza, oldalanként.
integer
alapértelmezett:"1"
A visszaadandó oldal, 1 vagy nagyobb.
integer
alapértelmezett:"100"
QR-kódok oldalanként, 1 és 100 között. Nagyobb értéket a rendszer elutasít.
string
A QR-kód címében keres. A 2 karakternél hosszabb lekérdezések a tárolt
data értékében is keresnek. Link típusoknál a tárolt data a rövid link, ezért a cél-URL-ekre nem lehet keresni.string
alapértelmezett:"createdAt"
A rendezés mezője:
createdAt, updatedAt, clicks (összes beolvasás), lastClicked (legutóbbi beolvasás) vagy type. A type mindig csökkenő sorrendbe rendez, és figyelmen kívül hagyja a sortOrder paramétert.string
alapértelmezett:"desc"
A rendezés iránya:
asc vagy desc.boolean
alapértelmezett:"false"
A szüneteltetett QR-kódokat is visszaadja.
boolean
alapértelmezett:"false"
Csak a szüneteltetett QR-kódokat adja vissza. Felülírja a
showArchived paramétert.true vagy a false karakterláncot fogadják. Kérje le a következő oldalt, amíg a pagination.hasMore értéke true. Lásd: Lapozás.
QR-kód létrehozása
POST /api/v1/qrs
Egyszerre hozza létre a QR-kódot és a rövid linkjét. 201 Created kóddal válaszol, és visszaadja az új QR-kódot.
string
Saját újrapróbálkozási token. Ha 24 órán belül ugyanazzal a kulccsal ismétli meg a kérést, az eredeti választ kapja vissza, és nem jön létre második QR-kód. Lásd: Újrapróbálkozások és duplikátumok.
string
kötelező
Mit kódol a QR-kód. Ez határozza meg a
data kötelező formátumát is. Lehetséges értékek: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.string
kötelező
A típus tartalma, amelyet a rendszer a
qrType alapján ellenőriz. Üres karakterlánc esetén az ellenőrzés kimarad. Az egyes típusok formátumát lásd: QR-kód-adatok típusonként.object
A rövid link, amelyen keresztül a QR-kód a célhoz vezet. Opcionális: ha elhagyja, a
link.url a data értékét követi.string
A QR-kód neve, amely az irányítópulton jelenik meg. A szélső szóközök levágása után 1–40 karakter. Ha elhagyja, a QR-kód cím nélkül marad.
string
Szabad szöveges megjegyzés a QR-kódhoz. Legfeljebb 280 karakter.
string
Egy
pdf, image vagy video QR-kód fájlja, a megfelelő céllal feltöltve. A vcard, social és multilink típusnál opcionális profilkép, logo céllal feltöltve. Az event is elfogadja, de az oldala a borítóképet a data.fileId mezőből olvassa. Más típusok 422 hibát kapnak. Előbb töltse fel a fájlt a Fájlok végponttal. Lásd: Fájlok a QR-kódokban.string
A sablon, amelynek dizájnja az új QR-kódra kerül. Az elküldött dizájnmezők erre olvadnak rá. Branded vagy AI dizájnú sablon esetén
422 (art_template_unsupported) a válasz. Ismeretlen vagy más munkaterülethez tartozó sablon esetén 404.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
Logó középen: javasolt logó vagy saját,
logo céllal feltöltött fájl. Az ismeretlen fájlt, a befejezetlen feltöltést vagy a más célhoz feltöltött fájlt a rendszer elutasítja. Lásd: Testreszabás.object
Ütemezés, beolvasási korlát és jelszavas védelem. Lásd: Hozzáférési szabályok.
boolean
Szünetel-e a QR-kód. A
true szüneteltetett állapotban hozza létre: a beolvasások a cél helyett a szüneteltetési oldalt mutatják.Újrapróbálkozások és duplikátumok
- Kulccsal.
Idempotency-Keyfejléccel a válasz 24 órán át újra visszaadható. - Kulcs nélkül. A 30 másodpercen belül elküldött azonos törzset a rendszer duplikátumnak tekinti.
- Ismételt válaszok. Az ismételt válasz a tárolt választ adja vissza,
x-idempotent-replay: trueértékkel. Egy új QR-kódfalseértéket ad. - Folyamatban. Ha egy második kérés érkezik, miközben az első még fut,
409 conflicta válasz. - Hibák. A sikertelen létrehozás azonnal felszabadítja a kulcsot, így ugyanazzal a kulccsal újra próbálkozhat.
- Nem garantált. Ha a védelem nem érhető el, a létrehozás védelem nélkül megy végbe.
QR-kód lekérése
GET /api/v1/qrs/{qrId}
Egy QR-kódot ad vissza a rövid linkjével, hozzáférési szabályaival, dizájnjával és – fájlalapú típusoknál – a fájljával.
string
kötelező
A QR-kód azonosítója, a lista vagy a létrehozás válaszából.
QR-kód frissítése
PATCH /api/v1/qrs/{qrId}
Módosítja a QR-kód tartalmát, célját, dizájnját vagy hozzáférési szabályait. Csak a módosítani kívánt mezőket küldje el. A frissített QR-kóddal válaszol.
string
kötelező
A QR-kód azonosítója.
templateId. Nem elfogadott.link. Részleges. Ha elhagyja alink.urlmezőt, a jelenlegi cél megmarad. Alink.domainés alink.key422hibát kap: a kinyomtatott kód a rövid linket kódolja, ezért más rövid linkhez hozzon létre új QR-kódot.data. A rendszer csak akkor ellenőrzi az eredményül kapott típus alapján, ha adatavagy aqrTypeváltozik. AqrTypemegfelelődatanélküli váltását a rendszer elutasítja. Lásd: Típusváltás.- Dizájn. A
styles,frameOptionséslogoOptionsobjektum a tárolt dizájnba olvad, így egy részleges objektum csak azt módosítja, amit megnevez. Másik logó választásakor az lecseréli a régit, de a mérete megmarad. access. Minden kulcs akkor érvényesül, ha jelen van. Anulltörli az adott szabályt. A hozzáférési szabályok azaccessalá tartoznak: ha alinkalatt küldi őket,422hibát kap.archived. A QR-kódot és a rövid linkjét együtt szünetelteti vagy aktiválja újra, ahogy a szüneteltetés és az újraaktiválás.
A szüneteltetett állapot beállítása
PUT /api/v1/qrs/{qrId}
Közvetlenül beállítja a szüneteltetett állapotot. A szüneteltetés és az újraaktiválás ugyanezt teszi, és egyértelműbben olvasható.
string
kötelező
A QR-kód azonosítója.
boolean
kötelező
true a QR-kód szüneteltetéséhez, false az újraaktiválásához.QR-kód szüneteltetése
POST /api/v1/qrs/{qrId}/pause
Megállítja, hogy a QR-kód a céljához vezessen: a beolvasások helyette a szüneteltetési oldalt mutatják. A kinyomtatott kód és a rövid linkje érvényes marad. Nincs kéréstörzs.
string
kötelező
A QR-kód azonosítója.
QR-kód újraaktiválása
POST /api/v1/qrs/{qrId}/activate
Egy szüneteltetett QR-kódot ismét a céljához vezet. Az ütemezés és a beolvasási korlát továbbra is érvényes. Nincs kéréstörzs.
string
kötelező
A QR-kód azonosítója.
QR-kód másolása
POST /api/v1/qrs/{qrId}/duplicate
Másolatot készít ugyanazzal a tartalommal és dizájnnal. Nincs kéréstörzs. 201 Created kóddal válaszol, és visszaadja az új QR-kódot.
string
kötelező
A másolandó QR-kód azonosítója.
- Rövid link. A másolat saját rövid linket kap, véletlenszerű azonosítóval a munkaterület alapértelmezett domainjén, nem az eredeti domainjén. A beolvasásait a rendszer külön számolja.
- Cím. A cím
(Copy)utótagot kap. Az eredmény legfeljebb 40 karakter: a hosszú címet a rendszer előbb lerövidíti. A cím nélküli QR-kód cím nélkül marad. - Nem másolódik. A hozzáférési szabályok (jelszó, ütemezés, beolvasási korlát) és a szüneteltetett állapot. A másolat mindig aktív.
- Fájlok. A PDF- és képfájlok – a csomagok és galériák fájljait is beleértve – átmásolódnak, így a másolathoz tartoznak. A videófájlok és a dizájnfájlok, például a logók, közösek az eredetivel.
QR-kód törlése
DELETE /api/v1/qrs/{qrId}
Törli a QR-kódot és a rövid linkjét. A törölt azonosítóval válaszol.
string
kötelező
A QR-kód azonosítója.
string
A törölt QR-kód azonosítója.
boolean
Mindig
true.QR-kód képének letöltése
GET /api/v1/qrs/{qrId}/download
Elkészíti a QR-kód képét a dizájnjával, és visszaadja a fájlt.
string
kötelező
Az elkészítendő QR-kód azonosítója, a lista vagy a létrehozás válaszából.
string
alapértelmezett:"jpg"
Kimeneti formátum:
jpg, png, svg, pdf (egy A4-es oldal) vagy eps. Branded vagy AI dizájn csak jpg, png vagy pdf formátumban tölthető le.integer
alapértelmezett:"1024"
A kép mérete pixelben:
1024, 2048 vagy 4096. Az svg és a pdf figyelmen kívül hagyja. Branded vagy AI dizájn csak 1024 méretben tölthető le.- Törzs. A válasz törzse maga a fájl. A javasolt fájlnév a
Content-Dispositionfejlécben található; a címből képződik, cím nélküli QR-kódnálqr-code. - Gyorsítótárazás. A válaszok
ETagésCache-Control: private, max-age=3600, must-revalidatefejlécet tartalmaznak. Küldje vissza azETagértékét azIf-None-Matchfejlécben, és304 Not Modifiedválaszt kap, ha a QR-kód nem változott. - Hibák. A nem támogatott formátum vagy felbontás
400 bad_requesthibát kap. A hibaüzenet megnevezi az okot:qr_download_invalid_format,qr_download_invalid_resolution,qr_download_art_format_unsupportedvagyqr_download_art_resolution_unsupported.
Hozzáférési szabályok
Küldjön egyaccess objektumot létrehozáskor vagy frissítéskor, hogy kezdést és befejezést ütemezzen, korlátozza a beolvasások számát, vagy jelszót követeljen meg. Az elhagyott szabályok változatlanok maradnak, a null pedig törli az adott szabályt. A teljes működést példákkal a Hozzáférési szabályok oldal írja le.
Dizájnobjektumok
Astyles, frameOptions és logoOptions a pont- és sarokformákat, a színeket, a keretet és a logót állítja be. Ugyanúgy működnek a QR-kódoknál, a sablonoknál és a tömeges létrehozásnál. Az ismeretlen formákat, kereteket vagy logókat a rendszer elutasítja. Az összes elfogadott értéket és egy kidolgozott példát a Testreszabás oldalon talál.
Gyakori problémák
422-es hiba jelszó, ütemezés vagy beolvasási korlát beállításakor
422-es hiba jelszó, ütemezés vagy beolvasási korlát beállításakor
A szabályt az
access alatt küldje, ne a link alatt.422-es hiba a link.domain vagy a link.key módosításakor
422-es hiba a link.domain vagy a link.key módosításakor
A rövid link létrehozás után nem módosítható, mert a kinyomtatott kód azt kódolja. Hozzon létre helyette új QR-kódot.
422 "Expected … for qrType"
422 "Expected … for qrType"
A
data nem felel meg a qrType formátumának. Ellenőrizze a típust a QR-kód-adatok típusonként oldalon.409 conflict QR-kód létrehozásakor
409 conflict QR-kód létrehozásakor
Egy azonos létrehozás még fut, vagy a
link.key foglalt. Próbálja újra, miután az első kérés befejeződött. Idempotency-Key használatakor az újrapróbálkozás az eredeti QR-kódot adja vissza.A letöltés JPEG, nem PNG
A letöltés JPEG, nem PNG
A paraméterek neve
format és resolution, és a format alapértéke jpg. Küldje el a format=png paramétert.404-es hiba egy QR-kódra, amelyet látok az irányítópulton
404-es hiba egy QR-kódra, amelyet látok az irányítópulton
Minden kérés az API-kulcs munkaterületében fut. Ellenőrizze, hogy a QR-kód ehhez a munkaterülethez tartozik-e. Lásd: Hitelesítés.