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.
Hogyan működik
1
Indítsa el a tömeges létrehozást
Küldje el a sorokat a Létrehozás JSON-ból vagy a Létrehozás CSV-fájlból végponttal. Az API
202 kóddal válaszol, és visszaadja a tömeges létrehozást az id értékével.2
Kövesse az előrehaladást
Hívja a Tömeges létrehozás lekérése végpontot néhány másodpercenként, amíg a
status értéke completed vagy failed nem lesz.3
Töltse le az archívumot
Ha a
status értéke completed, hívja Az archívum letöltése végpontot, és megkapja a QR-kód-képek ZIP-fájlját.- Korlát. Tömeges létrehozásonként legfeljebb 100 sor.
- Egyszerre egy. Munkaterületenként egyszerre csak egy tömeges létrehozás futhat. Ha egy futó mellett újat indít, a futót kapja vissza.
- Idempotencia. Minden kéréshez
idempotencyKeyszükséges. Ha ugyanazzal a kulccsal és ugyanazzal a törzzsel ismétli meg a kérést, a már elindított tömeges létrehozást kapja vissza. Ugyanaz a kulcs más törzzsel422választ ad. - Sorok. Minden sorhoz
nameésurlszükséges. Lásd: Sorok. - Csomag. A tömeges létrehozás a Single QR csomagban nem érhető el: a kérés
403 exceeded_limitválaszt ad.
Sorok
- Név. Ebből lesz a QR-kód címe. A szélső szóközök levágása után 40 karakterre rövidül. Az ismétlődő nevek (kis- és nagybetűtől függetlenül) sorszámot kapnak:
Menu,Menu 2,Menu 3. - URL. Ebből lesz a cél.
httpvagyhttpscímnek kell lennie valódi domainnel, példáulexample.com/menu, és nem tartalmazhat szóközt. A séma nélküli URLhttps://előtagot kap. - Üres sorok. Azokat a sorokat, amelyekben sem név, sem URL nincs, a rendszer kihagyja. Ha csak az egyik szerepel, a sort elutasítja.
website QR-kód. Lásd: QR-típusok.
Fejlécek
string
kötelező
Bearer, majd az API-kulcsa. Lásd: Hitelesítés.string
application/json a Létrehozás JSON-ból, multipart/form-data a Létrehozás CSV-fájlból végponthoz.A tömeges létrehozás objektum
string
A tömeges létrehozás azonosítója, például
cm2k7x9qb0003ax8eb4f6gh2t.string
queued, processing, packaging vagy completed. Egy sikertelen vagy megszakított tömeges létrehozás a rollingBack állapoton át failed állapotba kerül.string
A forrásfájl neve.
integer
A sorok száma.
integer
Az eddig létrehozott QR-kódok száma.
integer
Az eddig elkészített QR-kód-képek száma.
integer
Teljes előrehaladás, 0 és 100 között. A létrehozás 40-ig, a képek elkészítése 90-ig tart, a csomagolás 95, a
completed pedig 100.boolean
true, ha egy futó tömeges létrehozás 2 perce nem halad előre. Folytassa a lekérdezést: a Tömeges létrehozás lekérése újraindítja az elakadt tömeges létrehozást.object | null
Ha a
status értéke failed: code és message. Egy megszakított tömeges létrehozás kódja cancelled_by_user. A sikertelen tömeges létrehozást a rendszer visszagörgeti, így egyetlen QR-kódja sem marad meg.string | null
Az archívum letöltése végpont útvonala, amint a
status értéke completed.string
Az indítás dátuma, ISO 8601.
string
Utolsó frissítés dátuma, ISO 8601.
string | null
A befejezés dátuma, ISO 8601.
string | null
A sikertelenség dátuma, ISO 8601.
Az aktuális tömeges létrehozás lekérése
GET /api/v1/bulk-qr-creations
A munkaterületen még futó tömeges létrehozást adja vissza. Ha nincs futó, a legutóbb befejezettet (completed vagy failed) adja vissza, amíg el nem vetik: ezt az archívum letöltése vagy az irányítópulton való elvetés teszi meg. Egyébként null értéket ad vissza. Újraindítás után ezzel folytathatja a követést.
Létrehozás JSON-ból
POST /api/v1/bulk-qr-creations
Tömeges létrehozást indít egy sorlistából. 202 Accepted kóddal válaszol. A tömeges létrehozás a háttérben fut.
object[]
kötelező
A létrehozandó QR-kódok, legfeljebb 100. Minden sor
{ "name": "...", "url": "..." } alakú, és más mezőt nem fogad. Lásd: Sorok.object
kötelező
Minden QR-kódra alkalmazott dizájn:
styles, frameOptions és logoOptions, mindegyik opcionális. Az alapértelmezett dizájnhoz küldjön {} értéket. Más mezőket a rendszer elutasít. Lásd: Testreszabás.string
kötelező
Az irányítópulton megjelenő és az archívumhoz használt név, 1–255 karakter.
string
kötelező
Saját kulcs ehhez a tömeges létrehozáshoz, 8–100 karakter.
Létrehozás CSV-fájlból
POST /api/v1/bulk-qr-creations/csv
Ugyanaz, mint a Létrehozás JSON-ból, de a sorokat multipart/form-data formátumban küldött CSV-fájlként fogadja. 202 Accepted kóddal válaszol.
A fájlnak legfeljebb 1 000 000 bájtos .csv fájlnak kell lennie. A fejlécsornak pontosan name,url értékűnek kell lennie, utána legfeljebb 100 adatsor következhet. Lásd: CSV-formátum.
file
kötelező
A CSV-fájl.
string
kötelező
A dizájnobjektum JSON-ként szerializálva, például
{"styles":{"dotsOptions":{"type":"rounded"}}}. Az alapértelmezett dizájnhoz küldjön {} értéket.string
kötelező
Saját kulcs ehhez a tömeges létrehozáshoz, 8–100 karakter.
string
Az irányítópulton megjelenő és az archívumhoz használt név, legfeljebb 255 karakter. Alapértelmezés: a feltöltött fájl neve.
Tömeges létrehozás lekérése
GET /api/v1/bulk-qr-creations/{id}
Egy tömeges létrehozás állapotát és előrehaladását adja vissza. Kérdezze le rendszeresen, amíg a status értéke queued, processing vagy packaging. A downloadUrl akkor jelenik meg, amikor az archívum elkészült.
string
kötelező
A tömeges létrehozás azonosítója. A létrehozás vagy az aktuális tömeges létrehozás válaszából veheti.
Tömeges létrehozás megszakítása
DELETE /api/v1/bulk-qr-creations/{id}
Leállít egy futó tömeges létrehozást, és törli az általa már létrehozott QR-kódokat. A visszagörgetés a kérés alatt fut, így a válaszban általában a status értéke failed, az error.code értéke pedig cancelled_by_user. Egy már sikertelen tömeges létrehozás megszakítása változatlanul adja vissza azt.
string
kötelező
A tömeges létrehozás azonosítója.
Az archívum letöltése
GET /api/v1/bulk-qr-creations/{id}/download
Egy ZIP-archívumot ad vissza, QR-kódonként egy 1024 px-es JPEG-képpel, a sor nevével elnevezve: 001-Menu.jpg, 002-Wine list.jpg és így tovább. Az archívum neve a sourceFilename értékéből képződik. Akkor érhető el, amikor a status értéke completed. A letöltés elveti a tömeges létrehozást, így Az aktuális tömeges létrehozás lekérése többé nem adja vissza.
string
kötelező
A tömeges létrehozás azonosítója.
Gyakori problémák
422-es hiba „contains an invalid HTTP(S) URL” üzenettel
422-es hiba „contains an invalid HTTP(S) URL” üzenettel
Az üzenet megnevezi a sort. Minden URL-nek
http vagy https címnek kell lennie valódi domainnel, például example.com/menu. Javítsa a sort, és küldje el újra a kérést.422 "CSV headers must be exactly: name,url."
422 "CSV headers must be exactly: name,url."
A CSV első sorának
name,url értékűnek kell lennie, ebben a sorrendben, kisbetűvel, további oszlopok nélkül.422 "This idempotencyKey was already used with a different request body."
422 "This idempotencyKey was already used with a different request body."
A kulcsok nem használhatók újra egy másik kötegnél. Küldjön új
idempotencyKey értéket.409 "The bulk QR archive is not ready for download."
409 "The bulk QR archive is not ready for download."
A tömeges létrehozás még nem fejeződött be. Folytassa a lekérdezést, amíg a
status értéke completed nem lesz.400 "Cannot cancel a finished bulk QR creation."
400 "Cannot cancel a finished bulk QR creation."
A tömeges létrehozás már befejeződött, így nem görgethető vissza.
403 exceeded_limit
403 exceeded_limit
A munkaterülete a Single QR csomagot használja, amely nem tartalmazza a tömeges létrehozást. Váltson magasabb csomagra.
Új helyett egy régebbi tömeges létrehozást kaptam vissza
Új helyett egy régebbi tömeges létrehozást kaptam vissza
A munkaterületen még fut egy másik tömeges létrehozás, vagy újra felhasznált egy
idempotencyKey értéket. Várja meg, amíg befejeződik, vagy használjon új kulcsot.