ほとんどのAPI呼び出しには認証されたユーザーが必要です。APIは特別なユーザープロファイルを使用しません。各APIは、ユーザー名とパスワードを使用して、既存の任意のユーザーの代理で呼び出すことができます。
APIで認証する方法は2つあります:
-
トークンベースの認証
-
OAuth 2.0認証
トークンベースの認証
認証されたユーザーが必要なAPIを呼び出す前に、auth/login APIを呼び出して認証トークンを取得します。トークンは24時間有効で、すべての後続の呼び出しに使用できますが、ユーザーがUIを介してログアウトすると期限切れになります。すべての呼び出しごとに新しいトークンを作成しないでください。
複数のTMS組織のメンバーは、複数のアカウントに対して同じユーザー名とパスワードを持っています。複数のアカウントが使用される場合、userUidをリクエストボディに追加して、ユーザーがログインしたい組織を指定する必要があります。指定がない場合、ユーザーは指定したユーザー名とパスワードに紐づくデフォルトのアカウントにログインされます。
その後のAPI呼び出しでは、取得したトークンがAuthorizationヘッダーで使用されます。ヘッダー値フィールドは、ApiTokenで始まり、その後にスペースとトークン自体が続きます。
ユーザーがUIからログアウトすると、APIトークンは無効になります。
プロファイルがUSデータセンターにある場合は、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接続が確立されると、アプリケーションで使用するためのBearerトークンが生成されます。
ベアラートークンの使用例: