Hozzáférési szabályok

A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.

Szabályozza, mikor vezet a QR-kód a céljához, hányszor olvasható be, kér-e jelszót, és hogy szünetel-e vagy törölve van-e.

Mielőtt elkezdené

Szerepkör. A szabályok beállításához, a szüneteltetéshez, az újraaktiváláshoz és a törléshez írási jogosultság szükséges a munkaterület QR-kódjaihoz. Lásd: Hitelesítés.
Előfizetés. Minden API-kérés – ezeket is beleértve – a munkaterület tulajdonosának aktív előfizetését igényli.

Az access objektum

Küldjön egy access objektumot, amikor létrehoz vagy frissít egy QR-kódot:

POST  /api/v1/qrs
PATCH /api/v1/qrs/{qrId}

Mező	Típus	Leírás
`activeAt`	string (ISO 8601) \| null	Ütemezett kezdés. Ezen időpont előtt a beolvasások a cél helyett a szüneteltetési oldalt mutatják. A `null` azt jelenti, hogy a kód azonnal aktív.
`pauseAt`	string (ISO 8601) \| null	Ütemezett befejezés. Ettől az időponttól kezdve a beolvasások a szüneteltetési oldalt mutatják. A `null` azt jelenti, hogy nincs záró időpont.
`scanLimit`	integer \| null	A QR-kód teljes élettartama alatt engedélyezett beolvasások maximális száma. Ha ezt túllépik, a beolvasások a szüneteltetési oldalt mutatják. A `null` korlátlant jelent.
`password`	string \| null	A jelszó, amelyet a látogatóknak meg kell adniuk az átirányítás előtt. Elküldésével a védelem is bekapcsol.
`passwordProtected`	boolean	Kér-e jelszót a QR-kód. A `false` kikapcsolja a védelmet, de megtartja a tárolt jelszót. A `true` újra bekapcsolja.

Az elhagyott mezők változatlanok maradnak. Egy szabály törléséhez küldjön null értéket. Egy részleges access objektum soha nem állítja vissza azokat a szabályokat, amelyeket nem említ.

A hozzáférési szabályok az access alá tartoznak. Ha az activeAt, pauseAt, scanLimit, password vagy passwordProtected mezőt a link alatt küldi, 422 hibát kap.

Kezdés és befejezés ütemezése

Az activeAt és a pauseAt független egymástól: beállíthatja bármelyiket vagy mindkettőt. Mindkettő ISO 8601 formátumú dátumot és időt fogad, Z jelöléssel vagy UTC-eltolással.

curl -X PATCH "https://getqr.com/api/v1/qrs/qr_abc123" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "access": {
      "activeAt": "2026-08-01T09:00:00Z",
      "pauseAt": "2026-08-31T23:59:59Z"
    }
  }'

Az ütemezés törléséhez küldjön null értéket. Így a QR-kód azonnal aktív lesz, és a záró időpont is megszűnik:

{
  "access": { "activeAt": null, "pauseAt": null }
}

Beolvasási korlát

Korlátozza a beolvasások teljes számát. Ezt követően a QR-kód már nem vezet a céljához:

{
  "access": { "scanLimit": 500 }
}

Az élettartamra vonatkozó beolvasásszámláló mindig fut, akár be van állítva korlát, akár nincs. Így a korlát módosítása kiszámítható:

A korlát emelése pontosan (új korlát mínusz összes beolvasás) további beolvasást tesz lehetővé.
A korlát csökkentése a jelenlegi összesített szám alá azonnal blokkolja a QR-kódot.
Később beállított korlát esetén azok a beolvasások is beleszámítanak, amelyek akkor történtek, amikor nem volt korlát.

A scanLimit értékének pozitív egész számnak kell lennie, legfeljebb 2147483647. Korlátlan beolvasáshoz küldjön null értéket.

Jelszavas védelem

A jelszót ugyanazzal az access objektummal állíthatja be. A tárolt jelszó megmarad, amikor kikapcsolja a védelmet, így újra bekapcsolhatja anélkül, hogy ismét elküldené.

Állítsa be vagy módosítsa a jelszót

Ezzel a védelem is bekapcsol.

{ "access": { "password": "hunter2" } }

Kapcsolja ki a védelmet

A tárolt jelszó megmarad.

{ "access": { "passwordProtected": false } }

Kapcsolja vissza a védelmet

A jelszót nem kell újra elküldenie. Ez csak akkor működik, ha már be van állítva jelszó. Ellenkező esetben a kérés 422 hibát kap.

{ "access": { "passwordProtected": true } }

Létrehozáskor. A védelem bekapcsolásához küldje el a password mezőt. A passwordProtected önmagában nem hat, amíg nincs jelszó.
A jelszó eltávolítása. Küldje el ezt: "password": null. A védelem is kikapcsol.
Kiolvasás. A válaszok soha nem adják vissza a jelszót, csak az access.passwordProtected értékét.

Szüneteltetés, újraaktiválás és törlés

A szüneteltetés és az újraaktiválás nem access mező, hanem külön végpont, mert azonnal érvénybe lép, nem ütemezés szerint.

Metódus	Útvonal	Leírás
`POST`	`/api/v1/qrs/{qrId}/pause`	A QR-kód azonnali szüneteltetése. A beolvasások a szüneteltetési oldalt mutatják, amíg újra nem aktiválja.
`POST`	`/api/v1/qrs/{qrId}/activate`	Szüneteltetett QR-kód újraaktiválása. Az ütemezés és a beolvasási korlát továbbra is érvényes.
`DELETE`	`/api/v1/qrs/{qrId}`	A QR-kód és rövid linkjének végleges törlése.

A pause és az activate nem vár kéréstörzset, és a frissített QR-kódot adja vissza:

curl -X POST "https://getqr.com/api/v1/qrs/qr_abc123/pause" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_abc123",
  "archived": true,
  "…": "…"
}

A szüneteltetett állapotot a PUT /api/v1/qrs/{qrId} hívással és { "archived": true } törzzsel, illetve egy PATCH kérésben az archived mezővel is beállíthatja. Lásd: A szüneteltetett állapot beállítása. A törlés a QR-kódot és a rövid linkjét együtt távolítja el:

{ "id": "qr_abc123", "deleted": true }

A törlés nem vonható vissza. A rövid link többé nem vezet célhoz, így a kinyomtatott kódok sem működnek. Ha még szüksége lehet a QR-kódra, inkább szüneteltesse.

Mikor lépnek érvénybe a változások

Következő beolvasás. A szabályokat a rendszer beolvasáskor ellenőrzi, így a változás a következő beolvasástól hat, nem visszamenőleg.
Szüneteltetési oldal. Az ütemezés, a beolvasási korlát vagy a szüneteltetés miatt blokkolt QR-kód a szüneteltetési oldalt mutatja. Átirányítás nem történik.
Jelszó. Azok a látogatók, akik már megadták a jelszót, megtartják a hozzáférést, amíg a jelszó meg nem változik, vagy amíg a védelmet ki nem kapcsolják és újra be nem kapcsolják.
Óra. Az ütemezések a szerver UTC szerinti óráját használják, nem a látogató helyi idejét.
A szabályok együtt érvényesek. A QR-kód csak akkor vezet a céljához, ha nem szünetel, az ütemezésén belül van, és nem lépte túl a beolvasási korlátot.

Gyakori problémák

422-es hiba, amikor a link alatt állítok be szabályt

A szabályt az access alatt küldje, ne a link alatt.

422-es hiba a jelszavas védelem bekapcsolásakor

A QR-kódnak még nincs jelszava. A passwordProtected: true helyett küldje el a password mezőt.

A QR-kód újraaktiválás után is a szüneteltetési oldalt mutatja

Egy ütemezés vagy beolvasási korlát még érvényes. Ellenőrizze az access.activeAt, access.pauseAt és access.scanLimit értékét a QR-kódban, és vesse össze a scans értékét a korláttal.

Lejáró linkre van szükségem

A link.expiresAt ebben az API-ban nem érhető el. Használja helyette az access.pauseAt mezőt.

API

Hozzáférési szabályok

Mielőtt elkezdené

Az access objektum

Kezdés és befejezés ütemezése

Beolvasási korlát

Jelszavas védelem

Szüneteltetés, újraaktiválás és törlés

Mikor lépnek érvénybe a változások

Gyakori problémák

Következő lépések

QR-kódok

QR-kód-adatok típusonként

​Mielőtt elkezdené

​Az access objektum

​Kezdés és befejezés ütemezése

​Beolvasási korlát

​Jelszavas védelem

​Szüneteltetés, újraaktiválás és törlés

​Mikor lépnek érvénybe a változások

​Gyakori problémák

​Következő lépések

QR-kódok

QR-kód-adatok típusonként

Mielőtt elkezdené

Az access objektum

Kezdés és befejezés ütemezése

Beolvasási korlát

Jelszavas védelem

Szüneteltetés, újraaktiválás és törlés

Mikor lépnek érvénybe a változások

Gyakori problémák

Következő lépések