コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

API リファレンス

エラーとステータスコード

失敗したリクエストの原因を見つけて、修正、待機、または再試行するかどうかを決定します。

このページの内容

HTTPステータスコード

HTTP ステータスで起動し、エラーコードと特定の原因のメッセージを読みます。

ステータス意味する対処方法
400無効な要求再試行する前に、ソース、必要なフィールド、パラメータタイプ、または応答ヘッダーを修正します。
401認証失敗X-API-Keyをチェックしてください。 期限切れまたは再発されたキーを置換します。同じキーを再試行することは助けません。
402不十分なクレジット口座残高を確認してください。 クレジットを追加したり、アカウント所有者が再度送信する前にアクセスを解決できるようにします。
403アクセス拒否キーのソース権限とアカウントまたはサブスクリプションステータスを確認します。
404見つかりませんでしたURL、ジョブID、アカウントを確認します。 許可されているアカウントやソースの外部のジョブは、404を返すこともできます。
406応答のタイプ 受け入れられないAccept:application/jsonかtext/plain.を使用して下さい Markdown を X-Respond-With: マークダウンで選択します。
409結果は準備が整っていない / 競合結果は読み込まれるまで、既存のジョブをポーリングします。 ほかのエンドポイントでは、身体に記述されている競合を解決します。
410結果が期限切れとなった保存したコピーを使用してください。 結果の回復 URL 期限切れの結果を復元することができません。
422無効な入力/失敗したジョブ報告されたフィールドを修正します。 その結果、job.error: 失敗したジョブは、フェッチする成功の結果はありません。
429限界に達しましたRetry-After または retry_after を待ってください。 レートを削減します。 完全な保留キューを要求するには、既存のジョブを finish に待ちます。
500 / 502 / 503 / 504サービスまたは上流の失敗リトリーはバインドされたバックオフで読みます。 POST または送信タイムアウトの場合は、再度送信する前に作業が受け入れられているかどうかを確認してください。

エラー応答を読む

API エラーは、テキストをリクエストする際に、JSON を使用します。 ボディはエンドポイントによって異なります。 現時点でのHTTPステータスとコードのブランチ; 問題を説明するためにメッセージや詳細を使用してください。

クエリエラーは、一般的にエラーとメッセージが含まれている。コードはオプションである。 認証エラーは、error: trueの代わりにsuccess: falseを使うことができます。

400 · application/json
{
  "error": true,
  "code": "unsupported_representation",
  "message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}

ステータス、ヘッダ、ボディを調べる

curl --includeを3つすべて見るために使用して下さい。 この例では、キーをフリーアカウントで読み取ります。 クエリを送信しません。 環境でFLASHDATA_API_KEYを最初に設定します。

応答の点検 · cURL/Bash
curl --include --silent --show-error --max-time 20 \
  'https://api.flashdata.dev/v2/api-access/identity' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

再試行するとき

POSTを繰り返して、別の課金クエリを作成できます。 ネットワークタイムアウトは、最初のリクエストが拒否されたことを証明しません。 受け取るとすぐにジョブIDを保存します。

投稿ナビゲーション次のアクション
無効な入力、キー、パーミッション、残高ストップ。 再試行する前に、またはアカウントの状態を要求するのを修正します。これらのエラーをループしないでください。
429 待機ヒントRetry-After (秒またはHTTP日付)、またはJSON retry_after値秒単位で取得します。 両方が存在する場合は、より長い遅延を使用してください。
読む: 429/一時的な5xx/ネットワークの間違い同じ GET を再試して下さい。 ウェイトヒントがなければ、ジッタで増加する遅延、最大試行回数と制限時間を使用します。
POSTのタイムアウトかあいまい5xxID の既存のジョブを保ち、そのステータスを確認してください。 IDが届かない場合は、再度応募を決定する前に履歴を調べてください。

背景ジョブをチェックする

ステータスエンドポイントから HTTP 200 は、読み込みが成功することを意味します。 job.statusをチェックして、タスクが成功しているかどうかを確認します。 JOB_IDを既存のジョブに設定します。このコマンドは置換を提出しません。

job.status対処方法
pending / processing待ってから、同じジョブをポーリングします。 結果は、完了まで 409 を返します。
completed結果を取り出し、保存します。 元の JSON 結果は 302 の貯蔵のリダイレクトを戻します; 整形された結果はボディを直接戻します。
failedjob.errorのポーリングを止め、点検して下さい。 結果エンドポイントは、失敗したジョブのコードresult_not_readyで422を返します。
求人情報・cURL・Bash
curl --fail-with-body --silent --show-error --max-time 30 \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

応答フォーマットエラー

ステータス/コードフィックス
400 · unsupported_representationX-Respond-With をマークダウンに設定するか、ヘッダーを削除します。
406 · not_acceptableAccept を application/json または text/plain に設定します。 charset を指定すると、UTF-8 を使用します。

リクエストでヘルプを入手

エンドポイント、UTC のタイムスタンプ、HTTP のステータス、エラーコード、リクエスト、または ID のジョブを送信します。 APIキー、トークンを削除し、レポートからURLsに署名しました。