ほとんどの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 authorization code grant type をサポートしています。この OAuth 2.0 フローは、クライアントシークレットや PKCE (code_challenge) サポートなしで、リダイレクト URI のみで検証されるパブリッククライアントの認可コードグラントです。続行する前に、サードパーティツールが Client ID とリダイレクト URI だけで動作することを確認してください。
備考
OAuth ログインは、複数の組織に属するユーザーアカウントではサポートされていません。
いずれかの組織からユーザーアカウントを削除して 1 つの組織のみに属するようにするか、代わりにトークンベースの認証を使用してください。
OAuth 2.0 接続を確立するには、次の手順に従います。
-
Settings
ページから、 セクションまでスクロールダウンし、Registered OAuth Apps をクリックします。
ページが開きます。
-
[新規] をクリックします。
ページが開きます。
-
、(コールバック)、およびオプションの を入力します。
-
保存をクリックします。
ページが開き、新しい接続が一覧に追加され、関連付けられた が表示されます。
この ID は、Phrase に接続するアプリケーションで使用され、接続を確立します。これはデータベースに保存され、リクエストを適切なリクエスターとペアリングするために使用されます。
-
認証には、生成された Client ID とともにこれらの URL を使用します。
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
プロファイルが US DataCenter にある場合は、cloud.memsource.com の前に us. を追加します。例: https://us.cloud.memsource.com/web/oauth/authorize。
-
-
認証する際は、Administrator プロファイルを使用してログインし、Allow をクリックします。
アプリケーションがリンクされ、認証 API 呼び出しは不要になります。
OAuth 2.0接続が確立されると、アプリケーションで使用するためのBearerトークンが生成されます。
Bearerトークンの使用例: