代表的なHTTPステータスコードと問題解決へのヒント

APIを利用したリクエストは、HTTPメソッドで行います。HTTPリクエストを送ると、その応答としてレスポンスが返ってきます。

レスポンスには「HTTPステータスコード」が含まれています。レスポンスに含まれるHTTPステータスコードの値によって、リクエストが成功したのか、失敗したのかを把握することができ、開発しているアプリに不具合が発生した時の原因切り分けなどに参考となります。

新しいアプリケーションの実装中やアプリケーション利用開始後はエラーの際のステータスコードとリクエストID(いづれの情報もHTTPレスポンスヘッダーに含まれます)を監視・保存して、原因分析の切り分けに利用することを推奨します。

ここでは、代表的なHTTPステータスコードをご紹介します。

200番台のステータス(成功)

リクエストが成功したことを示すために利用されます。
代表的な200番台のステータスコードは以下です。

  • 200 OK: 主に GET, PUT リクエストが成功したときに利用されます。
  • 201 Created: リクエストが成功し、新たにリソースが作成されたことを表します。主に POST リクエストの成功時に利用されます。
  • 204 No Content: リクエストは成功し、返すリソースがない場合に利用されます。リソースの削除を行った際などに204のレスポンスコードが返ってきます。

400番台のステータスコード(エラー)

クライアント側(リクエストを送る側)に問題があるときに利用されます。
リクエストするURLやパラメータに不備が無いかご確認下さい。
代表的な4XX系ステータスコードは以下です。

  • 400 Bad Request: リクエストパラメータに不足・不備がある場合に利用されます。
  • 401 Unauthorized: アクセストークンが無効なときなど、認証がされていないときに利用されます。
  • 403 Forbidden: リクエストによる操作権限が無い(認可されていないとき)に利用されます。
  • 404 Not Found: リクエストされたリソースが存在しないときに利用されます。

freee APIから上記が含まれるレスポンスを受け取った場合、以下の情報をご参照ください。

500番台のステータスコード(エラー)

リクエストを受ける側、サーバー側に問題があるときに利用されます。
しばらく時間を置いて再度リクエストお願いします。
長時間解消されないときはお問い合わせください。
代表的な5XX系ステータスコードは以下です。

  • 500 Internal Server Error: 何らかのエラーがサーバー側で発生しているときに利用されます。

より詳細については、以下の情報をご参照ください。