API コールのセットを使用すると、次のことが可能になります。
-
phraseとサードパーティソフトウェアの統合機能(翻訳管理ツール、CMSなど)
-
翻訳者のワークベンチの開発。CATエディタは、パブリック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 にアクセスできない場合、リクエストは 2、4、8、16、および 30 分後に、10 回のリトライが失敗するまで繰り返されます。
コールバック URL が 200 OK HTTP ステータス コードで応答しなければ、成功とはみなされません。