Bevezetés az API-ba

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.

A GetQR API egy REST API mindarra, amit az irányítópulton végez: QR-kódok létrehozására és frissítésére, képeik letöltésére, a beolvasási analitika lekérésére és jelentések exportálására. Hitelesítsen a fiókja API-kulcsával, és hívja a /api/v1 alatti, verziózott végpontokat.

Mire használható

QR-kódok

QR-kódok létrehozása, listázása, frissítése, szüneteltetése, másolása, törlése és letöltése.

Analitika

Beolvasási összesítések és lebontások egy QR-kódhoz vagy a teljes munkaterülethez.

Jelentések

Egyszeri jelentés exportálása vagy rendszeres jelentés-e-mailek ütemezése.

Sablonok

Dizájnok mentése és alkalmazása új QR-kódokra.

Tömeges QR-létrehozás

Akár 100 QR-kód létrehozása egyszerre JSON-ból vagy CSV-fájlból.

Fájlok

PDF-ek, képek, videók és logók feltöltése a QR-kódokhoz.

Állapot

Annak ellenőrzése, hogy az API működik-e. Nem kell hozzá API-kulcs.

Útmutatók

QR-típusok

Az adatformátum mind a 16 QR-típushoz.

Testreszabás

Pontstílusok, sarkok, színek, keretek és logók.

Hozzáférési szabályok

Ütemezés, beolvasási korlát, jelszó, szüneteltetés és törlés.

Alap-URL

Minden végpont egyetlen alap-URL alatt található:

https://getqr.com/api/v1

Verziókezelés

Az API verziója az útvonal része: minden végpont a /api/v1/ alatt található.

A nem kompatibilis változások új verzióelőtag alatt jelennek meg, például /api/v2/, a /api/v1/ pedig tovább működik.
A bővítő változások, például új opcionális mezők vagy új végpontok, a v1-en belül is megjelenhetnek. A kódja hagyja figyelmen kívül azokat a válaszmezőket, amelyeket nem ismer.

Gyors kezdés

Szerezze be az API-kulcsát

Generálja vagy jelenítse meg a kulcsát a fiókbeállításokban. Lásd: Hitelesítés.

Ellenőrizze, hogy az API elérhető-e

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

A válasz: { "status": "ok", "version": "v1" }.

Hozza létre első QR-kódját

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

Az API 201 kóddal válaszol, és visszaadja az új QR-kódot, benne az id és a shortLink mezővel.

Töltse le a képet

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

Kérések és válaszok

Formátum. A kéréstörzset JSON-ként küldje, Content-Type: application/json fejléccel. Kivétel a tömeges létrehozás CSV-feltöltése, amely multipart/form-data formátumot használ.
Válaszok. A válaszok JSON formátumúak. A letöltések, például a QR-képek és a tömeges ZIP-archívumok, magát a fájlt adják vissza.
Dátumok. A dátumok ISO 8601 formátumú, UTC szerinti karakterláncok, például 2026-08-01T10:00:00.000Z.
Lekérdezési paraméterek. A logikai paraméterek a true vagy a false karakterláncot fogadják.
Részleges frissítés. A PATCH végpontok csak az elküldött mezőket módosítják.
Titkos adatok. A válaszok soha nem tartalmaznak jelszavakat vagy belső azonosítókat. Egy jelszóval védett QR-kód csak ennyit jelez: passwordProtected: true.
Munkaterület. Minden kérés abban a munkaterületben fut, amelyhez az API-kulcs tartozik. Munkaterület-azonosítót nem kell megadnia. Lásd: Hozzáférés és szerepkörök.
Hibák. A sikertelen kérések egy error objektumot adnak vissza, állandó code értékkel. Lásd: Hibák.

Lapozás

A lista végpontok (QR-kódok, sablonok és ütemezett jelentések) két lekérdezési paramétert fogadnak:

Paraméter	Leírás
`page`	A visszaadandó oldal. Alapértelmezés: `1`.
`pageSize`	Találatok oldalanként, legfeljebb `100`. Alapértelmezés: `100`.

Egy data tömbbel és egy pagination objektummal válaszolnak:

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

Mező	Leírás
`page`	A kapott oldal.
`pageSize`	A kapott oldalméret.
`total`	A találatok száma az összes oldalon.
`hasMore`	`true`, amíg van még további oldal.

Kérje le a következő oldalt, amíg a hasMore értéke true. A 100-nál nagyobb pageSize 422 hibát ad.

Idempotencia

Hálózati hiba után nem mindig tudhatja, hogy a kérés célba ért-e. A QR-kód létrehozása kérés biztonságos megismétléséhez küldjön egy Idempotency-Key fejlécet egy Ön által választott egyedi értékkel:

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

Ha 24 órán belül ugyanazzal a kulccsal ismétli meg a kérést, az eredeti választ kapja vissza, és nem jön létre második QR-kód.
Az x-idempotent-replay válaszfejléc értéke ismételt válasznál true, új válasznál false.
Ha az adott kulccsal küldött első kérés még fut, az API 409 conflict választ ad. Próbálja újra, miután befejeződött.
Ha egy kulcsot más kéréstörzzsel használ újra, a válasz 422 unprocessable_entity.
Fejléc nélkül a 30 másodpercen belül elküldött azonos kéréstörzset a rendszer duplikátumnak tekinti.

A tömeges létrehozás ehelyett egy idempotencyKey mezőt vár a kéréstörzsben. Lásd: Tömeges QR-létrehozás.

Kéréskorlátok

API-kulcsonként percenként legfeljebb 600 kérés küldhető. Lásd: Kéréskorlátok.

API

Bevezetés az API-ba

Mire használható

QR-kódok

Analitika

Jelentések

Sablonok

Tömeges QR-létrehozás

Fájlok

Állapot

Útmutatók

QR-típusok

Testreszabás

Hozzáférési szabályok

Alap-URL

Verziókezelés

Gyors kezdés

Kérések és válaszok

Lapozás

Idempotencia

Kéréskorlátok

Később érkezik

Következő lépések

Hitelesítés

QR-kódok

​Mire használható

QR-kódok

Analitika

Jelentések

Sablonok

Tömeges QR-létrehozás

Fájlok

Állapot

​Útmutatók

QR-típusok

Testreszabás

Hozzáférési szabályok

​Alap-URL

​Verziókezelés

​Gyors kezdés

​Kérések és válaszok

​Lapozás

​Idempotencia

​Kéréskorlátok

​Később érkezik

​Következő lépések

Hitelesítés

QR-kódok

Mire használható

Útmutatók

Alap-URL

Verziókezelés

Gyors kezdés

Kérések és válaszok

Lapozás

Idempotencia

Kéréskorlátok

Később érkezik

Következő lépések