Piekļuves noteikumi

GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.

Kontrolējiet, kad QR kods novirza uz mērķi, cik reižu to var noskenēt, vai tas prasa paroli un vai tas ir pauzēts vai dzēsts.

Pirms sākat

Loma. Noteikumu iestatīšanai, pauzēšanai, atkārtotai aktivizēšanai un dzēšanai nepieciešama rakstīšanas piekļuve QR kodiem darbvietā. Skatiet Autentifikācija.
Abonements. Katram API pieprasījumam, arī šiem, nepieciešams aktīvs darbvietas īpašnieka abonements.

Objekts access

Sūtiet objektu access, kad izveidojat vai atjauninat QR kodu:

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

Lauks	Tips	Apraksts
`activeAt`	string (ISO 8601) \| null	Plānotais sākums. Pirms šī brīža skenējumi rāda pauzes lapu, nevis mērķi. `null` nozīmē, ka kods ir aktīvs uzreiz.
`pauseAt`	string (ISO 8601) \| null	Plānotās beigas. Šajā brīdī un pēc tā skenējumi rāda pauzes lapu. `null` nozīmē bez beigu datuma.
`scanLimit`	integer \| null	Maksimālais skenējumu skaits QR koda darbības laikā. Kad tas pārsniegts, skenējumi rāda pauzes lapu. `null` nozīmē neierobežotu skaitu.
`password`	string \| null	Parole, kas apmeklētājiem jāievada pirms pāradresācijas. Tās nosūtīšana arī ieslēdz aizsardzību.
`passwordProtected`	boolean	Vai QR kods prasa paroli. `false` izslēdz aizsardzību, bet saglabā paroli. `true` to atkal ieslēdz.

Izlaistie lauki paliek nemainīti. Lai noņemtu noteikumu, sūtiet null. Daļējs objekts access nekad neatiestata noteikumus, kurus neminējāt.

Piekļuves noteikumi pieder objektam access. Nosūtot activeAt, pauseAt, scanLimit, password vai passwordProtected objektā link, tiek atgriezts 422.

Sākuma un beigu plānošana

activeAt un pauseAt ir neatkarīgi: iestatiet vienu vai abus. Abi pieņem ISO 8601 datumu un laiku ar Z vai UTC nobīdi.

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

Lai noņemtu grafiku, sūtiet null. Tas uzreiz aktivizē QR kodu un noņem beigu datumu:

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

Skenējumu ierobežojums

Ierobežojiet kopējo skenējumu skaitu. Pēc tam QR kods vairs nenovirza uz mērķi:

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

Skenējumu skaitītājs darbojas vienmēr, neatkarīgi no tā, vai ierobežojums ir iestatīts. Tāpēc ierobežojuma maiņa ir paredzama:

Ierobežojuma paaugstināšana atbrīvo tieši (jaunais ierobežojums mīnus kopējie skenējumi) papildu skenējumus.
Ierobežojuma pazemināšana zem pašreizējās kopsummas uzreiz bloķē QR kodu.
Ierobežojuma iestatīšana vēlāk ieskaita arī skenējumus, kas veikti, kamēr ierobežojuma nebija.

scanLimit jābūt pozitīvam veselam skaitlim, līdz 2147483647. Neierobežotam skaitam sūtiet null.

Paroles aizsardzība

Iestatiet paroli tajā pašā objektā access. Izslēdzot aizsardzību, saglabātā parole paliek, tāpēc to var atkal ieslēgt, nesūtot paroli vēlreiz.

Iestatiet vai mainiet paroli

Tas arī ieslēdz aizsardzību.

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

Izslēdziet aizsardzību

Saglabātā parole paliek.

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

Ieslēdziet aizsardzību atkal

Parole nav jāsūta vēlreiz. Tas darbojas tikai tad, ja parole jau ir iestatīta. Citādi pieprasījums saņem 422.

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

Izveidojot. Sūtiet password, lai ieslēgtu aizsardzību. passwordProtected viens pats neko neietekmē, kamēr parole nav iestatīta.
Paroles noņemšana. Sūtiet "password": null. Aizsardzība arī tiek izslēgta.
Nolasīšana. Atbildes nekad neatgriež paroli, tikai access.passwordProtected.

Pauzēšana, atkārtota aktivizēšana un dzēšana

Pauzēšana un atkārtota aktivizēšana ir atsevišķi galapunkti, nevis access lauki, jo tās stājas spēkā uzreiz, nevis pēc grafika.

Metode	Ceļš	Apraksts
`POST`	`/api/v1/qrs/{qrId}/pause`	Pauzējiet QR kodu tagad. Skenējumi rāda pauzes lapu, līdz to atkārtoti aktivizējat.
`POST`	`/api/v1/qrs/{qrId}/activate`	Atkārtoti aktivizējiet pauzētu QR kodu. Grafiks un skenējumu ierobežojums joprojām ir spēkā.
`DELETE`	`/api/v1/qrs/{qrId}`	Neatgriezeniski dzēsiet QR kodu un tā īso saiti.

Pauzēšana un aktivizēšana nepieņem pieprasījuma pamattekstu un atgriež atjaunināto QR kodu:

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

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

Pauzes stāvokli varat iestatīt arī ar PUT /api/v1/qrs/{qrId} un { "archived": true } vai ar archived pieprasījumā PATCH. Skatiet Pauzes stāvokļa iestatīšana. Dzēšana noņem QR kodu kopā ar tā īso saiti:

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

Dzēšanu nevar atsaukt. Īsā saite pārstāj darboties, tāpēc izdrukātie kodi vairs nestrādā. Ja QR kods vēl var būt vajadzīgs, pauzējiet to.

Kad izmaiņas stājas spēkā

Nākamais skenējums. Noteikumi tiek pārbaudīti koda skenēšanas brīdī, tāpēc izmaiņa attiecas uz nākamo skenējumu, nevis atpakaļejoši.
Pauzes lapa. QR kods, ko bloķē grafiks, skenējumu ierobežojums vai pauze, rāda pauzes lapu. Skenējums netiek pāradresēts.
Parole. Apmeklētāji, kuri jau ievadīja paroli, saglabā piekļuvi, līdz parole mainās vai aizsardzība tiek izslēgta un atkal ieslēgta.
Pulkstenis. Grafiki izmanto servera pulksteni UTC laikā, nevis apmeklētāja vietējo laiku.
Noteikumi apvienojas. QR kods novirza uz mērķi tikai tad, ja tas nav pauzēts, atrodas sava grafika robežās un nav pārsniedzis skenējumu ierobežojumu.

Biežākās problēmas

422, iestatot noteikumu objektā link

Sūtiet noteikumu objektā access, nevis link.

422, ieslēdzot paroles aizsardzību

QR kodam vēl nav paroles. Sūtiet password, nevis passwordProtected: true.

Pēc atkārtotas aktivizēšanas QR kods joprojām rāda pauzes lapu

Joprojām ir spēkā grafiks vai skenējumu ierobežojums. Pārbaudiet access.activeAt, access.pauseAt un access.scanLimit QR kodā un salīdziniet scans ar ierobežojumu.

Man vajag, lai saitei beigtos derīgums

link.expiresAt šajā API nav pieejams. Tā vietā izmantojiet access.pauseAt.

API

Piekļuves noteikumi

Pirms sākat

Objekts access

Sākuma un beigu plānošana

Skenējumu ierobežojums

Paroles aizsardzība

Pauzēšana, atkārtota aktivizēšana un dzēšana

Kad izmaiņas stājas spēkā

Biežākās problēmas

Kas tālāk

QR kodi

QR koda dati pēc veida

​Pirms sākat

​Objekts access

​Sākuma un beigu plānošana

​Skenējumu ierobežojums

​Paroles aizsardzība

​Pauzēšana, atkārtota aktivizēšana un dzēšana

​Kad izmaiņas stājas spēkā

​Biežākās problēmas

​Kas tālāk

QR kodi

QR koda dati pēc veida

Pirms sākat

Objekts access

Sākuma un beigu plānošana

Skenējumu ierobežojums

Paroles aizsardzība

Pauzēšana, atkārtota aktivizēšana un dzēšana

Kad izmaiņas stājas spēkā

Biežākās problēmas

Kas tālāk