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 pro ověřování 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 pro určení, 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.
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ého 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ů s každým voláním. Phrase TMS podporuje standardní typ autorizačního kódu 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 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 s novým připojením v seznam 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žen v databázi a používá se ke spárování požadavků se správným žadatelem.
-
Použít tyto adresy 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 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 autorizaci použít profil správce pro 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žití v aplikaci.
Příklad použití Bearer tokenu: