メインコンテンツへスキップ

API

エラーハンドリングとリトライ

変換タスクが失敗した場合や予想以上に時間がかかる場合に、予測可能な統合を構築します。

変換結果は、同期的なファイルダウンロードではなく、状態を持つジョブとして扱ってください。これにより、ソースファイルが大きい場合、利用できない場合、または不正な形式の場合でも、製品の信頼性を保つことができます。

安全にリトライする

繰り返しても安全なリクエストのみをリトライしてください。結果取得リクエストは、指数バックオフを用いてリトライできます。送信リクエストについては、別の送信を試みる前に、成功したレスポンスで返されたタスク ID を永続化してください。

終端の失敗を処理する

タスクが failed になった場合は、そのタスク ID と返された理由を、内部のジョブ ID とともにログに記録してください。フォーマットされていない API エラーをそのまま見せるのではなく、ソース URL を確認する、読み取り可能な PDF をアップロードするなど、ユーザーが実行できる次のステップを提示してください。

実用的な時間制限を設定する

製品の体験に合ったポーリング期限を設定してください。その期限でポーリングを停止し、タスク ID を保持して、バックグラウンドワーカーまたはユーザーが開始する更新によって、後で最終ステータスを確認できるようにしてください。

正確なレスポンスフィールドと失敗例については、API Reference を参照してください。