Většina volání API vyžaduje ověřeného uživatele. API nepoužijí žádné speciální profily uživatelů. Každé API lze volat jménem libovolného stávajícího uživatele pomocí jeho uživatelského jména a hesla.
Existují dva způsoby ověřování pomocí API:
-
Ověřování pomocí tokenu
-
Ověřování OAuth 2.0
Ověřování pomocí tokenu
Před voláním API, které vyžaduje ověřeného uživatele, zavolejte do API auth/login, abyste získali ověřovací token. Token je platný 24 hodin a lze ho použít pro všechna další volání. Zbývá však, pokud se uživatel odhlásí pomocí uživatelského rozhraní. vytvořit nový token pro každé volání.
Členové více organizací TMS mají stejné uživatelské jméno a heslo pro více účtů. Pokud se používá více účtů, musí být do subjektu požadavku přidáno userUid, které určí, ke které organizaci se chce uživatel přihlásit. Není-li zadáno, je uživatel přihlášen k výchozímu uživatelskému účtu spojenému se zadaným uživatelským jménem a heslem.
Při následujících voláních API se získaný token použije v hlavičce Autorizace. Pole hodnota hlavičky se vloží do ApiTokenu 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 nás 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 v aplikacích OAuth 2.0 namísto odesílání tokenů s každým voláním. Phrase TMS podporuje standardní typ udělování autorizačního kódu OAuth 2.0.
Připojení OAuth 2.0 vytvoříte takto:
-
Na stránce Nastavení
přejděte dolů do oddílu 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řiřazeným .
ID se použije v aplikaci, která se připojuje k Phrase, aby vytvořila spojení. Je uložen v databázi a slouží ke spárování požadavků s příslušným žadatelem.
-
S vygenerovaným ID klienta použijte tyto adresy URL:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
URL tokenu
https://cloud.memsource.com/web/oauth/token
Pokud se profil nachází v datovém centru v USA, přidejte nás před cloud.memsource.com, například https://us.cloud.memsource.com/web/oauth/authorize
-
-
Při autorizaci použijte profil správce, přihlaste se a klikněte na Povolit.
Aplikace je nyní propojena a nebude vyžadováno volání API pro ověřování.
Po vytvoření připojení OAuth 2.0 se vygeneruje token Bearer, který se použije v aplikaci.
Příklad použití tokenu Bearer: