APIコールのセットが利用可能で、次のことができます：
-
Phraseと任意のサードパーティソフトウェア（翻訳管理ツール、CMSなど）の統合
-
翻訳者の仕事用ワークベンチの開発。CAT Editorは公開APIの上に構築されています。
-
Phraseをバックエンドに使用して新しいツールまたはサービスを作成する。
基本ワークフロー
手順とワークフローは、APIを使う前に理解しておく必要がある。関連するAPIを実装する前に、Phraseの手順に慣れておくことをお勧めします。
基本的なワークフローは次のとおりです：
-
TM、TBを作成して、必要に応じて機械翻訳エンジン<3>}を追加します。
-
必要に応じて、TM/TB/機械翻訳エンジンを設定したプロジェクトを作成します。
-
プロジェクトをプロジェクトテンプレートとして保存し、新しい翻訳プロジェクトを作成するために再利用します。
-
翻訳のためにプロジェクトにファイルをアップロードし、ジョブを作成します。
非同期API
非同期APIは常に同期APIよりも優先して使用すべきです。同期APIを呼び出す場合、大量のファイルや単一の大きなファイルを処理する際、タイムアウトによるレスポンスが返される可能性があります。同期APIは小さいファイルや小規模な統合機能に対してのみ使用すべきです。
ポーリング
非同期APIを呼び出すと、リクエストIDを含む即時応答が返されます。この識別子を使用して、getAsyncRequestを呼び出してリクエストのステータスを確認し、asyncResponseフィールドを確認します。このポーリング方式では、nullでないasyncResponseが受信される前に、複数のgetAsyncRequest呼び出しが発生する可能性があります。
コールバック
ポーリング方式の欠点を補うため、すべての非同期APIでコールバックが利用可能になっています。非同期リクエストを呼び出す際は、非同期リクエストによって開始された作業が完了した後に呼び出されるURL（callbackUrlパラメータ内）を指定します。
コールバックはHTTP POSTでリクエストされ、データはJSON形式のボディで送信されます。JSONオブジェクトには常に次の情報が含まれます：
-
非同期リクエストに関する情報（getAsyncRequestを呼び出すときと同じ）。
-
アクションの結果に関する詳細情報（たとえば、完全な解析やジョブの詳細など）。
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
コールバックURLにアクセスできない場合、リクエストは2分、4分、8分、16分、30分後に再試行され、計10回の再試行が失敗するまでこれを繰り返します。
コールバックURLは、成功と見なされるために200 OKのHTTPステータスコードで応答しなければなりません。