API 共通仕様

リクエスト

API ごとにリクエスト先の URL と使用可能なメソッド、必要なリクエストパラメータが定められています。

リクエストボディ

リクエストボディには次の形式の JSON オブジェクトを使用します。
リクエストパラメータの文字コードには UTF-8 を、改行コードには CR+LF または LF を使用します。

{
  "key1": value1,
  "key2": value2
}

レスポンス

HTTPレスポンスコード

以下のようなHTTPレスポンスコードを返す可能性があります1。

コード 説明
2xx リクエストの成功。
3xx API仕様などの変更によりリダイレクトを要求しています。リダイレクト先にアクセスして下さい。
400 不正なリクエストパラメータ、リクエストボディを指定しています。
401 認証に失敗しました。認証トークンが無効です。
404 存在しないURL、リソースにアクセスしています。
405 許可されていないメソッドを指定しています。
500 API の問題により、リクエストを処理できませんでした。
その他 API の問題により、リクエストを処理できませんでした。

失敗時レスポンス

バリデーションエラーの場合は、http 4xx にて、エラー理由を含むjsonを返却します。

例

{
  "detail": [
    {
      "loc": [
        "body",
        "delivery",
        "condition",
        "trigger",
        "period",
        0,
        "__root__"
      ],
      "msg": "start date must be greater than or equal current date",
      "type": "value_error"
    },
    {
      "loc": [
        "body",
        "delivery",
        "message",
        0,
        "__root__"
      ],
      "msg": "image_url, title and body are invalid combination.",
      "type": "value_error"
    }
  ]
}

  1. 現在、503 (サービス利用不可) を返すケースは想定されていませんが、APIの負荷状況によってアクセストークンごとのリクエスト頻度制限を実装する可能性があります。 ↩