Přihlašovací údaje API

Integrace se přihlašuje jako firemní prostor, ne jako člověk. Údaje, které k tomu potřebuje, se vydávají tady, v nastavení organizace.

Vydání údaje

123

Dialog, který se ukáže jednou, hned po vydání údaje

• (1) Údaj pojmenujte, zvolte verzi API a stiskněte Přidat. Dialog se objeví okamžitě a nese Client ID.
• (2) Pod ním je Client secret. U obou je tlačítko na zkopírování.
• (3) Zavřít dialog odklidí — a právě tím se tajemství stává nedostupným.

Tajemství se ukáže jen jednou

Dialog to říká natvrdo: po jeho zavření už ke Client secretu přístup mít nebudete a jeho ztráta znamená vytvořit nový údaj. Zkopírujte si ho dřív, než zavřete.

Prostor má vlastní Client ID, které je na obrazovce vidět ještě předtím, než jakýkoli údaj existuje. ID identifikuje prostor; tajemství je to, co přidává každý vydaný údaj.

Odebrání údaje je zneplatnění, ne smazání — akce volá POST /api/v1/company_spaces/api_credentials/{id}/revoke.

K čemu údaj slouží

Přihlašovací údaj je klíč, který nepatří člověku, ale prostoru. Váš systém se jím prokáže, dostane token a od té chvíle se může REST API ptát sám, aniž by se přihlašoval jako konkrétní člověk.

Kde se to hodí:

• Personální systém dostane vlastní klíč. HR systém má s prostorem mluvit přes REST API. Vydáte mu údaj pojmenovaný podle systému a dvojici Client ID a Client secret předáte jeho správci. Integrace se přihlašuje jako prostor, ne jako některý z vašich lidí.
• Kolega, který integraci nastavil, odchází. Údaj patří prostoru, ne jemu. Zrušení jeho účtu integraci nezastaví a napojený systém běží dál, aniž by ho někdo musel v pondělí ráno znovu zapojovat.
• Každý systém svůj údaj. Vedle HR systému napojíte i intranet a každý dostane vlastní pojmenovaný údaj. Když jeden systém vyřadíte nebo se jeho tajemství dostane ven, zneplatníte jen jeho údaj a ostatních integrací se to nedotkne.
• Tajemství se ztratilo. Někdo zavřel dialog dřív, než Client secret zkopíroval. Nic se nedohledává: vydáte nový údaj a starý zneplatníte.

Technicky jde vždy o totéž: dvojice se vymění za token a s ním systém volá REST API. Podrobnosti v následujících bodech.

Dvojice je to, co POST /rest/v1/auth/token očekává jako client_id a client_secret. Vrátí bearer token pro REST API — samotnou výměnu popisuje autentizace.

Údaj patří firemnímu prostoru, takže nese přístup prostoru, ne konkrétního člověka. Zrušení účtu kolegy ho neodvolá.

V osobním prostoru obrazovka ukazuje Nemáte žádné přihlašovací údaje, protože GET /api/v1/company_spaces/api_credentials odpovídá 403 — prázdný stav zastupuje odmítnutí. Týž vzorec popisují přístupové odkazy.