GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
Så fungerar det
1
Starta massskapandet
Skicka dina rader med Skapa från JSON eller Skapa från en CSV-fil. API:et svarar
202 med massskapandet och dess id.2
Följ förloppet
Anropa Hämta ett massskapande med några sekunders mellanrum tills
status är completed eller failed.3
Ladda ned arkivet
När
status är completed anropar du Ladda ned arkivet för att få en ZIP-fil med QR-kodbilderna.- Gräns. Högst 100 rader per massskapande.
- Ett i taget. Bara ett massskapande körs per arbetsyta. Om du startar ett till medan ett körs returneras det som körs.
- Idempotens. Varje begäran behöver en
idempotencyKey. Om du upprepar en begäran med samma nyckel och samma body returneras massskapandet som redan har startats. Samma nyckel med en annan body returnerar422. - Rader. Varje rad behöver ett
nameoch enurl. Se Rader. - Abonnemang. Massskapande finns inte på abonnemanget Single QR: begäran returnerar
403 exceeded_limit.
Rader
- Namn. Blir QR-kodens titel. Trimmas och kortas till 40 tecken. Upprepade namn (oavsett skiftläge) får ett nummer:
Menu,Menu 2,Menu 3. - URL. Blir målet. Den måste vara en
http- ellerhttps-adress med en riktig domän, somexample.com/menu, och får inte innehålla mellanslag. En URL utan schema fårhttps://. - Tomma rader. Rader som saknar både namn och URL hoppas över. En rad med bara det ena av dem avvisas.
website-QR-kod med en kort länk. Se QR-typer.
Huvuden
string
obligatorisk
Bearer följt av din API-nyckel. Se Autentisering.string
application/json för Skapa från JSON, multipart/form-data för Skapa från en CSV-fil.Objektet för massskapande
string
Massskapandets id, till exempel
cm2k7x9qb0003ax8eb4f6gh2t.string
queued, processing, packaging eller completed. Ett misslyckat eller avbrutet massskapande går via rollingBack till failed.string
Källfilens namn.
integer
Antal rader.
integer
QR-koder som har skapats hittills.
integer
QR-kodbilder som har renderats hittills.
integer
Totalt förlopp, 0 till 100. Skapandet tar upp till 40, renderingen upp till 90, paketeringen är 95 och
completed är 100.boolean
true när ett pågående massskapande inte har gjort framsteg på 2 minuter. Fortsätt att fråga: Hämta ett massskapande startar om ett massskapande som har stannat.object | null
När
status är failed: code och message. Ett avbrutet massskapande har koden cancelled_by_user. Ett misslyckat massskapande rullas tillbaka, så ingen av dess QR-koder behålls.string | null
Sökvägen till Ladda ned arkivet, när
status är completed.string
Startdatum, ISO 8601.
string
Datum för senaste uppdatering, ISO 8601.
string | null
Datum då det slutfördes, ISO 8601.
string | null
Datum då det misslyckades, ISO 8601.
Hämta det aktuella massskapandet
GET /api/v1/bulk-qr-creations
Returnerar det massskapande som fortfarande körs i din arbetsyta. När inget körs returneras det senast avslutade (completed eller failed) tills det har stängts: det gör du genom att ladda ned dess arkiv eller stänga det i instrumentpanelen. Annars returneras null. Använd det för att återuppta bevakningen efter en omstart.
Skapa från JSON
POST /api/v1/bulk-qr-creations
Startar ett massskapande från en lista med rader. Svarar 202 Accepted. Massskapandet körs i bakgrunden.
object[]
obligatorisk
QR-koder som ska skapas, högst 100. Varje rad är
{ "name": "...", "url": "..." } och tar inga andra fält. Se Rader.object
obligatorisk
Design som tillämpas på varje QR-kod:
styles, frameOptions och logoOptions, alla valfria. Skicka {} för standarddesignen. Andra fält avvisas. Se Anpassning.string
obligatorisk
Namn som visas i instrumentpanelen och används för arkivet, 1 till 255 tecken.
string
obligatorisk
Din egen nyckel för det här massskapandet, 8 till 100 tecken.
Skapa från en CSV-fil
POST /api/v1/bulk-qr-creations/csv
Samma som Skapa från JSON, men tar raderna som en CSV-fil som skickas som multipart/form-data. Svarar 202 Accepted.
Filen måste vara en .csv på högst 1 000 000 byte. Rubrikraden måste vara exakt name,url, följd av högst 100 datarader. Se CSV-format.
file
obligatorisk
CSV-filen.
string
obligatorisk
Designobjektet, serialiserat som JSON, till exempel
{"styles":{"dotsOptions":{"type":"rounded"}}}. Skicka {} för standarddesignen.string
obligatorisk
Din egen nyckel för det här massskapandet, 8 till 100 tecken.
string
Namn som visas i instrumentpanelen och används för arkivet, högst 255 tecken. Standard är namnet på den uppladdade filen.
Hämta ett massskapande
GET /api/v1/bulk-qr-creations/{id}
Returnerar status och förlopp för ett massskapande. Fråga regelbundet medan status är queued, processing eller packaging. downloadUrl visas när arkivet är klart.
string
obligatorisk
Massskapandets id. Hämta det från svaret när du skapar eller hämtar det aktuella massskapandet.
Avbryt ett massskapande
DELETE /api/v1/bulk-qr-creations/{id}
Stoppar ett pågående massskapande och tar bort de QR-koder som det redan har skapat. Återställningen körs under begäran, så svaret har normalt status failed och error.code cancelled_by_user. Om du avbryter ett massskapande som redan har misslyckats returneras det oförändrat.
string
obligatorisk
Massskapandets id.
Ladda ned arkivet
GET /api/v1/bulk-qr-creations/{id}/download
Returnerar ett ZIP-arkiv med en JPEG på 1024 px per QR-kod, namngiven efter sin rad: 001-Menu.jpg, 002-Wine list.jpg och så vidare. Arkivet namnges efter sourceFilename. Tillgängligt när status är completed. Nedladdningen stänger massskapandet, så Hämta det aktuella massskapandet slutar returnera det.
string
obligatorisk
Massskapandets id.
Vanliga problem
422 med "contains an invalid HTTP(S) URL"
422 med "contains an invalid HTTP(S) URL"
Meddelandet anger raden. Varje URL måste vara en
http- eller https-adress med en riktig domän, som example.com/menu. Rätta raden och skicka begäran igen.422 "CSV headers must be exactly: name,url."
422 "CSV headers must be exactly: name,url."
Den första raden i CSV-filen måste vara
name,url, i den ordningen och med gemener, utan andra kolumner.422 "This idempotencyKey was already used with a different request body."
422 "This idempotencyKey was already used with a different request body."
Nycklar kan inte återanvändas för en annan batch. Skicka en ny
idempotencyKey.409 "The bulk QR archive is not ready for download."
409 "The bulk QR archive is not ready for download."
Massskapandet är inte slutfört än. Fortsätt att fråga tills
status är completed.400 "Cannot cancel a finished bulk QR creation."
400 "Cannot cancel a finished bulk QR creation."
Massskapandet är redan slutfört, så det kan inte rullas tillbaka.
403 exceeded_limit
403 exceeded_limit
Din arbetsyta har abonnemanget Single QR, som inte omfattar massskapande. Uppgradera abonnemanget.
Jag fick tillbaka ett äldre massskapande i stället för ett nytt
Jag fick tillbaka ett äldre massskapande i stället för ett nytt
Ett annat massskapande körs fortfarande i din arbetsyta, eller så återanvände du en
idempotencyKey. Vänta tills det är klart, eller använd en ny nyckel.