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