Většina API volání vyžaduje ověřeného uživatele. API nepoužívají žádné speciální uživatelské profily. Každé API může být voláno jménem jakéhokoli existujícího uživatele pomocí jeho uživatelského jména a hesla.
Existují dva způsoby, jak se ověřit pomocí API:
-
Ověřování na základě tokenu
-
Ověřování OAuth 2.0
Ověřování na základě tokenu
Před voláním jakéhokoli API, které vyžaduje ověřeného uživatele, zavolej API auth/login pro získání ověřovacího tokenu. Token je platný po dobu 24 hodin a může být použit pro všechna následující volání, ale vyprší, pokud se uživatel odhlásí prostřednictvím UI. Nevytvářej nový token pro každé volání.
Členové více TMS organizací mají stejné uživatelské jméno a heslo pro více uživatelských účtů. Pokud se používá více účtů, musí být userUid přidán do těla požadavku, aby se specifikovalo, do které organizace se uživatel chce přihlásit. Pokud není specifikováno, uživatel je přihlášen k výchozímu uživatelskému účtu spojenému s daným uživatelským jménem a heslem.
V následujících API voláních se získaný token používá v hlavičce Authorization. Hodnota hlavičky je uvedena s ApiToken následovaným mezerou a samotným tokenem.
Pokud se uživatel odhlásí z UI, API token již nebude platný.
Pokud je profil umístěn v US DataCenter, přidej 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žij OAuth 2.0 v aplikacích místo posílání tokenů s každým voláním. Phrase TMS podporuje standardní grant typu autorizačního kódu OAuth 2.0 authorization code grant type.
Pro navázání připojení OAuth 2.0 postupuj podle těchto fází:
-
Na stránce Nastavení
přejdi dolů do sekce a klikni na Registrované OAuth aplikace.
Otevře se stránka .
-
Klikni na Nový.
Otevře se stránka .
-
Zadej , (Callback) a volitelný .
-
Klikni na Uložit.
Otevře se stránka s novým připojením v seznamu a přidruženým .
ID se používá v aplikaci, která se připojuje k Phrase pro navázání připojení. Je uloženo v databázi a používá se k párování požadavků s příslušným žadatelem.
-
Použij tyto URL s vygenerovaným Client ID pro autorizaci:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Pokud je profil umístěn v US DataCenter, přidej us. před cloud.memsource.com, například https://us.cloud.memsource.com/web/oauth/authorize
-
-
Při autorizaci použij profil správce pro přihlášení a klikni 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, je vygenerován Bearer token pro použití v aplikaci.
Příklad použití Bearer tokenu: