Hopp til hovedinnhold
GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
GetQR API-et er et REST-API for det du gjør i dashbordet: opprett og oppdater QR-koder, last ned bildene deres, les skanneanalyse og eksporter rapporter. Autentiser deg med API-nøkkelen til kontoen din, og kall versjonerte endepunkter under /api/v1.

Dette kan du gjøre

QR-koder

Opprett, vis, oppdater, sett på pause, dupliser, slett og last ned QR-koder.

Analyse

Totalt antall skanninger og oppdelinger for én QR-kode eller hele arbeidsområdet.

Rapporter

Eksporter en enkeltstående rapport, eller planlegg gjentakende rapporter på e-post.

Maler

Lagre design og bruk dem på nye QR-koder.

Masseopprettelse av QR-koder

Opprett opptil 100 QR-koder på én gang fra JSON eller en CSV-fil.

Filer

Last opp PDF-er, bilder, videoer og logoer til QR-kodene dine.

Statussjekk

Sjekk at API-et er oppe. Krever ingen API-nøkkel.

Veiledninger

QR-kodedata per type

Dataformatet for hver av de 16 QR-typene.

Tilpasning

Prikkstiler, hjørner, farger, rammer og logoer.

Tilgangsregler

Tidsplaner, skannegrenser, passord, pause og sletting.

Basis-URL

Alle endepunkter ligger under én basis-URL:

Versjonering

API-versjonen er en del av banen: hvert endepunkt ligger under /api/v1/.
  • Endringer som bryter kompatibiliteten, kommer under et nytt versjonsprefiks, for eksempel /api/v2/, og /api/v1/ fortsetter å fungere.
  • Tillegg, som nye valgfrie felt eller nye endepunkter, kan komme innenfor v1. Ignorer felt i svaret som koden din ikke kjenner igjen.

Hurtigstart

1

Hent API-nøkkelen din

Generer eller vis nøkkelen din i kontoinnstillingene. Se Autentisering.
2

Sjekk at API-et kan nås

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

Opprett din første QR-kode

API-et svarer 201 med den nye QR-koden, inkludert id og shortLink.
4

Last ned bildet

Forespørsler og svar

  • Format. Send body i forespørselen som JSON med Content-Type: application/json. Unntaket er CSV-opplastingen for masseopprettelse, som bruker multipart/form-data.
  • Svar. Svarene er JSON. Nedlastinger, som QR-bilder og ZIP-arkiver fra masseopprettelse, returnerer selve filen.
  • Datoer. Datoer er ISO 8601-strenger i UTC, for eksempel 2026-08-01T10:00:00.000Z.
  • Spørringsparametere. Boolske parametere tar strengene true eller false.
  • Delvise oppdateringer. PATCH-endepunkter endrer bare feltene du sender.
  • Hemmeligheter. Svar inneholder aldri passord eller interne ID-er. En passordbeskyttet QR-kode rapporterer bare passwordProtected: true.
  • Arbeidsområde. Hver forespørsel kjøres i arbeidsområdet som API-nøkkelen din tilhører. Du sender ingen ID for arbeidsområdet. Se Tilgang og roller.
  • Feil. Mislykkede forespørsler returnerer et error-objekt med en stabil code. Se Feil.

Paginering

Listeendepunkter (QR-koder, maler og planlagte rapporter) tar to spørringsparametere: De svarer med en data-matrise og et pagination-objekt:
Be om neste side så lenge hasMore er true. En pageSize over 100 gir 422.

Idempotens

En nettverksfeil kan gjøre deg usikker på om en forespørsel gikk gjennom. For å prøve Opprett en QR-kode på nytt på en trygg måte sender du en Idempotency-Key-header med en unik verdi du velger selv:
  • Gjentar du forespørselen med samme nøkkel innen 24 timer, returneres det opprinnelige svaret i stedet for at det opprettes en ny QR-kode.
  • Svarheaderen x-idempotent-replay er true for et gjentatt svar og false for et nytt.
  • Hvis den første forespørselen med den nøkkelen fortsatt kjører, svarer API-et 409 conflict. Prøv igjen når den er ferdig.
  • Gjenbruker du en nøkkel med en annen body, svarer API-et 422 unprocessable_entity.
  • Uten headeren behandles en identisk body som sendes innen 30 sekunder, som et duplikat.
Masseopprettelser tar i stedet et idempotencyKey-felt i body. Se Masseopprettelse av QR-koder.

Hastighetsgrenser

Hver API-nøkkel kan sende opptil 600 forespørsler per minutt. Se Hastighetsgrenser.

Kommer senere

Trykklare pakker er planlagt i en senere versjon.

Neste steg

Autentisering

QR-koder