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.
Styr, hvornår en QR-kode løses, hvor mange gange den kan scannes, om den beder om en adgangskode, og om den er sat på pause eller slettet.

Før du starter

  • Rolle. Opsætning af regler, pause, genaktivering og sletning kræver skriveadgang til QR-koder i arbejdsområdet. Se Godkendelse.
  • Abonnement. Alle forespørgsler til API’et kræver et aktivt abonnement hos ejeren af arbejdsområdet, også disse.

Access-objektet

Send et access-objekt, når du opretter eller opdaterer en QR-kode:
Felter, du udelader, forbliver uændrede. Send null for at rydde en regel. Et delvist access-objekt nulstiller aldrig regler, du ikke har nævnt.
Adgangsregler hører til under access. Sender du activeAt, pauseAt, scanLimit, password eller passwordProtected under link, får du 422.

Planlæg en start og en slutning

activeAt og pauseAt er uafhængige: Angiv den ene eller begge. Begge tager ISO 8601-datoer med klokkeslæt, med Z eller en UTC-forskydning.
Send null for at rydde tidsplanen. Så bliver QR-koden aktiv med det samme, og slutdatoen fjernes:

Scanningsgrænse

Begræns det samlede antal scanninger. Derefter holder QR-koden op med at blive løst:
Tælleren for scanninger i hele levetiden kører altid, uanset om der er sat en grænse. Det gør ændringer af grænsen forudsigelige:
  • Hæver du grænsen, frigøres præcis (ny grænse minus samlede scanninger) flere scanninger.
  • Sænker du grænsen til under det nuværende samlede antal, blokeres QR-koden med det samme.
  • Sætter du en grænse senere, tælles de scanninger med, der skete, mens der ikke var nogen grænse.
scanLimit skal være et positivt heltal, op til 2147483647. Send null for ubegrænset.

Adgangskodebeskyttelse

Angiv en adgangskode via det samme access-objekt. Den gemte adgangskode bevares, når du slår beskyttelsen fra, så du kan slå den til igen uden at sende den igen.
1

Angiv eller skift adgangskoden

Det slår også beskyttelsen til.
2

Slå beskyttelsen fra

Den gemte adgangskode bevares.
3

Slå beskyttelsen til igen

Du behøver ikke sende adgangskoden igen. Det virker kun, når der er angivet en adgangskode. Ellers giver forespørgslen 422.
  • Ved oprettelse. Send password for at slå beskyttelsen til. passwordProtected alene har ingen effekt, før der findes en adgangskode.
  • Fjernelse af adgangskoden. Send "password": null. Beskyttelsen slås også fra.
  • Læsning. Svar returnerer aldrig adgangskoden, kun access.passwordProtected.

Pause, genaktivering og sletning

Pause og genaktivering er separate endepunkter frem for access-felter, fordi de træder i kraft med det samme i stedet for efter en tidsplan. Pause og activate tager ingen body og returnerer den opdaterede QR-kode:
Du kan også angive pausetilstanden med PUT /api/v1/qrs/{qrId} og { "archived": true } eller med archived i en PATCH. Se Angiv pausetilstanden. Sletning fjerner QR-koden og dens kortlink sammen:
Sletning kan ikke fortrydes. Kortlinket holder op med at blive løst, så trykte koder holder op med at virke. Sæt i stedet QR-koden på pause, hvis du måske får brug for den igen.

Hvornår ændringer træder i kraft

  • Næste scanning. Regler tjekkes, når en kode scannes, så en ændring gælder fra næste scanning, ikke med tilbagevirkende kraft.
  • Pausesiden. En QR-kode, der er blokeret af en tidsplan, en scanningsgrænse eller en pause, viser pausesiden. Scanningen viderestilles ikke.
  • Adgangskode. Besøgende, der allerede har indtastet adgangskoden, beholder adgangen, indtil adgangskoden ændres, eller indtil beskyttelsen slås fra og til igen.
  • Ur. Tidsplaner bruger serverens ur i UTC, ikke den besøgendes lokale tid.
  • Regler kombineres. En QR-kode løses kun, når den ikke er sat på pause, er inden for sin tidsplan og er under sin scanningsgrænse.

Almindelige problemer

QR-koden har endnu ingen adgangskode. Send password i stedet for passwordProtected: true.
En tidsplan eller scanningsgrænse gælder stadig. Tjek access.activeAt, access.pauseAt og access.scanLimit i QR-koden, og sammenlign scans med grænsen.
link.expiresAt er ikke tilgængelig i dette API. Brug access.pauseAt i stedet.

Næste skridt

QR-koder

QR-kodedata efter type