ほとんどの API コールは認証されたユーザーを必要とします。このAPIは特別なユーザープロファイルを使用しません。各APIは、ユーザー名とパスワードを使用して既存のユーザーに代わって呼び出すことができます。
API で認証するには 2 つの方法があります。
-
トークンベースの認証
-
OAuth 2.0認証
トークンベースの認証
認証ユーザーが必要なAPIを呼び出す前に、認証/ログインAPIを呼び出して認証トークンを取得してください。トークンの有効期間は24時間で、それ以降のすべての呼び出しに使用できますが、ユーザーがUI経由でログアウトすると期限切れになります。呼び出しごとに新しいトークンを作成しないでください。
複数の TMS 組織のメンバーは、複数のアカウントに対して同じユーザー名とパスワードを持っています。複数のアカウントを使用する場合は、リクエストボディに userUid
を追加して、ユーザーがログインする組織を指定する必要があります。指定されていない場合、ユーザーは指定されたユーザー名とパスワードに関連付けられたデフォルト アカウントにログインします。
それ以降の API コールでは、取得したトークンが Authorization
ヘッダーで使用されます。ヘッダー値フィールドは、ApiToken
、スペース、およびトークン自体で始まります。
ユーザーがUIからログアウトすると、APIトークンは無効になります。
プロファイルが米国データセンターにある場合は、cloud.memsource.comの前に.を追加します。例: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 に接続するアプリケーションで使用されます。リクエストはデータベースに蓄積され、適切なリクエスト元とペアリングするために使用されます。
-
次の URL と生成されたクライアント ID を認証に使用します。
-
認証URL
https://cloud.memsource.com/web/oauth/authorize
-
トークンURL
https://cloud.memsource.com/web/oauth/token
プロファイルが米国データセンターにある場合は、cloud.memsource.comの前に.を追加します。例:https://us.cloud.memsource.com/web/oauth/authorize
-
-
認証時には、管理者プロファイルを使用してログインし、[許可]をクリックします。
アプリケーションがリンクされ、認証 API 呼び出しが不要になります。
OAuth 2.0 接続が確立されると、アプリケーションで使用するためにトークンが生成されます。
ベアラ トークンの使用例: