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.
GetQR API’et er et REST API til det, du gør i dashboardet: opret og opdater QR-koder, download deres billeder, læs scanningsstatistik og eksportér rapporter. Du godkender med din kontos API-nøgle og kalder versionerede endepunkter under /api/v1.

Hvad du kan gøre

QR-koder

Opret, vis, opdater, sæt på pause, duplikér, slet og download QR-koder.

Statistik

Samlede scanninger og opdelinger for én QR-kode eller hele arbejdsområdet.

Rapporter

Eksportér en enkeltstående rapport, eller planlæg tilbagevendende rapportmails.

Skabeloner

Gem designs, og anvend dem på nye QR-koder.

Bulk-oprettelse af QR-koder

Opret op til 100 QR-koder på én gang fra JSON eller en CSV-fil.

Filer

Upload PDF’er, billeder, videoer og logoer til dine QR-koder.

Statustjek

Tjek, at API’et kører. Kræver ingen API-nøgle.

Vejledninger

QR-kodedata efter type

Dataformatet for hver af de 16 QR-typer.

Tilpasning

Prikformer, hjørner, farver, rammer og logoer.

Adgangsregler

Tidsplaner, scanningsgrænser, adgangskoder, pause og sletning.

Basis-URL

Alle endepunkter ligger under én basis-URL:

Versionering

API-versionen er en del af stien: alle endepunkter ligger under /api/v1/.
  • Ændringer, der bryder kompatibiliteten, udgives under et nyt versionspræfiks som /api/v2/, og /api/v1/ fortsætter med at virke.
  • Tilføjelser, f.eks. nye valgfrie felter eller nye endepunkter, kan komme inden for v1. Ignorer felter i svaret, som din kode ikke kender.

Kom hurtigt i gang

1

Hent din API-nøgle

Generér eller vis din nøgle i dine kontoindstillinger. Se Godkendelse.
2

Tjek, at API'et kan nås

Svaret er { "status": "ok", "version": "v1" }.
3

Opret din første QR-kode

API’et svarer 201 med den nye QR-kode, inklusive dens id og shortLink.
4

Download billedet

Forespørgsler og svar

  • Format. Send forespørgslens body som JSON med Content-Type: application/json. Undtagelsen er CSV-uploaden til bulk-oprettelse, som bruger multipart/form-data.
  • Svar. Svar er JSON. Downloads, f.eks. QR-billeder og ZIP-arkiver fra bulk-oprettelse, returnerer selve filen.
  • Datoer. Datoer er ISO 8601-strenge i UTC, f.eks. 2026-08-01T10:00:00.000Z.
  • Forespørgselsparametre. Booleske parametre tager strengene true eller false.
  • Delvise opdateringer. PATCH-endepunkter ændrer kun de felter, du sender.
  • Hemmeligheder. Svar indeholder aldrig adgangskoder eller interne id’er. En adgangskodebeskyttet QR-kode viser kun passwordProtected: true.
  • Arbejdsområde. Hver forespørgsel kører i det arbejdsområde, din API-nøgle hører til. Du angiver ikke et arbejdsområde-id. Se Adgang og roller.
  • Fejl. Mislykkede forespørgsler returnerer et error-objekt med en stabil code. Se Fejl.

Paginering

Listeendepunkter (QR-koder, skabeloner og planlagte rapporter) tager to forespørgselsparametre: De svarer med et data-array og et pagination-objekt:
Hent næste side, så længe hasMore er true. En pageSize over 100 returnerer 422.

Idempotens

En netværksfejl kan gøre dig i tvivl om, hvorvidt en forespørgsel gik igennem. For at prøve Opret en QR-kode igen uden risiko skal du sende en Idempotency-Key-header med en unik værdi, du selv vælger:
  • Gentager du forespørgslen med samme nøgle inden for 24 timer, returneres det oprindelige svar i stedet for at oprette en QR-kode mere.
  • Svarheaderen x-idempotent-replay er true for et gentaget svar og false for et nyt.
  • Hvis den første forespørgsel med nøglen stadig kører, svarer API’et 409 conflict. Prøv igen, når den er færdig.
  • Genbruger du en nøgle med en anden body, svarer API’et 422 unprocessable_entity.
  • Uden headeren behandles en identisk body, der sendes inden for 30 sekunder, som en dublet.
Bulk-oprettelser tager i stedet et idempotencyKey-felt i forespørgslens body. Se Bulk-oprettelse af QR-koder.

Hastighedsgrænser

Hver API-nøgle kan sende op til 600 forespørgsler pr. minut. Se Hastighedsgrænser.

Kommer senere

Trykklare pakker er planlagt til en senere version.

Næste skridt

Godkendelse

QR-koder