> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Úvod do API

> Spravujte QR kódy, šablony, analytiku a reporty z vlastního kódu.

> [!NOTE]
>
> 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

> [card] [QR kódy](https://docs.getqr.com/cs/api/endpoints/qr-codes.md)
>
> Vytvářejte, vypisujte, upravujte, pozastavujte, duplikujte, mažte a stahujte QR kódy.

> [card] [Analytika](https://docs.getqr.com/cs/api/endpoints/analytics.md)
>
> Celkové počty skenování a rozpady pro jeden QR kód nebo celý pracovní prostor.

> [card] [Reporty](https://docs.getqr.com/cs/api/endpoints/reports.md)
>
> Exportujte jednorázový report nebo naplánujte pravidelné e-maily s reporty.

> [card] [Šablony](https://docs.getqr.com/cs/api/endpoints/templates.md)
>
> Ukládejte designy a používejte je pro nové QR kódy.

> [card] [Hromadné vytváření QR kódů](https://docs.getqr.com/cs/api/endpoints/bulk-qr-creations.md)
>
> Vytvořte až 100 QR kódů najednou z JSON nebo ze souboru CSV.

> [card] [Soubory](https://docs.getqr.com/cs/api/endpoints/files.md)
>
> Nahrávejte PDF, obrázky, videa a loga pro své QR kódy.

> [card] [Kontrola stavu](https://docs.getqr.com/cs/api/endpoints/health.md)
>
> Ověřte, že API běží. API klíč není potřeba.

## Návody

> [card] [Typy QR kódů](https://docs.getqr.com/cs/api/guides/qr-types.md)
>
> Formát dat pro každý ze 16 typů QR kódů.

> [card] [Přizpůsobení](https://docs.getqr.com/cs/api/guides/customization.md)
>
> Styly bodů, rohy, barvy, rámečky a loga.

> [card] [Pravidla přístupu](https://docs.getqr.com/cs/api/guides/access-rules.md)
>
> Plány, limity skenování, hesla, pozastavení a mazání.

## Základní URL

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

```text theme={null}
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

**1. Získejte API klíč**

Vygenerujte nebo zobrazte klíč v nastavení účtu. Viz [Ověřování](https://docs.getqr.com/cs/api/authentication.md).

**2. Ověřte, že je API dostupné**

```bash theme={null}
curl https://getqr.com/api/v1/health
```

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

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

```bash theme={null}
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`.

**4. Stáhněte obrázek**

```bash theme={null}
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í](https://docs.getqr.com/cs/api/endpoints/bulk-qr-creations.md), 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](https://docs.getqr.com/cs/api/authentication.md#přístup-a-role).
* **Chyby.** Neúspěšné požadavky vracejí objekt `error` se stálým `code`. Viz [Chyby](https://docs.getqr.com/cs/api/errors.md).

## 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`:

```json theme={null}
{
  "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`](https://docs.getqr.com/cs/api/errors#chyby-validace).

## 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](https://docs.getqr.com/cs/api/endpoints/qr-codes.md#vytvoření-qr-kódu), pošlete hlavičku `Idempotency-Key` s jedinečnou hodnotou podle vlastní volby:

```bash theme={null}
-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ů](https://docs.getqr.com/cs/api/endpoints/bulk-qr-creations.md).

## Limity požadavků

Každý API klíč může odeslat až 600 požadavků za minutu. Viz [Limity požadavků](https://docs.getqr.com/cs/api/rate-limits.md).

## Připravujeme

Balíčky připravené k tisku plánujeme v některé z dalších verzí.

## Co dál

> [card] [Ověřování](https://docs.getqr.com/cs/api/authentication.md)

> [card] [QR kódy](https://docs.getqr.com/cs/api/endpoints/qr-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.