ほとんどの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ログインは、複数の組織に属するユーザーアカウントではサポートされていません。
ユーザーアカウントをいずれかの組織から削除して1つの組織のみに属するようにするか、代わりにトークンベースの認証を使用してください。
OAuth 2.0接続を確立するには、以下の手順に従います:
-
設定
ページから、セクションまでスクロールし、Registered OAuth Appsをクリックします。
ページが開きます。
-
[新規] をクリックします。
ページが開きます。
-
、(コールバック)、およびオプションのを入力します。
-
保存をクリックします。
ページが開き、一覧に新しい接続と関連付けられたが表示されます。
このIDは、Phraseに接続するアプリケーションで使用され、接続を確立します。これはデータベースに保存され、リクエストを適切なリクエスターとペアリングするために使用されます。
-
これらのURLを生成されたClient IDと共に使用して認証を行います:
-
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
-
-
認証を行う際は、管理者プロファイルを使用してログインし、Allowをクリックします。
アプリケーションがリンクされ、認証API呼び出しは不要になります。
OAuth 2.0接続が確立されると、アプリケーションで使用するためのBearerトークンが生成されます。
Example usage of Bearer token: