REST APIリファレンス

APIの共通仕様

HTTPメソッドについて

APIでは、用途に応じて以下のHTTPメソッドを使用します。
HTTPメソッド 用途
GET 既存のリソースの情報を取得。
POST 新規リソースの作成。
PUT 既存のリソースを編集。
DELETE 既存のリソースを削除。

JSONについて

  • APIでは、JSON 形式をサポートします。

  • JSON の仕様
    RFC4627 に準拠します。

  • 文字エンコーディング
    文字列のエンコーディングはすべてUTF-8 とします。

リクエスト形式

  • URL
    URL、およびクエリ文字列について、大文字・小文字を区別します。

  • HTTP メッセージボディ
    HTTPメッセージボディについて、大文字・小文字を区別します。

レスポンス形式

共通のHTTPステータスコード

API の成功・失敗は、HTTPステータスコードで通知します。 全APIで共通のHTTPステータスコードは次の通りです。

コード 意味 説明
4xx系 Client Error クライアントからのリクエストに誤りがあった場合に返されます。 クライアントからのリクエストを正しく修正して再リクエストを行ってください。
400 Bad Request リクエストJSON、クエリー文字列などのHTTPリクエストの文法に誤りがある場合と、文法が正しい場合でも、指定したパラメータが許容される範囲を超えている場合に返されます。HTTPリクエストの文法および、指定パラメータ値を修正して再リクエストしてください。
404 Not Found 指定されたリソースが見つからない場合に返されます。
405 Method Not Allowed 要求したリソースがサポートしていない HTTP メソッドを利用した場合に返されます。
5xx系 Server Error サーバ内部にエラーが発生した場合に返されます。HTTPステータスコードにより再リクエストの可否が違うので、各WebAPIの仕様を確認してください。
500 Internal Server Error API 実行時に予期しないエラーが発生した場合に返されます。問題を修正するまで再リクエストすることはできません。
503 Service Unavailable サービスが一時的に過負荷で使用不可能である場合に返されます。時間経過により負荷が下がった場合は、再リクエストすることが可能です。

注: 上記以外にも各 API で HTTP ステータスコードを定義します。API固有のエラーは各 API の仕様を参照してください。

提供 API