本文へ移動
Bounty Developer

GET/api/events/create

「イベント」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

本人の4Sイベント作成結果。requestId指定時は同じ送信の結果だけを確認し、POSTを再送しない

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • requestIdquery任意string(uuid)

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • |1object
    • enabledboolean
    • receiptsarray<object>件数 ≤20
      • requestIdstring(uuid)
      • state"sending" | "succeeded" | "uncertain" | "rejected"
      • titlestring長さ ≤200
      • foursEventIdstring | null
      • manageUrlstring(uri) | null
      • createdAtstring(date-time)
  • |2object
    • receiptobject
      • requestIdstring(uuid)
      • state"sending" | "succeeded" | "uncertain" | "rejected"
      • titlestring長さ ≤200
      • foursEventIdstring | null
      • manageUrlstring(uri) | null
      • createdAtstring(date-time)

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • invalid_request_id
  • event_create_receipt_not_found
  • rate_limit_unavailable

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl "https://bounty.spikes.4s.link/api/events/create" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/events/create | Bounty Developer