ほとんどの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 接続を確立するには、以下の手順に従います。
-
設定
ページから、 セクションまでスクロールし、Registered OAuth Apps をクリックします。
ページが開きます。
-
[新規] をクリックします。
ページが開きます。
-
、 (コールバック)、およびオプションの を入力します。
-
保存をクリックします。
ページが開き、新しい接続が一覧に追加され、関連付けられた が表示されます。
この ID は、接続を確立するために Phrase に接続するアプリケーションで使用されます。これはデータベースに保存され、リクエストを適切なリクエスターとペアリングするために使用されます。
-
認証には、生成されたクライアント ID と共にこれらの URL を使用します。
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
プロファイルが米国データセンターにある場合は、cloud.memsource.com の前に us. を追加します。例: https://us.cloud.memsource.com/web/oauth/authorize
-
-
認証する際は、管理者プロファイルを使用してログインし、Allow をクリックします。
アプリケーションがリンクされ、認証 API トークン呼び出しは不要になります。
OAuth 2.0 接続が確立されると、アプリケーションで使用するための Bearer トークンが生成されます。
Bearer トークンの使用例: