Ievads API

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

GetQR API ir REST API tām pašām darbībām, ko veicat informācijas panelī: QR kodu izveidei un atjaunināšanai, to attēlu lejupielādei, skenēšanas analītikas iegūšanai un atskaišu eksportam. Autentificējieties ar sava konta API atslēgu un izsauciet versionētus galapunktus zem /api/v1.

Ko varat darīt

QR kodi

Izveidojiet, skatiet sarakstā, atjauniniet, pauzējiet, dublējiet, dzēsiet un lejupielādējiet QR kodus.

Analītika

Skenējumu kopsummas un sadalījumi vienam QR kodam vai visai darbvietai.

Atskaites

Eksportējiet vienreizēju atskaiti vai ieplānojiet regulārus atskaišu e-pastus.

Veidnes

Saglabājiet dizainus un piemērojiet tos jauniem QR kodiem.

Lielapjoma QR izveide

Izveidojiet līdz 100 QR kodiem uzreiz no JSON vai CSV faila.

Faili

Augšupielādējiet PDF failus, attēlus, video un logotipus saviem QR kodiem.

Stāvoklis

Pārbaudiet, vai API darbojas. API atslēga nav vajadzīga.

Ceļveži

QR kodu veidi

Datu formāts katram no 16 QR kodu veidiem.

Pielāgošana

Punktu stili, stūri, krāsas, rāmji un logotipi.

Piekļuves noteikumi

Grafiki, skenējumu ierobežojumi, paroles, pauzēšana un dzēšana.

Bāzes URL

Visi galapunkti atrodas zem viena bāzes URL:

https://getqr.com/api/v1

Versijas

API versija ir daļa no ceļa: visi galapunkti atrodas zem /api/v1/.

Nesaderīgas izmaiņas tiek izlaistas ar jaunu versijas prefiksu, piemēram, /api/v2/, un /api/v1/ turpina darboties.
Papildinošas izmaiņas, piemēram, jauni neobligāti lauki vai jauni galapunkti, var parādīties v1 ietvaros. Ignorējiet atbildes laukus, kurus jūsu kods neatpazīst.

Ātrā sākšana

Iegūstiet API atslēgu

Ģenerējiet vai parādiet savu atslēgu konta iestatījumos. Skatiet Autentifikācija.

Pārbaudiet, vai API ir sasniedzams

curl https://getqr.com/api/v1/health

Atbilde ir { "status": "ok", "version": "v1" }.

Izveidojiet savu pirmo QR kodu

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

API atbild ar 201 un jauno QR kodu, ieskaitot tā id un shortLink.

Lejupielādējiet attēlu

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

Pieprasījumi un atbildes

Formāts. Sūtiet pieprasījuma pamattekstu kā JSON ar Content-Type: application/json. Izņēmums ir CSV augšupielāde lielapjoma izveidei, kas izmanto multipart/form-data.
Atbildes. Atbildes ir JSON formātā. Lejupielādes, piemēram, QR attēli un lielapjoma ZIP arhīvi, atgriež pašu failu.
Datumi. Datumi ir ISO 8601 virknes UTC laikā, piemēram, 2026-08-01T10:00:00.000Z.
Vaicājuma parametri. Būla parametri pieņem virknes true vai false.
Daļēji atjauninājumi. PATCH galapunkti maina tikai tos laukus, kurus nosūtāt.
Noslēpumi. Atbildēs nekad nav paroļu vai iekšējo identifikatoru. Ar paroli aizsargāts QR kods atgriež tikai passwordProtected: true.
Darbvieta. Katrs pieprasījums tiek izpildīts darbvietā, kurai pieder jūsu API atslēga. Darbvietas ID nav jānorāda. Skatiet Piekļuve un lomas.
Kļūdas. Neveiksmīgi pieprasījumi atgriež objektu error ar stabilu code. Skatiet Kļūdas.

Lapošana

Sarakstu galapunkti (QR kodi, veidnes un ieplānotās atskaites) pieņem divus vaicājuma parametrus:

Parametrs	Apraksts
`page`	Atgriežamā lapa. Noklusējums: `1`.
`pageSize`	Rezultāti lapā, līdz `100`. Noklusējums: `100`.

Tie atbild ar masīvu data un objektu pagination:

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

Lauks	Apraksts
`page`	Saņemtā lapa.
`pageSize`	Saņemtais lapas izmērs.
`total`	Rezultātu skaits visās lapās.
`hasMore`	`true`, kamēr ir vēl kāda lapa.

Pieprasiet nākamo lapu, kamēr hasMore ir true. Ja pageSize pārsniedz 100, tiek atgriezts 422.

Idempotence

Tīkla kļūdas dēļ var nebūt skaidrs, vai pieprasījums tika izpildīts. Lai droši atkārtotu QR koda izveidi, nosūtiet galveni Idempotency-Key ar pašu izvēlētu unikālu vērtību:

-H "Idempotency-Key: order-4821-qr"

Atkārtojot pieprasījumu ar to pašu atslēgu 24 stundu laikā, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs QR kods.
Atbildes galvene x-idempotent-replay ir true atkārtotai atbildei un false jaunai.
Ja pirmais pieprasījums ar šo atslēgu vēl tiek apstrādāts, API atbild ar 409 conflict. Mēģiniet vēlreiz, kad tas ir pabeigts.
Atslēgas atkārtota izmantošana ar citu pieprasījuma pamattekstu atgriež 422 unprocessable_entity.
Bez šīs galvenes identisks pieprasījuma pamatteksts, kas nosūtīts 30 sekunžu laikā, tiek uzskatīts par dublikātu.

Lielapjoma izveide tā vietā pieņem lauku idempotencyKey pieprasījuma pamattekstā. Skatiet Lielapjoma QR izveide.

Pieprasījumu ierobežojumi

Katra API atslēga var nosūtīt līdz 600 pieprasījumiem minūtē. Skatiet Pieprasījumu ierobežojumi.

API

Ko varat darīt

QR kodi

Analītika

Atskaites

Veidnes

Lielapjoma QR izveide

Faili

Stāvoklis

Ceļveži

QR kodu veidi

Pielāgošana

Piekļuves noteikumi

Bāzes URL

Versijas

Ātrā sākšana

Pieprasījumi un atbildes

Lapošana

Idempotence

Pieprasījumu ierobežojumi

Drīzumā

Kas tālāk

Autentifikācija

QR kodi

​Ko varat darīt

QR kodi

Analītika

Atskaites

Veidnes

Lielapjoma QR izveide

Faili

Stāvoklis

​Ceļveži

QR kodu veidi

Pielāgošana

Piekļuves noteikumi

​Bāzes URL

​Versijas

​Ātrā sākšana

​Pieprasījumi un atbildes

​Lapošana

​Idempotence

​Pieprasījumu ierobežojumi

​Drīzumā

​Kas tālāk

Autentifikācija

QR kodi

Ko varat darīt

Ceļveži

Bāzes URL

Versijas

Ātrā sākšana

Pieprasījumi un atbildes

Lapošana

Idempotence

Pieprasījumu ierobežojumi

Drīzumā

Kas tālāk