Ověřování API (TMS)

Obsah je strojově přeložen z angličtiny s použitím Phrase Language AI.

Většina volání API vyžaduje ověřeného uživatele. API nepoužívají žádné speciální uživatelské profily. Každé API lze volat jménem jakéhokoli existujícího uživatele pomocí jeho uživatelského jména a hesla.

Existují dvě metody, jak se ověřit pomocí API:

Ověřování založené na tokenu
Ověřování OAuth 2.0

Ověřování založené na tokenu

Před voláním jakéhokoli API, které vyžaduje ověřeného uživatele, zavolejte API auth/login pro získání ověřovacího tokenu. Token je platný 24 hodin a lze jej použít pro všechna následná volání, ale vyprší, pokud se uživatel odhlásí přes uživatelské rozhraní. Nevytvářejte nový token pro každé volání.

Členové více organizací TMS mají stejné uživatelské jméno a heslo pro více uživatelských účtů. Pokud je použito více uživatelských účtů, musí být do těla požadavku přidán userUid, aby se určilo, ke které organizaci se chce uživatel přihlásit. Pokud není specifikováno, uživatel je přihlášen k výchozímu uživatelskému účtu přidruženému k danému uživatelskému jménu a heslu.

V následných voláních API se získaný token použije v hlavičce Authorization. Hodnota pole hlavičky je uvedena pomocí ApiToken následovaného Space a samotným tokenem.

Pokud se uživatel odhlásí z uživatelského rozhraní, token API již nebude platný.

Pokud se profil nachází v datovém centru v USA, přidejte us. před cloud.memsource.com, například https://us.cloud.memsource.com/web/api2/v3/auth/login.

Příklad:

ApiToken OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi

Ověřování OAuth 2.0

Použijte OAuth 2.0 v aplikacích namísto odesílání tokenů při každém volání. Phrase TMS podporuje standardní typ autorizačního kódu OAuth 2.0. Tento tok OAuth 2.0 je autorizační kód pro veřejného klienta ověřený pouze přesměrovacím URI, bez tajného klíče klienta a bez podpory PKCE (code_challenge). Před pokračováním potvrďte, že nástroj třetí strany může pracovat pouze s ID klienta a přesměrovacím URI.

Poznámka

Přihlášení přes OAuth není podporováno pro uživatelské účty, které patří do více než jedné organizace.

Buď odeberte uživatelský účet z jedné z organizací tak, aby patřil pouze do jedné organizace, nebo použijte ověřování založené na tokenu.

Pro navázání připojení OAuth 2.0 postupujte podle těchto kroků:

Na stránce nastavení přejděte dolů do sekce Integrace a klikněte na Registrované OAuth aplikace.

Otevře se stránka Registrované OAuth aplikace.
Klikněte na Nový.

Otevře se stránka Vytvořit OAuth aplikaci.
Zadejte Název, přesměrovací URI (zpětné volání) a volitelný Popis.
Klikněte na Uložit.

Otevře se stránka Registrované OAuth aplikace se seznamem obsahujícím nové připojení a přidružené ID klienta.

ID se použije v aplikaci, která se připojuje k Phrase, k navázání spojení. Je uloženo v databázi a používá se ke spárování požadavků se správným žadatelem.
Pro autorizaci použijte tyto adresy URL s vygenerovaným ID klienta:
- Autorizační URL
  
  https://cloud.memsource.com/web/oauth/authorize
- Token URL
  
  https://cloud.memsource.com/web/oauth/token
Pokud se profil nachází v datovém centru v USA, přidejte us. před cloud.memsource.com, například https://us.cloud.memsource.com/web/oauth/authorize.
Při autorizaci použijte profil správce k přihlášení a klikněte na Povolit.

Aplikace je nyní propojena a volání API pro ověřování nebude vyžadováno.

Jakmile je připojení OAuth 2.0 navázáno, vygeneruje se Bearer token pro použití v aplikaci.

Příklad použití Bearer tokenu:

Bearer OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi