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 QR-kode i GetQR er billedet plus et kortlink, som den løses igennem. Når du opretter en QR-kode, oprettes dens kortlink også, så du senere kan ændre destinationen uden at trykke koden igen.

QR-kodedata efter type

data-formatet for hver af de 16 typer.

Tilpasning

Prikformer, farver, rammer og logoer.

Adgangsregler

Tidsplan, scanningsgrænse og adgangskode.
Se Statistik for scanningsstatistik for en QR-kode.

QR-kodeobjektet

Alle QR-kode-endepunkter svarer med dette objekt, undtagen Slet og Download. Listen returnerer et array af dem.
string
QR-kodens unikke id, f.eks. qr_1EPcVfeHZAY2iNoVLsgW2Aqf.
string
QR-kodens type, f.eks. website. Se QR-kodedata efter type for alle 16 værdier.
string | null
QR-kodens navn, som vises i dashboardet.
string | null
Fri note om QR-koden.
string
Den gemte payload. For wifi, vcard, social, multilink, event og sms er det den payload, du sendte. For alle andre typer er det kortlinket, så læs destinationen fra url.
boolean
true, når QR-koden er sat på pause.
boolean
true for en statisk QR-kode lavet i dashboardet, som ikke har noget kortlink. API’et opretter altid dynamiske QR-koder.
Det fulde kortlink, f.eks. https://getqr.sh/x7Kd2p1.
string | null
Kortlinkets domæne.
string | null
Kortlinkets slug.
boolean
true, når sluggen er valgt i stedet for genereret.
string | null
Destinationen, som kortlinket viderestiller til.
string | null
Destination for besøgende på iOS, for app-QR-koder.
string | null
Destination for besøgende på Android, for app-QR-koder.
integer
Samlet antal scanninger.
object
Adgangsregler. Selve adgangskoden returneres aldrig. Se Adgangsregler.
string
Skrivebeskyttet. custom er et design, som API’et kan redigere fuldt ud. branded og ai er et Branded design eller AI design lavet i dashboardet. API’et kan ikke redigere dets billede, men bevarer det, når du ændrer andre felter.
object
Det gemte design: styles, frameOptions og logoOptions, hver et objekt eller null. De har samme form som felterne i forespørgslen, så du kan sende dem tilbage. Se Tilpasning.
object | null
Filen til en pdf-, image- eller video-QR-kode: id, name og size i bytes.
string | null
Skrivebeskyttet. Visningsnavnet på en app-QR-kode lavet i dashboardet.
object | null
Skrivebeskyttet. En pdf-QR-kode med flere filer, lavet i dashboardet: title, layout og files.
Skrivebeskyttet. En image-QR-kode med flere billeder, lavet i dashboardet: title, layout og files.
string
Oprettelsesdato, ISO 8601.
string
Dato for seneste opdatering, ISO 8601.
Hemmeligheder og interne id’er (password, userId, workspaceId, projectId) returneres aldrig.

Vis QR-koder

GET /api/v1/qrs Returnerer QR-koderne i dit arbejdsområde, én side ad gangen.
integer
standard:"1"
Siden, der returneres, 1 eller derover.
integer
standard:"100"
QR-koder pr. side, fra 1 til 100. En større værdi afvises.
Matcher QR-kodens titel. Søgninger på mere end 2 tegn matcher også de gemte data. For linktyper er de gemte data kortlinket, så destinations-URL’er kan ikke søges frem.
string
standard:"createdAt"
Felt, der sorteres efter: createdAt, updatedAt, clicks (samlede scanninger), lastClicked (seneste scanning) eller type. type sorterer altid faldende og ignorerer sortOrder.
string
standard:"desc"
Sorteringsretning: asc eller desc.
boolean
standard:"false"
Tag QR-koder på pause med.
boolean
standard:"false"
Returnér kun QR-koder på pause. Går forud for showArchived.
Booleske parametre tager strengene true eller false. Hent næste side, så længe pagination.hasMore er true. Se Paginering.

Opret en QR-kode

POST /api/v1/qrs Opretter en QR-kode og dens kortlink samtidig. Svarer 201 Created med den nye QR-kode.
string
Dit eget token til gentagne forsøg. 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. Se Gentagne forsøg og dubletter.
string
påkrævet
Hvad QR-koden koder. Den bestemmer også, hvilket format data skal have. En af website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.
string
påkrævet
Typens payload, kontrolleret mod qrType. En tom streng springer kontrollen over. Formatet for hver type står i QR-kodedata efter type.
Kortlinket, som QR-koden løses igennem. Valgfrit: Udelades det, følger link.url data.
string
QR-kodens navn, som vises i dashboardet. Trimmes, 1 til 40 tegn. Udelades det, har QR-koden ingen titel.
string
Fri note om QR-koden. Op til 280 tegn.
string
Filen til en pdf-, image- eller video-QR-kode, uploadet med det tilsvarende target. For vcard, social og multilink et valgfrit profilbillede, uploadet med target logo. event accepterer det også, men dens side læser forsidebilledet fra data.fileId. Andre typer giver 422. Upload først filen med Filer. Se Filer i QR-koder.
string
Skabelon, hvis design anvendes på den nye QR-kode. Designfelter, du sender, flettes oven på den. En skabelon med Branded design eller AI design giver 422 (art_template_unsupported). En ukendt skabelon eller en fra et andet arbejdsområde giver 404.
object
Former og farver på prikker og hjørner. Se Tilpasning.
object
Rammen rundt om QR-koden og dens handlingstekst. Se Tilpasning.
object
Logo i midten: et foreslået logo eller din egen fil uploadet med target logo. En ukendt fil, en ufærdig upload eller en fil fra et andet target afvises. Se Tilpasning.
object
Tidsplan, scanningsgrænse og adgangskodebeskyttelse. Se Adgangsregler.
boolean
Om QR-koden er sat på pause. true opretter den på pause: Scanninger viser pausesiden i stedet for destinationen.
Ukendte felter droppes uden fejl. Se Ikke understøttet via API’et.

Gentagne forsøg og dubletter

  • Med en nøgle. Med en Idempotency-Key-header afspilles svaret igen i 24 timer.
  • Uden en nøgle. En identisk body, der sendes inden for 30 sekunder, behandles som en dublet.
  • Gentagelser. En gentagelse returnerer det gemte svar med x-idempotent-replay: true. En ny QR-kode returnerer false.
  • Under behandling. En forespørgsel nummer to, mens den første stadig kører, får 409 conflict.
  • Fejl. En mislykket oprettelse frigiver nøglen med det samme, så du kan prøve igen med samme nøgle.
  • Bedste indsats. Hvis beskyttelsen ikke er tilgængelig, gennemføres oprettelser uden beskyttelse.
Se også Idempotens.

Hent en QR-kode

GET /api/v1/qrs/{qrId} Returnerer en QR-kode med dens kortlink, adgangsregler, design og, for filbaserede typer, dens fil.
string
påkrævet
QR-kodens id fra svaret på listen eller oprettelsen.
Svaret er det fulde QR-kodeobjekt.

Opdater en QR-kode

PATCH /api/v1/qrs/{qrId} Ændrer en QR-kodes indhold, destination, design eller adgangsregler. Send kun de felter, du vil ændre. Svarer med den opdaterede QR-kode.
string
påkrævet
QR-kodens id.
Body tager de samme felter som Opret en QR-kode, alle valgfri, med disse forskelle:
  • templateId. Accepteres ikke.
  • link. Delvis. Den nuværende destination bevares, når du udelader link.url. link.domain og link.key giver 422: Kortlinket er det, den trykte kode koder, så opret en ny QR-kode for at bruge et andet.
  • data. Kontrolleres kun mod den resulterende type, når data eller qrType ændres. Skift af qrType uden passende data afvises. Se Skift af type.
  • Design. styles, frameOptions og logoOptions flettes ind i det gemte design, så et delvist objekt kun ændrer det, det nævner. Vælger du et andet logo, erstattes det, men størrelsen bevares.
  • access. Hver nøgle anvendes, når den er til stede. null rydder en regel. Adgangsregler hører til under access: Sender du dem under link, får du 422.
  • archived. Sætter QR-koden og dens kortlink på pause eller genaktiverer dem samlet, ligesom Pause og Genaktiver.
Hvad du kan ændre efter tryk for hver type, står i QR-kodedata efter type.

Angiv pausetilstanden

PUT /api/v1/qrs/{qrId} Angiver pausetilstanden direkte. Pause og Genaktiver gør det samme og er tydeligere at læse.
string
påkrævet
QR-kodens id.
boolean
påkrævet
true sætter QR-koden på pause, false genaktiverer den.

Sæt en QR-kode på pause

POST /api/v1/qrs/{qrId}/pause Forhindrer QR-koden i at blive løst til sin destination: Scanninger viser i stedet pausesiden. Den trykte kode og dens kortlink forbliver gyldige. Ingen body.
string
påkrævet
QR-kodens id.

Genaktiver en QR-kode

POST /api/v1/qrs/{qrId}/activate Får en QR-kode på pause til at blive løst til sin destination igen. Eventuelle tidsplaner og scanningsgrænser gælder stadig. Ingen body.
string
påkrævet
QR-kodens id.

Duplikér en QR-kode

POST /api/v1/qrs/{qrId}/duplicate Opretter en kopi med samme indhold og design. Ingen body. Svarer 201 Created med den nye QR-kode.
string
påkrævet
Id’et på den QR-kode, der skal kopieres.
  • Kortlink. Kopien får sit eget kortlink med en tilfældig slug på arbejdsområdets standarddomæne, ikke kildens domæne. Dens scanninger tælles separat.
  • Titel. Titlen får suffikset (Copy). Resultatet holder sig inden for 40 tegn: En lang titel forkortes først. En QR-kode uden titel forbliver uden titel.
  • Kopieres ikke. Adgangsregler (adgangskode, tidsplan, scanningsgrænse) og pausetilstanden. Kopien er altid aktiv.
  • Filer. PDF- og billedfiler, også filer i pakker og gallerier, kopieres, så kopien ejer dem. Videofiler og designfiler, f.eks. logoer, deles med kilden.

Slet en QR-kode

DELETE /api/v1/qrs/{qrId} Sletter QR-koden og dens kortlink. Svarer med det slettede id.
Sletning er permanent. Den trykte kode og dens kortlink holder op med at virke, og scanningshistorikken kan ikke længere nås. Sæt i stedet QR-koden på pause, hvis du måske får brug for den igen.
string
påkrævet
QR-kodens id.
string
Id’et på den slettede QR-kode.
boolean
Altid true.

Download et QR-kodebillede

GET /api/v1/qrs/{qrId}/download Renderer QR-koden med dens design og returnerer filen.
string
påkrævet
Id’et på den QR-kode, der skal renderes, fra svaret på listen eller oprettelsen.
string
standard:"jpg"
Outputformat: jpg, png, svg, pdf (en A4-side) eller eps. Et Branded design eller AI design kan kun downloades som jpg, png eller pdf.
integer
standard:"1024"
Billedstørrelse i pixels: 1024, 2048 eller 4096. svg og pdf ignorerer den. Et Branded design eller AI design kan kun downloades i 1024.
  • Body. Svarets body er filen. Det foreslåede filnavn står i Content-Disposition-headeren og er bygget ud fra titlen, eller qr-code for en QR-kode uden titel.
  • Caching. Svar har en ETag og Cache-Control: private, max-age=3600, must-revalidate. Send ETag tilbage i If-None-Match for at få 304 Not Modified, når QR-koden ikke er ændret.
  • Fejl. Et format eller en opløsning, der ikke understøttes, giver 400 bad_request. Fejlbeskeden nævner årsagen: qr_download_invalid_format, qr_download_invalid_resolution, qr_download_art_format_unsupported eller qr_download_art_resolution_unsupported.

Adgangsregler

Send et access-objekt ved oprettelse eller opdatering for at planlægge en start og en slutning, begrænse antallet af scanninger eller kræve en adgangskode. Udeladte regler forbliver uændrede, og null rydder en regel. Den fulde beskrivelse med eksempler står i Adgangsregler.

Designobjekter

styles, frameOptions og logoOptions angiver former på prikker og hjørner, farver, ramme og logo. De fungerer ens på QR-koder, skabeloner og bulk-oprettelser. Ukendte former, rammer eller logoer afvises. Alle accepterede værdier og et gennemarbejdet eksempel står i Tilpasning.

Almindelige problemer

Send reglen under access, ikke under link.
data passer ikke til formatet for qrType. Tjek typen i QR-kodedata efter type.
En identisk oprettelse kører stadig, eller link.key er optaget. Prøv igen, når den første forespørgsel er færdig. Med en Idempotency-Key returnerer det nye forsøg den oprindelige QR-kode.
Parametrene hedder format og resolution, og format er som standard jpg. Send format=png.
Hver forespørgsel kører i arbejdsområdet for din API-nøgle. Tjek, at QR-koden hører til det. Se Godkendelse.

Næste skridt

QR-kodedata efter type

Tilpasning

Adgangsregler

Statistik