GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
Slik fungerer det
1
Start masseopprettelsen
Send radene dine med Opprett fra JSON eller Opprett fra en CSV-fil. API-et svarer
202 med masseopprettelsen og id.2
Sjekk fremdriften
Kall Hent en masseopprettelse med noen sekunders mellomrom til
status er completed eller failed.3
Last ned arkivet
Når
status er completed, kaller du Last ned arkivet for å få en ZIP med QR-kodebildene.- Grense. Opptil 100 rader per masseopprettelse.
- Én om gangen. Bare én masseopprettelse kjører per arbeidsområde. Starter du en ny mens en kjører, returneres den som kjører.
- Idempotens. Hver forespørsel krever en
idempotencyKey. Gjentar du en forespørsel med samme nøkkel og samme body, returneres masseopprettelsen som allerede er startet. Samme nøkkel med en annen body returnerer422. - Rader. Hver rad trenger
nameogurl. Se Rader. - Abonnement. Masseopprettelse er ikke tilgjengelig på Single QR-abonnementet: forespørselen returnerer
403 exceeded_limit.
Rader
- Navn. Blir tittelen på QR-koden. Mellomrom i starten og slutten fjernes, og navnet kortes ned til 40 tegn. Gjentatte navn (uavhengig av store og små bokstaver) får et nummer:
Menu,Menu 2,Menu 3. - URL. Blir målet. Den må være en
http- ellerhttps-adresse med et ekte domene, for eksempelexample.com/menu, og kan ikke inneholde mellomrom. En URL uten skjema fårhttps://. - Tomme rader. Rader uten både navn og URL hoppes over. En rad med bare ett av dem avvises.
website-QR-kode med en kortlenke. Se QR-kodedata per type.
Headere
string
påkrevd
Bearer etterfulgt av API-nøkkelen din. Se Autentisering.string
application/json for Opprett fra JSON, multipart/form-data for Opprett fra en CSV-fil.Masseopprettelsesobjektet
string
ID-en til masseopprettelsen, for eksempel
cm2k7x9qb0003ax8eb4f6gh2t.string
queued, processing, packaging eller completed. En mislykket eller avbrutt masseopprettelse går via rollingBack til failed.string
Navnet på kildefilen.
integer
Antall rader.
integer
QR-koder opprettet så langt.
integer
QR-kodebilder gjengitt så langt.
integer
Samlet fremdrift, 0 til 100. Oppretting tar opptil 40, gjengivelse opptil 90, pakking er 95, og
completed er 100.boolean
true når en masseopprettelse som kjører, ikke har hatt fremdrift på 2 minutter. Fortsett å sjekke: Hent en masseopprettelse starter en masseopprettelse som har stoppet opp, på nytt.object | null
Når
status er failed: code og message. En avbrutt masseopprettelse har koden cancelled_by_user. En mislykket masseopprettelse rulles tilbake, så ingen av QR-kodene beholdes.string | null
Banen til Last ned arkivet, når
status er completed.string
Startdato, ISO 8601.
string
Dato for siste oppdatering, ISO 8601.
string | null
Dato for fullføring, ISO 8601.
string | null
Dato for feil, ISO 8601.
Hent den gjeldende masseopprettelsen
GET /api/v1/bulk-qr-creations
Returnerer masseopprettelsen som fortsatt kjører i arbeidsområdet ditt. Når ingen kjører, returneres den siste avsluttede (completed eller failed) til den er avvist: det skjer når du laster ned arkivet eller avviser den i dashbordet. Ellers returneres null. Bruk den til å fortsette sporingen etter en omstart.
Opprett fra JSON
POST /api/v1/bulk-qr-creations
Starter en masseopprettelse fra en liste med rader. Svarer 202 Accepted. Masseopprettelsen kjører i bakgrunnen.
object[]
påkrevd
QR-kodene som skal opprettes, opptil 100. Hver rad er
{ "name": "...", "url": "..." } og tar ingen andre felt. Se Rader.object
påkrevd
Designet som brukes på hver QR-kode:
styles, frameOptions og logoOptions, alle valgfrie. Send {} for standarddesignet. Andre felt avvises. Se Tilpasning.string
påkrevd
Navnet som vises i dashbordet og brukes for arkivet, 1 til 255 tegn.
string
påkrevd
Din egen nøkkel for denne masseopprettelsen, 8 til 100 tegn.
Opprett fra en CSV-fil
POST /api/v1/bulk-qr-creations/csv
Samme som Opprett fra JSON, men tar radene som en CSV-fil sendt som multipart/form-data. Svarer 202 Accepted.
Filen må være en .csv på maksimalt 1 000 000 byte. Overskriftsraden må være nøyaktig name,url, etterfulgt av opptil 100 datarader. Se CSV-format.
file
påkrevd
CSV-filen.
string
påkrevd
Designobjektet, serialisert som JSON, for eksempel
{"styles":{"dotsOptions":{"type":"rounded"}}}. Send {} for standarddesignet.string
påkrevd
Din egen nøkkel for denne masseopprettelsen, 8 til 100 tegn.
string
Navnet som vises i dashbordet og brukes for arkivet, opptil 255 tegn. Standard er navnet på den opplastede filen.
Hent en masseopprettelse
GET /api/v1/bulk-qr-creations/{id}
Returnerer status og fremdrift for en masseopprettelse. Sjekk den jevnlig så lenge status er queued, processing eller packaging. downloadUrl vises når arkivet er klart.
string
påkrevd
ID-en til masseopprettelsen. Hent den fra svaret på opprettelsen eller på forespørselen om den gjeldende masseopprettelsen.
Avbryt en masseopprettelse
DELETE /api/v1/bulk-qr-creations/{id}
Stopper en masseopprettelse som kjører, og sletter QR-kodene den allerede har opprettet. Tilbakerullingen skjer under forespørselen, så svaret har normalt status failed og error.code cancelled_by_user. Avbryter du en masseopprettelse som allerede har mislyktes, returneres den uendret.
string
påkrevd
ID-en til masseopprettelsen.
Last ned arkivet
GET /api/v1/bulk-qr-creations/{id}/download
Returnerer et ZIP-arkiv med én JPEG på 1024 px per QR-kode, med navn etter raden: 001-Menu.jpg, 002-Wine list.jpg og så videre. Arkivet får navn etter sourceFilename. Tilgjengelig når status er completed. Nedlastingen avviser masseopprettelsen, så Hent den gjeldende masseopprettelsen slutter å returnere den.
string
påkrevd
ID-en til masseopprettelsen.
Vanlige problemer
422 med "contains an invalid HTTP(S) URL"
422 med "contains an invalid HTTP(S) URL"
Meldingen navngir raden. Hver URL må være en
http- eller https-adresse med et ekte domene, for eksempel example.com/menu. Rett raden og send forespørselen på nytt.422 "CSV headers must be exactly: name,url."
422 "CSV headers must be exactly: name,url."
Den første raden i CSV-filen må være
name,url, i den rekkefølgen og med små bokstaver, uten andre kolonner.422 "This idempotencyKey was already used with a different request body."
422 "This idempotencyKey was already used with a different request body."
Nøkler kan ikke gjenbrukes for en annen bunt. Send en ny
idempotencyKey.409 "The bulk QR archive is not ready for download."
409 "The bulk QR archive is not ready for download."
Masseopprettelsen er ikke fullført ennå. Fortsett å sjekke til
status er completed.400 "Cannot cancel a finished bulk QR creation."
400 "Cannot cancel a finished bulk QR creation."
Masseopprettelsen er allerede fullført, så den kan ikke rulles tilbake.
403 exceeded_limit
403 exceeded_limit
Arbeidsområdet ditt har Single QR-abonnementet, som ikke inkluderer masseopprettelse. Oppgrader abonnementet.
Jeg fikk tilbake en eldre masseopprettelse i stedet for en ny
Jeg fikk tilbake en eldre masseopprettelse i stedet for en ny
En annen masseopprettelse kjører fortsatt i arbeidsområdet ditt, eller du har gjenbrukt en
idempotencyKey. Vent til den er ferdig, eller bruk en ny nøkkel.