Úvod do API

GetQR API je v beta verzi a je dostupné pro vybrané pracovní prostory. Do obecného vydání se podrobnosti mohou změnit.

GetQR API je REST API pro to, co děláte v dashboardu: vytváření a úpravy QR kódů, stahování jejich obrázků, čtení analytiky skenování a export reportů. Ověřujte se API klíčem svého účtu a volejte verzované endpointy pod /api/v1.

Co můžete dělat

QR kódy

Vytvářejte, vypisujte, upravujte, pozastavujte, duplikujte, mažte a stahujte QR kódy.

Analytika

Celkové počty skenování a rozpady pro jeden QR kód nebo celý pracovní prostor.

Reporty

Exportujte jednorázový report nebo naplánujte pravidelné e-maily s reporty.

Šablony

Ukládejte designy a používejte je pro nové QR kódy.

Hromadné vytváření QR kódů

Vytvořte až 100 QR kódů najednou z JSON nebo ze souboru CSV.

Soubory

Nahrávejte PDF, obrázky, videa a loga pro své QR kódy.

Kontrola stavu

Ověřte, že API běží. API klíč není potřeba.

Návody

Typy QR kódů

Formát dat pro každý ze 16 typů QR kódů.

Přizpůsobení

Styly bodů, rohy, barvy, rámečky a loga.

Pravidla přístupu

Plány, limity skenování, hesla, pozastavení a mazání.

Základní URL

Všechny endpointy mají společnou základní URL:

https://getqr.com/api/v1

Verzování

Verze API je součástí cesty: každý endpoint je pod /api/v1/.

Nekompatibilní změny vycházejí pod novým prefixem verze, například /api/v2/, a /api/v1/ dál funguje.
Kompatibilní rozšíření, jako nová nepovinná pole nebo nové endpointy, se mohou objevit i ve v1. Pole odpovědi, která váš kód nezná, ignorujte.

Rychlý start

Získejte API klíč

Vygenerujte nebo zobrazte klíč v nastavení účtu. Viz Ověřování.

Ověřte, že je API dostupné

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

Odpověď je { "status": "ok", "version": "v1" }.

Vytvořte svůj první QR kód

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 odpoví 201 s novým QR kódem včetně jeho id a shortLink.

Stáhněte obrázek

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

Požadavky a odpovědi

Formát. Těla požadavků posílejte jako JSON s Content-Type: application/json. Výjimkou je nahrání CSV pro hromadné vytváření, které používá multipart/form-data.
Odpovědi. Odpovědi jsou ve formátu JSON. Stahování, například obrázků QR kódů a hromadných archivů ZIP, vrací přímo soubor.
Datum a čas. Datum a čas se zapisují jako řetězce ISO 8601 v UTC, například 2026-08-01T10:00:00.000Z.
Parametry dotazu. Logické parametry přijímají řetězce true nebo false.
Částečné úpravy. Endpointy PATCH mění jen pole, která pošlete.
Tajné údaje. Odpovědi nikdy neobsahují hesla ani interní identifikátory. QR kód chráněný heslem vrací jen passwordProtected: true.
Pracovní prostor. Každý požadavek se provádí v pracovním prostoru, ke kterému patří váš API klíč. ID pracovního prostoru nepředáváte. Viz Přístup a role.
Chyby. Neúspěšné požadavky vracejí objekt error se stálým code. Viz Chyby.

Stránkování

Endpointy seznamů (QR kódy, šablony a plánované reporty) přijímají dva parametry dotazu:

Parametr	Popis
`page`	Stránka, která se má vrátit. Výchozí hodnota je `1`.
`pageSize`	Počet výsledků na stránku, nejvýše `100`. Výchozí hodnota je `100`.

Odpovídají polem data a objektem pagination:

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

Pole	Popis
`page`	Stránka, kterou jste dostali.
`pageSize`	Velikost stránky, kterou jste dostali.
`total`	Počet výsledků na všech stránkách.
`hasMore`	`true`, dokud čeká další stránka.

Dokud je hasMore rovno true, vyžádejte si další stránku. pageSize větší než 100 vrátí 422.

Idempotence

Při chybě sítě nemusíte vědět, zda požadavek prošel. Abyste mohli bezpečně zopakovat vytvoření QR kódu, pošlete hlavičku Idempotency-Key s jedinečnou hodnotou podle vlastní volby:

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

Zopakování požadavku se stejným klíčem do 24 hodin vrátí původní odpověď místo vytvoření druhého QR kódu.
Hlavička odpovědi x-idempotent-replay má hodnotu true u zopakované odpovědi a false u nové.
Pokud první požadavek s tímto klíčem ještě běží, API odpoví 409 conflict. Zkuste to znovu, až doběhne.
Opětovné použití klíče s jiným tělem požadavku vrátí 422 unprocessable_entity.
Bez této hlavičky se stejné tělo požadavku odeslané do 30 sekund považuje za duplicitu.

Hromadné vytváření místo toho přijímá pole idempotencyKey v těle požadavku. Viz Hromadné vytváření QR kódů.

Limity požadavků

Každý API klíč může odeslat až 600 požadavků za minutu. Viz Limity požadavků.

API

Co můžete dělat

QR kódy

Analytika

Reporty

Šablony

Hromadné vytváření QR kódů

Soubory

Kontrola stavu

Návody

Typy QR kódů

Přizpůsobení

Pravidla přístupu

Základní URL

Verzování

Rychlý start

Požadavky a odpovědi

Stránkování

Idempotence

Limity požadavků

Připravujeme

Co dál

Ověřování

QR kódy

​Co můžete dělat

QR kódy

Analytika

Reporty

Šablony

Hromadné vytváření QR kódů

Soubory

Kontrola stavu

​Návody

Typy QR kódů

Přizpůsobení

Pravidla přístupu

​Základní URL

​Verzování

​Rychlý start

​Požadavky a odpovědi

​Stránkování

​Idempotence

​Limity požadavků

​Připravujeme

​Co dál

Ověřování

QR kódy

Co můžete dělat

Návody

Základní URL

Verzování

Rychlý start

Požadavky a odpovědi

Stránkování

Idempotence

Limity požadavků

Připravujeme

Co dál