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í tokenu pro ověřování. 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 UI. 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í určeno, 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.
Při 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á Space a samotným tokenem.
Pokud se uživatel odhlásí z UI, 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:
Ověřování OAuth 2.0
Použít OAuth 2.0 v aplikacích namísto odesílání tokenů při každém volání. Phrase TMS podporuje standardní authorization code grant type OAuth 2.0.
Poznámka
Přihlášení přes OAuth není podporováno pro uživatelské účty, které patří do více než jedné organizace.
Buď odebrat uživatelský účet z jedné z organizací, aby patřil pouze do jedné organizace, nebo použít 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 a klikněte na Registered OAuth Apps.
Otevře se stránka .
-
Klikněte na Nový.
Otevře se stránka .
-
Zadejte , (Callback) a volitelný .
-
Klikněte na Uložit.
Otevře se stránka se seznamem nového připojení a přidruženým .
ID se použít v aplikaci, která se připojuje k Phrase, k navázání připojení. Je uloženo v databázi a použít k párování požadavků se správným žadatelem.
-
Použít tyto adresy URL s vygenerovaným Client ID pro ověřování:
-
Auth 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řidat us. před cloud.memsource.com, například https://us.cloud.memsource.com/web/oauth/authorize
-
-
Při ověřování použít profil správce k přihlášení a kliknout na Allow.
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žít v aplikaci.
Příklad použití Bearer token: