Přejít na hlavní obsah
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 ověřuje každý požadavek API klíčem vašeho účtu. Každý uživatel má jeden klíč, který v jednom pracovním prostoru jedná vaším jménem.

​
Než začnete

  • Jste vlastník pracovního prostoru nebo editor. Čtenáři API klíč vytvořit ani používat nemohou.
  • Vlastník pracovního prostoru má aktivní předplatné.

​
Vytvoření API klíče

1

Otevřete nastavení účtu

Otevřete nastavení účtu a přejděte do sekce API.
2

Vygenerujte klíč

Klikněte na Generate API key.
3

Zkopírujte klíč

Zobrazte klíč a zkopírujte ho. Klíče začínají na sk_live_.
Klíč můžete kdykoli znovu zobrazit a zkopírovat. V nastavení uvidíte také, kdy byl klíč vytvořen a kdy byl naposledy použit.

​
Ověřování požadavků

Klíč posílejte jako Bearer token v hlavičce Authorization každého požadavku:
Kontrola stavu je jediný endpoint, který funguje bez klíče.

​
Přístup a role

  • Role. Vytvářet a používat API klíč mohou jen vlastník pracovního prostoru a editoři. Čtenáři to nemohou.
  • Pracovní prostor. Každý klíč patří k jedinému pracovnímu prostoru a všechny požadavky se provádějí v něm. ID pracovního prostoru není třeba předávat.
  • Průběžná kontrola. Přístup se ověřuje při každém požadavku podle vaší aktuální role a předplatného vlastníka pracovního prostoru. Vaše vlastní předplatné nehraje roli. Pokud se vaše role změní na čtenáře nebo předplatné vlastníka skončí, požadavky vracejí 403, dokud nebude přístup obnoven. Nový klíč nepotřebujete.
  • Odebrání. Pokud vás z pracovního prostoru odeberou, váš API klíč se smaže. Pokud vás znovu přidají, vygenerujte si nový klíč.

​
Přegenerování klíče

Klíč přegenerujte, pokud unikne nebo k němu získá přístup někdo, kdo ho mít nemá.
Váš současný klíč okamžitě přestane fungovat. Všechny aplikace a integrace, které ho používají, přestanou fungovat, dokud je neaktualizujete novým klíčem.
1

Klikněte na Regenerate

V nastavení účtu přejděte do sekce API a klikněte na Regenerate.
2

Potvrďte

Klikněte na Regenerate key.
3

Aktualizujte své aplikace

Zkopírujte nový klíč a nahraďte jím starý všude, kde ho používáte.

​
Ochrana klíče

Zacházejte s klíčem jako s heslem: kdokoli, kdo ho má, může ve vašem pracovním prostoru vytvářet, měnit a mazat QR kódy.
  • Uložte ho do proměnné prostředí nebo do správce tajných údajů, ne do zdrojového kódu.
  • Volejte API jen ze svého serveru. Nikdy klíč nevkládejte do webu, mobilní aplikace ani ničeho jiného, co si uživatelé mohou prohlédnout.
  • Sdílejte ho jen s vývojáři, kteří ho potřebují.
  • Jakmile máte podezření, že unikl, přegenerujte ho.

​
Časté problémy

Klíč byl přegenerován, nebo vás z pracovního prostoru odebrali a klíč byl smazán. Zkopírujte aktuální klíč z nastavení účtu nebo vygenerujte nový.
Ověřte, že máte roli vlastníka nebo editora a že je předplatné vlastníka pracovního prostoru aktivní. Jakmile bude přístup obnoven, klíč začne znovu fungovat.
API je v beta verzi a pro váš pracovní prostor zatím není zapnuté.
Zobrazuje se jen vlastníkovi pracovního prostoru a editorům, a to jen v pracovních prostorech, kde je API zapnuté.

​
Co dál

Úvod do API

Chyby