GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
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 etaccess-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.
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.
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:- 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 sammeaccess-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
passwordfor at slå beskyttelsen til.passwordProtectedalene 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 foraccess-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:
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:
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
422, når en regel angives under link
422, når en regel angives under link
Send reglen under
access, ikke link.422, når adgangskodebeskyttelse slås til
422, når adgangskodebeskyttelse slås til
QR-koden har endnu ingen adgangskode. Send
password i stedet for passwordProtected: true.QR-koden viser stadig pausesiden efter genaktivering
QR-koden viser stadig pausesiden efter genaktivering
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.Linket skal udløbe
Linket skal udløbe
link.expiresAt er ikke tilgængelig i dette API. Brug access.pauseAt i stedet.