Reguły dostępu

API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.

Określ, kiedy kod QR prowadzi do celu, ile razy można go zeskanować, czy wymaga hasła oraz czy jest wstrzymany lub usunięty.

Zanim zaczniesz

Rola. Ustawianie reguł, wstrzymywanie, ponowna aktywacja i usuwanie wymagają uprawnień do zapisu kodów QR w obszarze roboczym. Zobacz Uwierzytelnianie.
Subskrypcja. Każde żądanie do API, w tym te, wymaga aktywnej subskrypcji właściciela obszaru roboczego.

Obiekt access

Wyślij obiekt access przy tworzeniu lub aktualizacji kodu QR:

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

Pole	Typ	Opis
`activeAt`	string (ISO 8601) \| null	Zaplanowany początek. Przed tą chwilą skanowania pokazują stronę wstrzymania zamiast celu. `null` oznacza, że kod jest aktywny od razu.
`pauseAt`	string (ISO 8601) \| null	Zaplanowany koniec. Od tej chwili skanowania pokazują stronę wstrzymania. `null` oznacza brak daty końcowej.
`scanLimit`	integer \| null	Maksymalna liczba skanowań w całym okresie istnienia kodu QR. Po jej przekroczeniu skanowania pokazują stronę wstrzymania. `null` oznacza brak limitu.
`password`	string \| null	Hasło, które odwiedzający musi wpisać przed przekierowaniem. Wysłanie go włącza też ochronę.
`passwordProtected`	boolean	Czy kod QR wymaga hasła. `false` wyłącza ochronę, ale zachowuje zapisane hasło. `true` włącza ją ponownie.

Pominięte pola pozostają bez zmian. Aby usunąć regułę, wyślij null. Częściowy obiekt access nigdy nie resetuje reguł, których nie podano.

Reguły dostępu należą do access. Wysłanie activeAt, pauseAt, scanLimit, password lub passwordProtected w link zwraca 422.

Planowanie początku i końca

activeAt i pauseAt są niezależne: ustaw jedno z nich albo oba. Oba przyjmują datę i godzinę w formacie ISO 8601, z Z lub przesunięciem względem UTC.

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"
    }
  }'

Wyślij null, aby usunąć harmonogram. Kod QR staje się wtedy od razu aktywny, a data końcowa znika:

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

Limit skanowań

Ogranicz łączną liczbę skanowań. Po jej osiągnięciu kod QR przestaje prowadzić do celu:

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

Licznik skanowań z całego okresu istnienia kodu działa zawsze, niezależnie od tego, czy limit jest ustawiony. Dzięki temu zmiana limitu jest przewidywalna:

Podniesienie limitu daje dokładnie (nowy limit minus łączna liczba skanowań) kolejnych skanowań.
Obniżenie limitu poniżej obecnej łącznej liczby od razu blokuje kod QR.
Ustawienie limitu później uwzględnia skanowania wykonane, gdy limit nie był ustawiony.

scanLimit musi być dodatnią liczbą całkowitą nie większą niż 2147483647. Aby znieść limit, wyślij null.

Ochrona hasłem

Hasło ustawia się w tym samym obiekcie access. Po wyłączeniu ochrony zapisane hasło zostaje zachowane, więc możesz ją włączyć ponownie bez ponownego wysyłania hasła.

Ustaw lub zmień hasło

To również włącza ochronę.

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

Wyłącz ochronę

Zapisane hasło zostaje zachowane.

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

Włącz ochronę ponownie

Nie musisz ponownie wysyłać hasła. Działa to tylko wtedy, gdy hasło zostało już ustawione. W przeciwnym razie żądanie zwraca 422.

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

Przy tworzeniu. Wyślij password, aby włączyć ochronę. Samo passwordProtected nic nie zmienia, dopóki nie istnieje hasło.
Usunięcie hasła. Wyślij "password": null. Ochrona też zostanie wyłączona.
Odczyt. Odpowiedzi nigdy nie zwracają hasła, tylko access.passwordProtected.

Wstrzymywanie, ponowna aktywacja i usuwanie

Wstrzymanie i ponowna aktywacja to osobne endpointy, a nie pola access, ponieważ działają natychmiast, a nie według harmonogramu.

Metoda	Ścieżka	Opis
`POST`	`/api/v1/qrs/{qrId}/pause`	Wstrzymaj kod QR od razu. Skanowania pokazują stronę wstrzymania, dopóki go ponownie nie aktywujesz.
`POST`	`/api/v1/qrs/{qrId}/activate`	Ponownie aktywuj wstrzymany kod QR. Harmonogram i limit skanowań nadal obowiązują.
`DELETE`	`/api/v1/qrs/{qrId}`	Trwale usuń kod QR i jego krótki link.

Wstrzymanie i aktywacja nie przyjmują treści żądania i zwracają zaktualizowany kod QR:

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

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

Stan wstrzymania możesz też ustawić przez PUT /api/v1/qrs/{qrId} z { "archived": true } albo polem archived w żądaniu PATCH. Zobacz Ustawianie stanu wstrzymania. Usunięcie kasuje kod QR razem z jego krótkim linkiem:

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

Usunięcia nie można cofnąć. Krótki link przestaje działać, więc wydrukowane kody też przestają działać. Jeśli kod może się jeszcze przydać, lepiej go wstrzymaj.

Kiedy zmiany zaczynają działać

Następne skanowanie. Reguły są sprawdzane przy skanowaniu kodu, więc zmiana obowiązuje od następnego skanowania, a nie wstecz.
Strona wstrzymania. Kod QR zablokowany przez harmonogram, limit skanowań lub wstrzymanie pokazuje stronę wstrzymania. Skanowanie nie jest przekierowywane.
Hasło. Odwiedzający, którzy już wpisali hasło, zachowują dostęp do czasu zmiany hasła albo wyłączenia i ponownego włączenia ochrony.
Zegar. Harmonogramy korzystają z zegara serwera w UTC, a nie z czasu lokalnego odwiedzającego.
Reguły działają łącznie. Kod QR prowadzi do celu tylko wtedy, gdy nie jest wstrzymany, mieści się w harmonogramie i nie przekroczył limitu skanowań.

Typowe problemy

422 przy ustawianiu reguły w link

Wyślij regułę w access, a nie w link.

422 przy włączaniu ochrony hasłem

Kod QR nie ma jeszcze hasła. Wyślij password zamiast passwordProtected: true.

Kod QR po ponownej aktywacji nadal pokazuje stronę wstrzymania

Nadal obowiązuje harmonogram lub limit skanowań. Sprawdź access.activeAt, access.pauseAt i access.scanLimit w kodzie QR i porównaj scans z limitem.

Link ma wygasnąć

link.expiresAt nie jest dostępne w tym API. Użyj zamiast tego access.pauseAt.

API

Zanim zaczniesz

Obiekt access

Planowanie początku i końca

Limit skanowań

Ochrona hasłem

Wstrzymywanie, ponowna aktywacja i usuwanie

Kiedy zmiany zaczynają działać

Typowe problemy

Co dalej

Kody QR

Dane kodu QR według typu

​Zanim zaczniesz

​Obiekt access

​Planowanie początku i końca

​Limit skanowań

​Ochrona hasłem

​Wstrzymywanie, ponowna aktywacja i usuwanie

​Kiedy zmiany zaczynają działać

​Typowe problemy

​Co dalej

Kody QR

Dane kodu QR według typu

Zanim zaczniesz

Obiekt access

Planowanie początku i końca

Limit skanowań

Ochrona hasłem

Wstrzymywanie, ponowna aktywacja i usuwanie

Kiedy zmiany zaczynają działać

Typowe problemy

Co dalej