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 autentizovat 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, zavolejte API auth/login pro získání autentizační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. Nesnažte se vytvořit nový token pro každé volání.
Členové více TMS organizací mají stejné uživatelské jméno a heslo pro více účtů. Pokud jsou používány 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 se přihlásí k výchozí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 pole 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ř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žijte OAuth 2.0 v aplikacích místo odesílání tokenů s každým voláním. Phrase TMS podporuje standardní typ grant kódu autorizace OAuth 2.0.
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 Registrované aplikace OAuth.
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 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í spojení. Je uloženo v databázi a používá se k párování požadavků s příslušným žadatelem.
-
Použijte tyto URL s vygenerovaným ID klienta 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 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 pro 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, je vygenerován token Bearer pro použití v aplikaci.
Příklad použití Bearer tokenu: