QR kódy - GetQR Docs

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

QR kód v GetQR tvoří obrázek a krátký odkaz, přes který se vyhodnocuje. Při vytvoření QR kódu vznikne i jeho krátký odkaz, takže cíl můžete později změnit, aniž byste kód znovu tiskli.

Metoda	Cesta	Popis
`GET`	`/api/v1/qrs`	Výpis QR kódů
`POST`	`/api/v1/qrs`	Vytvoření QR kódu
`GET`	`/api/v1/qrs/{qrId}`	Získání QR kódu
`PATCH`	`/api/v1/qrs/{qrId}`	Úprava QR kódu
`PUT`	`/api/v1/qrs/{qrId}`	Nastavení stavu pozastavení
`POST`	`/api/v1/qrs/{qrId}/pause`	Pozastavení QR kódu
`POST`	`/api/v1/qrs/{qrId}/activate`	Opětovná aktivace QR kódu
`POST`	`/api/v1/qrs/{qrId}/duplicate`	Duplikace QR kódu
`DELETE`	`/api/v1/qrs/{qrId}`	Smazání QR kódu
`GET`	`/api/v1/qrs/{qrId}/download`	Stažení obrázku QR kódu

Data QR kódu podle typu

Formát data pro každý ze 16 typů.

Přizpůsobení

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

Pravidla přístupu

Plán, limit skenování a heslo.

Statistiky skenování QR kódu najdete v části Analytika.

Objekt QR kódu

Tímto objektem odpovídá každý endpoint QR kódů kromě smazání a stažení. Výpis vrací jejich pole.

string

Jedinečné ID QR kódu, například qr_1EPcVfeHZAY2iNoVLsgW2Aqf.

string

Typ QR kódu, například website. Všech 16 hodnot najdete v části Data QR kódu podle typu.

string | null

Název QR kódu zobrazený v dashboardu.

string | null

Volná poznámka ke QR kódu.

string

Uložený obsah. U wifi, vcard, social, multilink, event a sms je to obsah, který jste poslali. U všech ostatních typů je to krátký odkaz, takže cíl čtěte z url.

boolean

true, když je QR kód pozastavený.

boolean

true u statického QR kódu vytvořeného v dashboardu, který nemá krátký odkaz. API vždy vytváří dynamické QR kódy.

string | null

Celý krátký odkaz, například https://getqr.sh/x7Kd2p1.

string | null

Doména krátkého odkazu.

string | null

Slug krátkého odkazu.

boolean

true, když byl slug zvolen, a ne vygenerován.

string | null

Cíl, na který krátký odkaz přesměruje.

string | null

Cíl pro návštěvníky s iOS, u QR kódů app.

string | null

Cíl pro návštěvníky s Androidem, u QR kódů app.

integer

Celkový počet skenování.

object

Pravidla přístupu. Samotné heslo se nikdy nevrací. Viz Pravidla přístupu.

Zobrazit properties

boolean

Zda musí návštěvníci zadat heslo.

string | null

Plánovaný začátek, ISO 8601.

string | null

Plánovaný konec, ISO 8601.

integer | null

Maximální počet skenování.

string

Jen pro čtení. custom je design, který API může plně upravovat. branded a ai jsou design Branded nebo AI vytvořený v dashboardu. API nemůže upravit jeho obrázek, ale při změně ostatních polí ho zachová.

object

Uložený design: styles, frameOptions a logoOptions, každé jako objekt nebo null. Mají stejný tvar jako pole požadavku, takže je můžete poslat zpět. Viz Přizpůsobení.

object | null

Soubor QR kódu pdf, image nebo video: id, name a size v bajtech.

string | null

Jen pro čtení. Zobrazovaný název QR kódu app vytvořeného v dashboardu.

object | null

Jen pro čtení. QR kód pdf s více soubory vytvořený v dashboardu: title, layout a files.

object | null

Jen pro čtení. QR kód image s více obrázky vytvořený v dashboardu: title, layout a files.

string

Datum vytvoření, ISO 8601.

string

Datum poslední úpravy, ISO 8601.

Tajné údaje a interní ID (password, userId, workspaceId, projectId) se nikdy nevracejí.

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "description": null,
  "data": "https://getqr.sh/x7Kd2p1",
  "archived": false,
  "isStatic": false,
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "domain": "getqr.sh",
  "key": "x7Kd2p1",
  "keyIsCustom": false,
  "url": "https://example.com",
  "ios": null,
  "android": null,
  "scans": 128,
  "access": {
    "passwordProtected": false,
    "activeAt": null,
    "pauseAt": null,
    "scanLimit": null
  },
  "designKind": "custom",
  "design": {
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" }, … },
    "frameOptions": { "id": "card", "text": "Scan me!", … },
    "logoOptions": { "type": "suggested", "id": "logo-website-3", "scalePercent": 25 }
  },
  "file": null,
  "appName": null,
  "pdfBundle": null,
  "imageGallery": null,
  "createdAt": "2026-08-01T10:00:00.000Z",
  "updatedAt": "2026-08-01T10:00:00.000Z"
}

Výpis QR kódů

GET /api/v1/qrs Vrací QR kódy ve vašem pracovním prostoru po stránkách.

integer

výchozí:"1"

Stránka, která se má vrátit, 1 nebo více.

integer

výchozí:"100"

Počet QR kódů na stránku, od 1 do 100. Větší hodnota se odmítne.

string

Hledá v názvu QR kódu. Dotazy delší než 2 znaky hledají i v uloženém data. U typů s odkazem je v uloženém data krátký odkaz, takže cílové URL vyhledat nelze.

string

výchozí:"createdAt"

Pole pro řazení: createdAt, updatedAt, clicks (celkový počet skenování), lastClicked (poslední skenování) nebo type. type řadí vždy sestupně a ignoruje sortOrder.

string

výchozí:"desc"

Směr řazení: asc nebo desc.

boolean

výchozí:"false"

Zahrne pozastavené QR kódy.

boolean

výchozí:"false"

Vrátí jen pozastavené QR kódy. Má přednost před showArchived.

Logické parametry přijímají řetězce true nebo false. Dokud je pagination.hasMore rovno true, vyžádejte si další stránku. Viz Stránkování.

curl "https://getqr.com/api/v1/qrs?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
      "qrType": "website",
      "title": "Landing page",
      "shortLink": "https://getqr.sh/x7Kd2p1",
      "url": "https://example.com",
      "scans": 128,
      "…": "…"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

Vytvoření QR kódu

POST /api/v1/qrs Vytvoří QR kód spolu s jeho krátkým odkazem. Odpoví 201 Created s novým QR kódem.

string

Váš vlastní token pro opakování. 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. Viz Opakování a duplicity.

string

povinné

Co QR kód kóduje. Určuje také formát, ve kterém musí být data. Jedna z hodnot website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.

string

povinné

Obsah daného typu, ověřovaný podle qrType. Prázdný řetězec kontrolu přeskočí. Formát každého typu najdete v části Data QR kódu podle typu.

object

Krátký odkaz, přes který se QR kód vyhodnocuje. Nepovinné: pokud ho vynecháte, link.url se řídí podle data.

Zobrazit properties

string

Cíl, na který krátký odkaz přesměruje. Pokud ho vynecháte nebo necháte prázdný, výchozí hodnota je data. Když pošlete obojí a hodnoty se liší, má přednost link.url. QR kódy vcard, social, multilink a event vždy vedou na svou hostovanou stránku a QR kódy pdf, image a video s fileId na soubor. Přijímaná schémata: http:, https:, wifi:, mailto:, sms:, begin:.

string

Doména krátkého odkazu. Musí to být aktivní doména vašeho pracovního prostoru: jiná doména vrátí 403 a doména, která ještě není aktivní, vrátí 422. Výchozí je výchozí doména pracovního prostoru.

string

Slug krátkého odkazu, 3 až 15 znaků, ukládá se malými písmeny. Nepovolený slug vrátí 422 a obsazený vrátí 409. Pokud ho vynecháte, vygeneruje se náhodný slug o 7 znacích.

string | null

Cílová URL pro návštěvníky s iOS, u QR kódů app.

string | null

Cílová URL pro návštěvníky s Androidem, u QR kódů app.

string | null

Titulek náhledu odkazu (og:title), uložený u krátkého odkazu. Liší se od vlastního title QR kódu. Zatím ho nic nezobrazuje.

string | null

Popis náhledu odkazu (og:description), uložený u krátkého odkazu. Zatím ho nic nezobrazuje.

—

V tomto API nejsou k dispozici: odeslání kteréhokoli z nich vrátí 422. K zastavení QR kódu v určitý čas použijte access.pauseAt.

string

Název QR kódu zobrazený v dashboardu. Ořízne se, 1 až 40 znaků. Pokud ho vynecháte, QR kód zůstane bez názvu.

string

Volná poznámka ke QR kódu. Nejvýše 280 znaků.

string

Soubor QR kódu pdf, image nebo video, nahraný s odpovídajícím cílem. U vcard, social a multilink volitelný profilový obrázek nahraný s cílem logo. event ho přijímá také, ale jeho stránka čte titulní obrázek z data.fileId. Ostatní typy vrátí 422. Soubor nejprve nahrajte přes Soubory. Viz Soubory v QR kódech.

string

Šablona, jejíž design se použije pro nový QR kód. Pole designu, která pošlete, se s ní sloučí a mají přednost. Šablona s designem Branded nebo AI vrátí 422 (art_template_unsupported). Neznámá šablona nebo šablona z jiného pracovního prostoru vrátí 404.

object

Tvary a barvy bodů a rohů. Viz Přizpůsobení.

object

Rámeček kolem QR kódu a text jeho výzvy k akci. Viz Přizpůsobení.

object

Logo uprostřed: navrhované logo nebo vlastní soubor nahraný s cílem logo. Neznámý soubor, nedokončené nahrání nebo soubor z jiného cíle se odmítne. Viz Přizpůsobení.

object

Plán, limit skenování a ochrana heslem. Viz Pravidla přístupu.

Zobrazit properties

string | null

Plánovaný začátek, ISO 8601.

string | null

Plánovaný konec, ISO 8601.

integer | null

Maximální počet skenování, kladné celé číslo.

string | null

Heslo, které musí návštěvníci zadat. Jeho odesláním se zapne ochrana.

boolean

Vypne nebo znovu zapne ochranu a zachová uložené heslo.

boolean

Zda je QR kód pozastavený. true ho vytvoří pozastavený: skenování zobrazí stránku pozastavení místo cíle.

Neznámá pole se bez chyby zahodí. Viz Nepodporováno přes API.

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

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "data": "https://getqr.sh/x7Kd2p1",
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "url": "https://example.com",
  "scans": 0,
  "access": { "passwordProtected": false, "activeAt": null, "pauseAt": null, "scanLimit": 500 },
  "…": "…"
}

Opakování a duplicity

S klíčem. S hlavičkou Idempotency-Key se odpověď 24 hodin přehrává znovu.
Bez klíče. Stejné tělo odeslané do 30 sekund se považuje za duplicitu.
Přehrání. Přehraná odpověď vrátí uloženou odpověď s x-idempotent-replay: true. Nový QR kód vrátí false.
Probíhající požadavek. Druhý požadavek, zatímco první ještě běží, dostane 409 conflict.
Selhání. Neúspěšné vytvoření klíč okamžitě uvolní, takže to můžete zkusit znovu se stejným klíčem.
Bez záruky. Pokud ochrana není dostupná, vytvoření proběhne bez ní.

Viz také Idempotence.

Získání QR kódu

GET /api/v1/qrs/{qrId} Vrátí QR kód s jeho krátkým odkazem, pravidly přístupu, designem a u typů se souborem i s jeho souborem.

string

povinné

ID QR kódu z odpovědi výpisu nebo vytvoření.

curl "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY"

Odpovědí je úplný objekt QR kódu.

Úprava QR kódu

PATCH /api/v1/qrs/{qrId} Změní obsah, cíl, design nebo pravidla přístupu QR kódu. Pošlete jen pole, která chcete změnit. Odpoví aktualizovaným QR kódem.

string

povinné

ID QR kódu.

Tělo přijímá stejná pole jako vytvoření QR kódu, všechna nepovinná, s těmito rozdíly:

templateId. Nepřijímá se.
link. Částečný. Pokud vynecháte link.url, aktuální cíl zůstane zachován. link.domain a link.key vrátí 422: vytištěný kód kóduje právě krátký odkaz, takže pro jiný odkaz vytvořte nový QR kód.
data. Ověřuje se podle výsledného typu, jen když se změní data nebo qrType. Změna qrType bez odpovídajících data se odmítne. Viz Změna typu.
Design. styles, frameOptions a logoOptions se sloučí s uloženým designem, takže částečný objekt změní jen to, co uvádí. Výběr jiného loga ho nahradí, ale zachová jeho velikost.
access. Každý klíč se použije, pokud je uveden. null pravidlo zruší. Pravidla přístupu patří do access: jejich odeslání v link vrátí 422.
archived. Pozastaví nebo znovu aktivuje QR kód i jeho krátký odkaz najednou, stejně jako pozastavení a opětovná aktivace.

curl -X PATCH "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Autumn campaign",
    "access": { "password": "s3cr3t", "passwordProtected": true }
  }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "title": "Autumn campaign",
  "access": { "passwordProtected": true, "activeAt": null, "pauseAt": null, "scanLimit": null },
  "…": "…"
}

Co lze u jednotlivých typů po vytištění změnit, najdete v části Data QR kódu podle typu.

Nastavení stavu pozastavení

PUT /api/v1/qrs/{qrId} Přímo nastaví stav pozastavení. Pozastavení a opětovná aktivace dělají totéž a jsou přehlednější.

string

povinné

ID QR kódu.

boolean

povinné

true QR kód pozastaví, false ho znovu aktivuje.

curl -X PUT "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "archived": true }'

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

Pozastavení QR kódu

POST /api/v1/qrs/{qrId}/pause QR kód přestane vést na svůj cíl: skenování místo toho zobrazí stránku pozastavení. Vytištěný kód i jeho krátký odkaz zůstávají platné. Bez těla požadavku.

string

povinné

ID QR kódu.

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

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

Opětovná aktivace QR kódu

POST /api/v1/qrs/{qrId}/activate Pozastavený QR kód znovu povede na svůj cíl. Plán i limit skenování stále platí. Bez těla požadavku.

string

povinné

ID QR kódu.

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

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": false,
  "…": "…"
}

Duplikace QR kódu

POST /api/v1/qrs/{qrId}/duplicate Vytvoří kopii se stejným obsahem a designem. Bez těla požadavku. Odpoví 201 Created s novým QR kódem.

string

povinné

ID QR kódu, který se má zkopírovat.

Krátký odkaz. Kopie dostane vlastní krátký odkaz s náhodným slugem na výchozí doméně pracovního prostoru, ne na doméně zdroje. Její skenování se počítají zvlášť.
Název. K názvu se přidá přípona (Copy). Výsledek nepřesáhne 40 znaků: dlouhý název se nejdřív zkrátí. QR kód bez názvu zůstane bez názvu.
Nekopíruje se. Pravidla přístupu (heslo, plán, limit skenování) a stav pozastavení. Kopie je vždy aktivní.
Soubory. Soubory PDF a obrázků, včetně souborů balíčků a galerií, se zkopírují, takže je kopie vlastní. Videa a soubory designu, například loga, sdílí se zdrojem.

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

{
  "id": "qr_7Hk2PqWmX9cTnV4sLbR8YdZe",
  "title": "Landing page (Copy)",
  "shortLink": "https://getqr.sh/p2Wq9dL",
  "url": "https://example.com",
  "archived": false,
  "scans": 0,
  "…": "…"
}

Smazání QR kódu

DELETE /api/v1/qrs/{qrId} Smaže QR kód i jeho krátký odkaz. Odpoví ID smazaného kódu.

Smazání je trvalé. Vytištěný kód i jeho krátký odkaz přestanou fungovat a historie skenování už nebude dostupná. Pokud budete QR kód možná ještě potřebovat, raději ho pozastavte.

string

povinné

ID QR kódu.

string

ID smazaného QR kódu.

boolean

Vždy true.

curl -X DELETE "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY"

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

Stažení obrázku QR kódu

GET /api/v1/qrs/{qrId}/download Vykreslí QR kód s jeho designem a vrátí soubor.

string

povinné

ID QR kódu, který se má vykreslit, z odpovědi výpisu nebo vytvoření.

string

výchozí:"jpg"

Výstupní formát: jpg, png, svg, pdf (stránka A4) nebo eps. Design Branded nebo AI lze stáhnout jen jako jpg, png nebo pdf.

integer

výchozí:"1024"

Velikost obrázku v pixelech: 1024, 2048 nebo 4096. svg a pdf ji ignorují. Design Branded nebo AI lze stáhnout jen v rozlišení 1024.

`format`	`Content-Type`	Název souboru
`jpg`	`image/jpeg`	`<title>-<resolution>px.jpg`
`png`	`image/png`	`<title>-<resolution>px.png`
`svg`	`image/svg+xml`	`<title>.svg`
`pdf`	`application/pdf`	`<title>.pdf`
`eps`	`application/postscript`	`<title>-<resolution>px.eps`

Tělo. Tělem odpovědi je soubor. Navržený název souboru je v hlavičce Content-Disposition a tvoří se z názvu QR kódu, u QR kódu bez názvu je to qr-code.
Mezipaměť. Odpovědi obsahují ETag a Cache-Control: private, max-age=3600, must-revalidate. Pošlete ETag zpět v If-None-Match a když se QR kód nezměnil, dostanete 304 Not Modified.
Chyby. Nepodporovaný formát nebo rozlišení vrátí 400 bad_request. Chybová zpráva uvádí důvod: qr_download_invalid_format, qr_download_invalid_resolution, qr_download_art_format_unsupported nebo qr_download_art_resolution_unsupported.

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

HTTP/1.1 200 OK
Content-Type: image/png
Content-Disposition: attachment; filename="landing-page-1024px.png"
ETag: "9f2c0e1b5a7d43c8b016e2f4a9d5c3718be40f92"
Cache-Control: private, max-age=3600, must-revalidate

<binary image data>

Pravidla přístupu

Při vytvoření nebo úpravě pošlete objekt access, abyste naplánovali začátek a konec, omezili počet skenování nebo vyžadovali heslo. Vynechaná pravidla zůstanou beze změny a null pravidlo zruší. Úplné chování s příklady najdete v části Pravidla přístupu.

Objekty designu

styles, frameOptions a logoOptions nastavují tvary bodů a rohů, barvy, rámeček a logo. Fungují stejně u QR kódů, šablon i hromadného vytváření. Neznámé tvary, rámečky nebo loga se odmítnou. Všechny přijímané hodnoty a ukázkový příklad najdete v části Přizpůsobení.

Časté problémy

422 při nastavení hesla, plánu nebo limitu skenování

Pravidlo pošlete v access, ne v link.

422 při změně link.domain nebo link.key

Krátký odkaz nelze po vytvoření změnit, protože ho vytištěný kód kóduje. Místo toho vytvořte nový QR kód.

422 "Expected … for qrType"

data neodpovídá formátu qrType. Zkontrolujte typ v části Data QR kódu podle typu.

409 conflict při vytváření QR kódu

Stejné vytvoření ještě probíhá, nebo je link.key obsazený. Zkuste to znovu, až první požadavek doběhne. S Idempotency-Key vrátí opakovaný pokus původní QR kód.

Stažený soubor je JPEG, ne PNG

Parametry jsou format a resolution a výchozí hodnota format je jpg. Pošlete format=png.

404 u QR kódu, který vidím v dashboardu

Každý požadavek se provádí v pracovním prostoru vašeho API klíče. Ověřte, že QR kód do něj patří. Viz Ověřování.

Data QR kódu podle typu

Přizpůsobení

Pravidla přístupu

​Objekt QR kódu

​Výpis QR kódů

​Vytvoření QR kódu

​Opakování a duplicity

​Získání QR kódu

​Úprava QR kódu

​Nastavení stavu pozastavení

​Pozastavení QR kódu

​Opětovná aktivace QR kódu

​Duplikace QR kódu

​Smazání QR kódu

​Stažení obrázku QR kódu

​Pravidla přístupu

​Objekty designu

​Časté problémy

​Co dál

Data QR kódu podle typu

Přizpůsobení

Pravidla přístupu

Analytika

Objekt QR kódu

Výpis QR kódů

Vytvoření QR kódu

Opakování a duplicity

Získání QR kódu

Úprava QR kódu

Nastavení stavu pozastavení

Pozastavení QR kódu

Opětovná aktivace QR kódu

Duplikace QR kódu

Smazání QR kódu

Stažení obrázku QR kódu

Pravidla přístupu

Objekty designu

Časté problémy

Co dál