Skip to main content
Klíče API ověřují požadavky vůči veřejnému rozhraní API /v1. Každý klíč patří k servisnímu účtu a vytváří se na stránce s podrobnostmi tohoto účtu ve Developer Hubu. Omezený klíč API použijte pro privátní backendovou integraci, pokud vyhovuje bezpečné uložení a obměna tajného klíče. Není potřeba žádný klient OAuth ani výměna tokenů. Pokud vaše organizace vyžaduje krátkodobé přístupové tokeny OAuth, přečtěte si část Autentizace.

​
Struktura klíče

  • Identifikátor — začíná na ak_. Lze jej bezpečně uvádět v tiketech, protokolech a konfiguraci; sám o sobě nic neumožňuje.
  • Tajný klíč — začíná na lsk_live_. Jedná se o přihlašovací údaj, který vaše integrace předkládá. Zobrazí se pouze jednou, při vytvoření nebo obměně, a později jej nelze znovu získat. Seznam klíčů zobrazuje pouze poslední čtyři znaky (například lsk_live_…xQc4), abyste mohli přiřadit řádek k přihlašovacímu údaji, který volající používá.
  • Oprávnění — podmnožina oprávnění vlastnícího servisního účtu, zvolená při vytvoření. Klíč nikdy nemůže dělat více, než jeho účet dovoluje.
  • Platnost — povinný údaj. Každý klíč má datum vypršení platnosti.
Tajné klíče uložte do správce tajných klíčů ihned po jejich zobrazení. Nikdy je neukládejte do správy verzí, nevkládejte je do kódu na straně klienta ani je nesdílejte v chatu. Kdokoli, kdo tajný klíč vlastní, může jednat s oprávněními tohoto klíče.

​
Vytvoření klíče

Na stránce s podrobnostmi servisního účtu vytvoříte klíč ve čtyřech krocích: pojmenujte jej, vyberte oprávnění, která tento konkrétní klíč potřebuje, zvolte dobu platnosti — 30, 90 nebo 365 dní, případně vlastní období až do jednoho roku — a zkontrolujte zadané údaje. Tajný klíč se po dokončení zobrazí, a to pouze jednou. Každému klíči udělte co nejužší sadu oprávnění, kterou jeho volající potřebuje, i když účet povoluje více. Pokud klíč unikne, jeho oprávnění určují rozsah možných škod.

​
Obměna bez výpadku

Obměna vydá nový tajný klíč a spustí překryvné okno — 1 hodina, 24 hodin nebo 7 dní — během kterého starý tajný klíč dál funguje. Díky tomu můžete nový tajný klíč nasazovat do svých prostředí vlastním tempem:
1

Obměňte klíč

Zvolte překryvné okno, které pokryje vaši nejpomalejší cestu nasazení. Nový tajný klíč se zobrazí jednou — uložte jej ihned.
2

Aktualizujte své integrace

Nahraďte starý tajný klíč všude, kde je nakonfigurován. Stav klíče se zobrazuje jako překryv, dokud okno neskončí.
3

Ověřte před uzavřením okna

Pomocí protokolů požadavků ověřte, že provoz přešel na nový tajný klíč. Po skončení překryvu starý tajný klíč přestane ověřovat.
Obměňujte klíče i před vypršením platnosti: klíče blížící se datu vypršení jsou v seznamu klíčů označeny jako brzy expirující. Klíč s vypršenou platností přestane ověřovat — požadavky s ním vrátí 401 s kódem credential_expired.

​
Okamžité zrušení

Zrušení se projeví okamžitě a je trvalé — neexistuje žádné překryvné okno ani možnost vrácení zpět. Klíč zrušte, jakmile máte podezření, že jeho tajný klíč byl odhalen; pokud nahrazujete bezproblémový přihlašovací údaj, použijte místo toho obměnu. Požadavky s zrušeným klíčem vrátí 401 s kódem credential_revoked. Pokud potřebujete najednou zastavit všechny klíče, které integrace používá, zakažte místo toho její servisní účet.