Using APIs (TMS)

これは、サンプルAPI呼び出しとそれらを連結して単純なアクションを完了する方法に関するシンプルなAPIシナリオです。APIを介して設定できるオプションは広範囲にわたります。利用可能なすべてのオプションについては、REST APIドキュメントの該当セクションを参照してください。

このシナリオを作成するために、Postman APIプラットフォームが使用されました。

これらの例では、標準リクエストURLはhttps://cloud.memsource.comで始まります。米国データセンターの組織がAPIを使用する場合、リクエストURLはhttps://us.cloud.memsource.comで始まる必要があります。

シナリオ

方法論

各個別のREST API呼び出しには、適切なメソッドがリストされています。不正なメソッドを使用すると（例：プロジェクト作成呼び出しでPOSTの代わりにGET）、API呼び出しが失敗します。

ステップ1:認証

認証方法は2つあります:

このシナリオでは、認証 API コールが使用されます。生成されたトークンはすべての次の API コールに必要であり、例のパラメータにはリストされていません。

認証には、必要なパラメータを使用して ログイン API を使用してください。この場合、ユーザー名 と パスワード が必要です。

複数の TMS 組織のメンバーは、複数のアカウントに対して同じユーザー名とパスワードを持っています。この場合、userUid をリクエストボディに追加して、ユーザーがログインしたい組織を指定する必要があります。指定されていない場合、ユーザーは指定されたユーザー名とパスワードに関連付けられたデフォルトアカウントにログインします。

ステップ 2:プロジェクトの作成、インポート、および割り当て

プロジェクトの作成

プロジェクト API コールを使用して、必須パラメータ 名前、ソース言語、および ターゲット言語 を使用してプロジェクトを作成します。

最後のコールからのプロジェクト UID を使用して、プロジェクトテンプレートを作成 API コールを使用してプロジェクトテンプレートを作成することができます。

プロジェクトを作成する最も効率的な方法は、プロジェクトテンプレートを使用することです。最後のコールからのプロジェクトテンプレート UID を使用して、テンプレートからプロジェクトを作成 でプロジェクトテンプレートの設定に基づいて新しいプロジェクトを作成します。

式 {templateUid} は、取得したプロジェクトテンプレート UID が挿入されるリクエスト URL のプレースホルダーとして機能します。 

ジョブの作成

最後のコールからのプロジェクト UID を使用して、新しいジョブを ジョブを作成 を使用して新しく作成されたプロジェクトに直接追加できます。

式 {projectUid} は、取得したプロジェクト UID が挿入されるリクエスト URL のプレースホルダーとして機能します。ジョブ作成 API コールを使用すると、リクエストの ヘッダー を変更して、Phrase が要求するものと一致させる必要があります（他のコールでは、Postman が自動的にリクエストに適切なヘッダーを追加します）。

すべてのインポートパラメータは、カスタム Memsource ヘッダーに挿入する必要があります。

コンテンツ-ディスポジション ヘッダーには、インポートリクエストを正しく処理するために、事前定義された形式のファイル名を含める必要があります。

ソースファイルをインポートするには、本文に移動し、バイナリを選択すると、ファイルを選択オプションが表示されます。

非同期リクエストを取得を使用して、ジョブ作成呼び出しからの非同期リクエストUIDを使用して、ジョブが正常に作成され、機能していることを確認します。

返されたジョブUIDは、プロジェクトの各ワークフローステップで一意です。したがって、ジョブがワークフローを持つプロジェクトで作成されると、応答は各ワークフローステップに対して一意のジョブUIDを返します。 

再利用可能なインポート設定は、インポート設定を作成呼び出しで構成できます。作成ジョブ呼び出しで使用できるインポート設定UIDが応答で受信されます。

プロバイダをジョブに割り当てるには（作成ジョブ呼び出しで直接割り当てられていない限り）、ジョブを編集呼び出しを使用します。

呼び出しに挿入されたプロバイダのIDは、2つの方法で取得できます：

割り当てられたユーザーに通知する

ジョブUIDは、割り当てられたユーザーに通知するコールのオプションパラメータとして使用でき、使用するメールテンプレートのIDを表すメールテンプレートパラメータと共に使用されます。これは、メールテンプレート一覧コールを使用することで取得できます。

ここが翻訳者が自分のプロファイルで作業を開始する場所であり、Phrase UIが使用されているかのように作業します。ジョブが完了すると、担当のPMが通知を受け取り、シナリオの次の部分が開始されます。コールバックは、ウェブフックを介してインターセプトされ、シナリオの次の部分を自動的に開始できますが、この例では扱いません。

ステップ3:翻訳された（完了）ファイルをダウンロードし、プロジェクトを完了に設定する

翻訳されたファイルをダウンロードする

このシナリオは、翻訳者が自分の任務を完了する（ジョブを完了としてマークする）という前提で機能しますが、完了したファイルはいつでもダウンロードでき、ジョブは完了ステータスである必要はありません。 

翻訳されたファイルをダウンロードするには、2つのAPIコールが必要です:ターゲットファイルをダウンロード（非同期）と非同期リクエストに基づいてターゲットファイルをダウンロードコール。

最初のステップは、ターゲットファイルをダウンロード（非同期）をプロジェクトUIDとジョブUIDパラメータで呼び出すことです。複数のワークフローステップを持つプロジェクトから完了したファイルをダウンロードする場合は、完了したファイルをダウンロードしたい特定のワークフローステップからのジョブUIDを使用してください。例えば、改訂ワークフローステップです。

ダウンロードターゲットファイル（非同期）コールは、翻訳を含むターゲットファイルを生成してダウンロードする非同期リクエストを開始します。レスポンス内でターゲットファイルを直接提供するのではなく、次のコールに必要なasyncRequestIdを提供します。 

レスポンスからのasyncRequestIDを使用して非同期リクエストを取得する。リクエストが完了したか確認します。非同期リクエストが完了したら、非同期リクエストに基づいてターゲットファイルをダウンロードするコールを使用してターゲットファイルをダウンロードできます。asyncRequestIdは一度だけ使用できます。ダウンロードが開始されると、asyncRequestIdは今後の使用のために無効になります。

プロジェクトを完了に設定

プロジェクトを完了するために、プロジェクト内のジョブが完了したら、必須パラメータプロジェクトUIDとステータスを使用して、プロジェクトのステータスを編集する呼び出しを行い、プロジェクト全体のステータスを完了に変更します。この変更は手動ですが、プロジェクトステータス自動化が使用されると、ステータスは自動的に変更されます。ウェブフックを待機し、受信したコールバックに基づいて他のアクションを開始することも可能です。