ほとんどの API 呼び出しには認証されたユーザーが必要です。API は特別なユーザープロファイルを使用しません。各 API は、ユーザー名とパスワードを使用して既存の任意のユーザーの代わりに呼び出すことができます。
API で認証する方法は 2 つあります:
-
トークンベースの認証
-
OAuth 2.0 認証
トークンベースの認証
認証されたユーザーが必要な API を呼び出す前に、auth/login API を呼び出して認証トークンを取得してください。トークンは 24 時間有効で、すべての後続の呼び出しに使用できますが、ユーザーが UI 経由でログアウトすると期限切れになります。すべての呼び出しに対して新しいトークンを作成しないでください。
複数の TMS 組織のメンバーは、複数のアカウントに対して同じユーザー名とパスワードを持っています。複数のアカウントが使用される場合、userUid をリクエストボディに追加して、ユーザーがログインしたい組織を指定する必要があります。指定されていない場合、ユーザーは指定されたユーザー名とパスワードに関連付けられたデフォルトアカウントにログインします。
その後の API 呼び出しでは、取得したトークンが Authorization ヘッダーで使用されます。ヘッダー値フィールドは、ApiToken で始まり、その後にスペースとトークン自体が続きます。
ユーザーが UI からログアウトすると、API トークンは無効になります。
プロファイルが米国データセンターにある場合は、cloud.memsource.com の前に us. を追加してください。例えば、https://us.cloud.memsource.com/web/api2/v3/auth/login.
例:
OAuth 2.0 認証
アプリケーションでトークンを各呼び出しと共に送信する代わりに、OAuth 2.0を使用します。Phrase TMSは標準のOAuth 2.0 認可コードグラントタイプをサポートしています。
OAuth 2.0接続を確立するには、次の手順に従います:
-
設定
ページから、セクションまでスクロールし、登録済みOAuthアプリをクリックします。
ページが開きます。
-
新規をクリックします。
ページが開きます。
-
、(コールバック)およびオプションのを提供します。
-
保存をクリックします。
ページが新しい接続を一覧に表示し、関連するが表示されます。
IDは、Phraseに接続するアプリケーションで使用され、接続を確立します。データベースに保存され、リクエストを適切なリクエスターとペアリングするために使用されます。
-
これらのURLを生成されたクライアントIDと共に認可に使用します:
-
認証URL
https://cloud.memsource.com/web/oauth/authorize
-
トークンURL
https://cloud.memsource.com/web/oauth/token
プロファイルがUSデータセンターにある場合、cloud.memsource.comの前にus.を追加します。例えば、https://us.cloud.memsource.com/web/oauth/authorize
-
-
認可する際は、管理者プロファイルを使用してログインし、許可をクリックします。
アプリケーションは現在リンクされており、認証API呼び出しは必要ありません。
OAuth 2.0接続が確立されると、アプリケーションで使用するためのベアラートークンが生成されます。
ベアラートークンの使用例: