Soubory

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ódy typu PDF, Image a Video vedou na soubor a vlastní logo je také soubor. Nahrání má dva kroky: soubor zaregistrujete a získáte URL, pak na tuto URL pošlete jeho obsah.

Metoda	Cesta	Popis
`POST`	`/api/v1/files`	Registrace nahrání souboru

Nahrání souboru

Zaregistrujte soubor

Zavolejte registraci nahrání souboru s hodnotami target, contentType a size souboru. target určuje povolené typy obsahu a limit velikosti. Dostanete fileId a uploadUrl.

Pošlete soubor

Pošlete soubor požadavkem PUT na uploadUrl. Jeho Content-Type a Content-Length musí přesně odpovídat zaregistrovaným hodnotám contentType a size: cokoli jiného se odmítne. URL je předem podepsaná, takže API klíč nepřidávejte. Platnost vyprší po 10 minutách.

curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: application/pdf" \
  --data-binary @menu.pdf

Použijte ID souboru

Předejte fileId, když vytváříte QR kód:

Jako fileId pro QR kód pdf, image nebo video. Nahrávejte s odpovídajícím cílem.
Jako fileId pro profilový obrázek QR kódu vcard, social, multilink nebo event. Nahrávejte s cílem logo.
Jako logoOptions.fileId s logoOptions.type nastaveným na uploaded pro vlastní logo. Nahrávejte s cílem logo. Viz Přizpůsobení.

Limity

`target`	Povolené typy obsahu	Maximální velikost
`pdf`	`application/pdf`	20 MB (20 971 520 bajtů)
`image`	`image/*`	5 MB (5 242 880 bajtů)
`video`	`video/*`	50 MB (52 428 800 bajtů)
`logo`	`image/*`	5 MB (5 242 880 bajtů)

Samotný MIME typ. Pošlete jeden typ a podtyp malými písmeny, například image/png. Parametry jako ;charset= a seznamy se odmítnou.
Bez SVG. Typy založené na XML, například image/svg+xml, se nepřijímají. Nahrajte rastrový obrázek, například image/png nebo image/jpeg.

Hlavičky

string

povinné

Bearer následovaný vaším API klíčem. Viz Ověřování.

string

povinné

application/json.

Registrace nahrání souboru

POST /api/v1/files Zaregistruje soubor a vrátí předem podepsanou URL, na kterou ho nahrajete. Toto volání samotný soubor nenahrává.

string

povinné

K čemu soubor slouží: pdf, image, video nebo logo. Určuje povolené typy obsahu a limit velikosti. Viz Limity.

string

povinné

MIME typ souboru, například application/pdf, bez parametrů. Požadavek na nahrání musí poslat přesně tento Content-Type.

integer

povinné

Přesná velikost souboru v bajtech, kladné celé číslo. Porovnává se s limitem pro daný cíl. Požadavek na nahrání musí poslat přesně tuto hodnotu Content-Length.

string

Původní název souboru, nejvýše 255 znaků. Uchovává se pro zobrazení v dashboardu. Cesta s / nebo \ se odmítne.

string

ID, které předáte jako fileId nebo logoOptions.fileId.

string

Předem podepsaná URL, na kterou soubor pošlete metodou PUT.

integer

Počet sekund do vypršení uploadUrl: 600.

string

Metoda HTTP pro nahrání: PUT.

curl -X POST "https://getqr.com/api/v1/files" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "pdf",
    "contentType": "application/pdf",
    "size": 248000,
    "name": "menu.pdf"
  }'

{
  "fileId": "file_7bQ2xR9mKp",
  "uploadUrl": "https://storage.getqr.com/qrs-content/pdf/file_7bQ2xR9mKp?X-Amz-...",
  "expiresIn": 600,
  "method": "PUT"
}

Časté problémy

422 "Content type … is not allowed for target"

Typ obsahu neodpovídá cíli. Například pdf přijímá jen application/pdf. Viz Limity.

422 "must be a single lowercase type/subtype"

Typ obsahu pošlete malými písmeny a bez parametrů: image/png, ne Image/PNG ani image/png; charset=utf-8.

422 "File is too large for target"

Deklarovaná hodnota size překračuje limit pro daný cíl. Před registrací soubor zkomprimujte.

Nahrání na uploadUrl selže

URL vyprší 10 minut po registraci souboru a požadavek musí poslat přesně zaregistrované Content-Type a Content-Length. Pro novou URL soubor zaregistrujte znovu.

422 "is registered but its content was never uploaded" při vytváření QR kódu

Soubor jste zaregistrovali, ale PUT na uploadUrl se nedokončil. Nahrajte soubor a pak vytvořte QR kód.

422 "was uploaded to …" při vytváření QR kódu

Soubor byl zaregistrován s jiným cílem, například soubor image použitý pro QR kód pdf. Zaregistrujte nové nahrání s odpovídajícím cílem.

404 "File … was not found" při vytváření QR kódu

fileId neexistuje. Převezměte ho z odpovědi registrace nahrání souboru.

API

Nahrání souboru

Limity

Hlavičky

Registrace nahrání souboru

Časté problémy

Co dál

QR kódy

Typy QR kódů

Přizpůsobení

Chyby

​Nahrání souboru

​Limity

​Hlavičky

​Registrace nahrání souboru

​Časté problémy

​Co dál

QR kódy

Typy QR kódů

Přizpůsobení

Chyby

Nahrání souboru

Limity

Hlavičky

Registrace nahrání souboru

Časté problémy

Co dál