Reguli de acces

API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.

Controlați când se rezolvă un cod QR, de câte ori poate fi scanat, dacă solicită o parolă și dacă este pus în pauză sau șters.

Înainte de a începe

Rol. Setarea regulilor, punerea în pauză, reactivarea și ștergerea necesită acces de scriere la codurile QR din spațiul de lucru. Consultați Autentificare.
Abonament. Fiecare cerere API necesită un abonament activ al proprietarului spațiului de lucru, inclusiv acestea.

Obiectul access

Trimiteți un obiect access când creați sau actualizați un cod QR:

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

Câmp	Tip	Descriere
`activeAt`	string (ISO 8601) \| null	Început programat. Înainte de acest moment, scanările afișează pagina de pauză în locul destinației. `null` înseamnă activ imediat.
`pauseAt`	string (ISO 8601) \| null	Sfârșit programat. În acest moment și după el, scanările afișează pagina de pauză. `null` înseamnă fără dată de încheiere.
`scanLimit`	integer \| null	Numărul maxim de scanări pe toată durata de viață a codului QR. Odată depășit, scanările afișează pagina de pauză. `null` înseamnă nelimitat.
`password`	string \| null	Parola pe care vizitatorii trebuie să o introducă înainte de a fi redirecționați. Trimiterea ei activează și protecția.
`passwordProtected`	boolean	Dacă codul QR solicită o parolă. `false` dezactivează protecția, dar păstrează parola stocată. `true` o reactivează.

Câmpurile pe care le omiteți rămân neschimbate. Trimiteți null pentru a șterge o regulă. Un obiect access parțial nu resetează niciodată regulile pe care nu le-ați menționat.

Regulile de acces se trimit în access. Trimiterea activeAt, pauseAt, scanLimit, password sau passwordProtected în link primește 422.

Programați un început și un sfârșit

activeAt și pauseAt sunt independente: setați una dintre ele sau pe amândouă. Ambele acceptă date și ore ISO 8601, cu Z sau cu un decalaj față de 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"
    }
  }'

Trimiteți null pentru a șterge programarea. Astfel, codul QR devine activ imediat, iar data de încheiere este eliminată:

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

Limita de scanări

Limitați numărul total de scanări. După atingerea limitei, codul QR nu se mai rezolvă:

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

Contorul de scanări pe toată durata de viață funcționează întotdeauna, indiferent dacă este setată o limită. Astfel, schimbarea limitei este previzibilă:

Creșterea limitei eliberează exact (noua limită minus totalul scanărilor) scanări suplimentare.
Scăderea limitei sub totalul actual blochează imediat codul QR.
Setarea ulterioară a unei limite ia în calcul și scanările făcute cât timp nu exista nicio limită.

scanLimit trebuie să fie un număr întreg pozitiv, de maximum 2147483647. Trimiteți null pentru nelimitat.

Protecția cu parolă

Setați o parolă prin același obiect access. Parola stocată este păstrată când dezactivați protecția, așa că o puteți reactiva fără să o trimiteți din nou.

Setați sau schimbați parola

Aceasta activează și protecția.

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

Dezactivați protecția

Parola stocată este păstrată.

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

Reactivați protecția

Nu este nevoie să retrimiteți parola. Funcționează doar dacă a fost setată deja o parolă. Altfel, cererea primește 422.

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

La creare. Trimiteți password pentru a activa protecția. passwordProtected singur nu are efect până când nu există o parolă.
Eliminarea parolei. Trimiteți "password": null. Se dezactivează și protecția.
Citire. Răspunsurile nu returnează niciodată parola, ci doar access.passwordProtected.

Pauză, reactivare și ștergere

Punerea în pauză și reactivarea sunt endpointuri separate, nu câmpuri din access, deoarece intră în vigoare imediat, nu conform unei programări.

Metodă	Cale	Descriere
`POST`	`/api/v1/qrs/{qrId}/pause`	Puneți codul QR în pauză acum. Scanările afișează pagina de pauză până când îl reactivați.
`POST`	`/api/v1/qrs/{qrId}/activate`	Reactivați un cod QR pus în pauză. Programarea și limita de scanări, dacă există, se aplică în continuare.
`DELETE`	`/api/v1/qrs/{qrId}`	Ștergeți definitiv codul QR și linkul său scurt.

Pauza și activarea nu primesc corp de cerere și returnează codul QR actualizat:

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

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

Puteți seta starea de pauză și cu PUT /api/v1/qrs/{qrId} și { "archived": true } sau cu archived într-un PATCH. Consultați Setarea stării de pauză. Ștergerea elimină împreună codul QR și linkul său scurt:

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

Ștergerea nu poate fi anulată. Linkul scurt nu se mai rezolvă, așa că codurile tipărite nu mai funcționează. Puneți codul QR în pauză dacă s-ar putea să aveți nevoie de el din nou.

Când intră în vigoare modificările

Următoarea scanare. Regulile sunt verificate la scanarea codului, așa că o modificare se aplică de la următoarea scanare, nu retroactiv.
Pagina de pauză. Un cod QR blocat de o programare, de o limită de scanări sau de o pauză afișează pagina de pauză. Scanarea nu este redirecționată.
Parolă. Vizitatorii care au introdus deja parola își păstrează accesul până când parola se schimbă sau până când protecția este dezactivată și reactivată.
Ceas. Programările folosesc ceasul serverului în UTC, nu ora locală a vizitatorului.
Regulile se combină. Un cod QR se rezolvă doar dacă nu este pus în pauză, se află în intervalul programat și este sub limita de scanări.

Probleme frecvente

422 la setarea unei reguli în link

Trimiteți regula în access, nu în link.

422 la activarea protecției cu parolă

Codul QR nu are încă o parolă. Trimiteți password în loc de passwordProtected: true.

Codul QR afișează în continuare pagina de pauză după reactivare

Se aplică încă o programare sau o limită de scanări. Verificați access.activeAt, access.pauseAt și access.scanLimit în codul QR și comparați scans cu limita.

Am nevoie ca linkul să expire

link.expiresAt nu este disponibil în acest API. Folosiți în schimb access.pauseAt.

API

Înainte de a începe

Obiectul access

Programați un început și un sfârșit

Limita de scanări

Protecția cu parolă

Pauză, reactivare și ștergere

Când intră în vigoare modificările

Probleme frecvente

Ce urmează

Coduri QR

Datele codurilor QR pe tipuri

​Înainte de a începe

​Obiectul access

​Programați un început și un sfârșit

​Limita de scanări

​Protecția cu parolă

​Pauză, reactivare și ștergere

​Când intră în vigoare modificările

​Probleme frecvente

​Ce urmează

Coduri QR

Datele codurilor QR pe tipuri

Înainte de a începe

Obiectul access

Programați un început și un sfârșit

Limita de scanări

Protecția cu parolă

Pauză, reactivare și ștergere

Când intră în vigoare modificările

Probleme frecvente

Ce urmează