Spring til hovedindhold
GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
En bulk-oprettelse gør en liste med navne og URL’er til website-QR-koder med ét fælles design. Den kører i baggrunden: Start den, følg fremskridtet, og download derefter ZIP-arkivet.

Sådan fungerer det

1

Start bulk-oprettelsen

Send dine rækker med Opret fra JSON eller Opret fra en CSV-fil. API’et svarer 202 med bulk-oprettelsen og dens id.
2

Følg fremskridtet

Kald Hent en bulk-oprettelse med få sekunders mellemrum, indtil status er completed eller failed.
3

Download arkivet

Når status er completed, kalder du Download arkivet for at få en ZIP med QR-kodebillederne.
  • Grænse. Op til 100 rækker pr. bulk-oprettelse.
  • Én ad gangen. Der kører kun én bulk-oprettelse pr. arbejdsområde. Starter du en ny, mens en kører, returneres den, der kører.
  • Idempotens. Hver forespørgsel kræver en idempotencyKey. Gentager du en forespørgsel med samme nøgle og samme body, returneres den bulk-oprettelse, der allerede er startet. Samme nøgle med en anden body returnerer 422.
  • Rækker. Hver række skal have et name og en url. Se Rækker.
  • Abonnement. Bulk-oprettelse er ikke tilgængelig på Single QR-abonnementet: Forespørgslen returnerer 403 exceeded_limit.

Rækker

  • Navn. Bliver QR-kodens titel. Trimmes og afkortes til 40 tegn. Gentagne navne (uden hensyn til store og små bogstaver) får et nummer: Menu, Menu 2, Menu 3.
  • URL. Bliver destinationen. Den skal være en http- eller https-adresse med et rigtigt domæne, f.eks. example.com/menu, og må ikke indeholde mellemrum. En URL uden skema får https://.
  • Tomme rækker. Rækker uden både navn og URL springes over. En række med kun det ene afvises.
Alle QR-koder er website-QR-koder på et kortlink. Se QR-kodedata efter type.

Headere

string
påkrævet
Bearer efterfulgt af din API-nøgle. Se Godkendelse.
string
application/json til Opret fra JSON, multipart/form-data til Opret fra en CSV-fil.

Objektet for en bulk-oprettelse

string
Bulk-oprettelsens id, f.eks. cm2k7x9qb0003ax8eb4f6gh2t.
string
queued, processing, packaging eller completed. En mislykket eller afbrudt bulk-oprettelse går via rollingBack til failed.
string
Kildefilens navn.
integer
Antal rækker.
integer
QR-koder oprettet indtil nu.
integer
QR-kodebilleder renderet indtil nu.
integer
Samlet fremskridt, 0 til 100. Oprettelse går op til 40, rendering op til 90, pakning er 95, og completed er 100.
boolean
true, når en igangværende bulk-oprettelse ikke har gjort fremskridt i 2 minutter. Bliv ved med at spørge: Hent en bulk-oprettelse genstarter en bulk-oprettelse, der står stille.
object | null
Når status er failed: code og message. En afbrudt bulk-oprettelse har koden cancelled_by_user. En mislykket bulk-oprettelse rulles tilbage, så ingen af dens QR-koder bevares.
string | null
Stien til Download arkivet, når status er completed.
string
Startdato, ISO 8601.
string
Dato for seneste opdatering, ISO 8601.
string | null
Dato for afslutning, ISO 8601.
string | null
Dato for fejl, ISO 8601.

Hent den aktuelle bulk-oprettelse

GET /api/v1/bulk-qr-creations Returnerer den bulk-oprettelse, der stadig kører i dit arbejdsområde. Når ingen kører, returneres den senest afsluttede (completed eller failed), indtil den er afvist: Det sker, når du downloader dens arkiv eller afviser den i dashboardet. Ellers returneres null. Brug den til at genoptage overvågningen efter en genstart.

Opret fra JSON

POST /api/v1/bulk-qr-creations Starter en bulk-oprettelse ud fra en liste med rækker. Svarer 202 Accepted. Bulk-oprettelsen kører i baggrunden.
object[]
påkrævet
QR-koder, der skal oprettes, op til 100. Hver række er { "name": "...", "url": "..." } og tager ingen andre felter. Se Rækker.
object
påkrævet
Design, der anvendes på alle QR-koder: styles, frameOptions og logoOptions, alle valgfri. Send {} for standarddesignet. Andre felter afvises. Se Tilpasning.
string
påkrævet
Navn, der vises i dashboardet og bruges til arkivet, 1 til 255 tegn.
string
påkrævet
Din egen nøgle til denne bulk-oprettelse, 8 til 100 tegn.

Opret fra en CSV-fil

POST /api/v1/bulk-qr-creations/csv Det samme som Opret fra JSON, men tager rækkerne som en CSV-fil sendt som multipart/form-data. Svarer 202 Accepted. Filen skal være en .csv på højst 1.000.000 bytes. Dens overskriftsrække skal være præcis name,url efterfulgt af op til 100 datarækker. Se CSV-format.
file
påkrævet
CSV-filen.
string
påkrævet
Designobjektet serialiseret som JSON, f.eks. {"styles":{"dotsOptions":{"type":"rounded"}}}. Send {} for standarddesignet.
string
påkrævet
Din egen nøgle til denne bulk-oprettelse, 8 til 100 tegn.
string
Navn, der vises i dashboardet og bruges til arkivet, op til 255 tegn. Standard er navnet på den uploadede fil.

Hent en bulk-oprettelse

GET /api/v1/bulk-qr-creations/{id} Returnerer status og fremskridt for en bulk-oprettelse. Spørg løbende, så længe status er queued, processing eller packaging. downloadUrl vises, når arkivet er klar.
string
påkrævet
Bulk-oprettelsens id. Hent det fra svaret på oprettelsen eller på den aktuelle bulk-oprettelse.

Afbryd en bulk-oprettelse

DELETE /api/v1/bulk-qr-creations/{id} Stopper en igangværende bulk-oprettelse og sletter de QR-koder, den allerede har oprettet. Tilbagerulningen sker under forespørgslen, så svaret normalt har status failed og error.code cancelled_by_user. Afbryder du en bulk-oprettelse, der allerede er mislykket, returneres den uændret.
En bulk-oprettelse, der er gennemført, kan ikke afbrydes: Forespørgslen returnerer 400. Slet i stedet dens QR-koder én ad gangen med QR-koder.
string
påkrævet
Bulk-oprettelsens id.

Download arkivet

GET /api/v1/bulk-qr-creations/{id}/download Returnerer et ZIP-arkiv med én JPEG på 1024 px pr. QR-kode, navngivet efter dens række: 001-Menu.jpg, 002-Wine list.jpg og så videre. Arkivet er navngivet efter sourceFilename. Tilgængeligt, når status er completed. Downloaden afviser bulk-oprettelsen, så Hent den aktuelle bulk-oprettelse holder op med at returnere den.
string
påkrævet
Bulk-oprettelsens id.

Almindelige problemer

Beskeden nævner rækken. Hver URL skal være en http- eller https-adresse med et rigtigt domæne, f.eks. example.com/menu. Ret rækken, og send forespørgslen igen.
CSV-filens første række skal være name,url i den rækkefølge og med små bogstaver, uden andre kolonner.
Nøgler kan ikke genbruges til en anden batch. Send en ny idempotencyKey.
Bulk-oprettelsen er ikke gennemført endnu. Bliv ved med at spørge, indtil status er completed.
Bulk-oprettelsen er allerede gennemført, så den kan ikke rulles tilbage.
Dit arbejdsområde er på Single QR-abonnementet, som ikke omfatter bulk-oprettelse. Opgrader abonnementet.
En anden bulk-oprettelse kører stadig i dit arbejdsområde, eller du har genbrugt en idempotencyKey. Vent, til den er færdig, eller brug en ny nøgle.

Næste skridt

Tilpasning

QR-koder

Bulk-oprettelse i appen

CSV-format