APIエラーコードの理解は、APIを利用する際に非常に重要です。
エラーコードはリクエストが成功しなかった理由を示し、問題の原因と解決策を見つける手助けをします。
以下に、一般的なAPIエラーコードをメモしておきます。
200系: 成功ステータス
- 200 OK
リクエストが正常に処理されたことを示します。サーバーから期待するレスポンスが返されます。
400系: クライアントエラー
- 400 Bad Request
リクエストに誤りがあり、サーバーが処理できない場合に発生します。例えば、必要なパラメータが欠落している、またはデータ形式が不適切な場合です。 - 401 Unauthorized
認証が不足しているか、無効な認証情報が提供された場合に発生します。APIキーやトークンの確認が必要です。 - 403 Forbidden
サーバーがリクエストを拒否している場合に発生します。認証は済んでいるが、リクエストしたリソースへのアクセス権がない場合などが考えられます。 - 404 Not Found
リクエストしたリソースが見つからない場合に返されます。エンドポイントURLが間違っている場合や、リソースが存在しない場合に発生します。 - 405 Method Not Allowed
エンドポイントがサポートしていないHTTPメソッド(例えば、POSTではなくGETを要求)を利用した場合に発生します。 - 429 Too Many Requests
短期間に過剰なリクエストが送信されたため、レート制限を超えたときに返されます。しばらく待ってから再リクエストするか、リクエスト頻度を調整する必要があります。
500系: サーバーエラー
- 500 Internal Server Error
サーバーで予期しないエラーが発生した場合に返されます。API提供側に問題がある可能性が高いです。 - 502 Bad Gateway
サーバーが不正なレスポンスを受け取った場合に返されます。ネットワークやプロキシ、API提供側のサーバーに問題がある可能性があります。 - 503 Service Unavailable
サーバーが一時的に利用不可である場合に返されます。サーバーが過負荷状態にあるか、メンテナンス中であることを示しています。 - 504 Gateway Timeout
リクエストがタイムアウトし、サーバーが一定の時間内に応答しなかった場合に発生します。サーバーが処理に時間を要している場合やネットワーク遅延の可能性があります。