本文へ移動
Bounty Developer

POST/api/planning/{eventId}/stages/register

「コンテンツ企画」の分類の、新しく作る、または操作を実行するために内容を送る API。ブラウザでログインした本人（cookie）として呼ぶ。

要約

運営 admin のブラウザ操作で active な主 Tokyo イベントの Stage A / B を登録する。同名の実ルームを再利用し、既存ステージと 4S 対応は保持する

呼び方と印

ログイン（cookie）・レート制限

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

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

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

  • eventIdpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • (本文)必須object

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

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

  • eventIdstring(uuid)
  • revinteger≥0
  • createdinteger0–2
  • stagesarray<object>件数 2
    • idstring(uuid)
    • codestring
    • namestring

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • unauthorized
  • forbidden
  • invalid_input
  • invalid_origin
  • consent_required
  • session_required
  • event_not_found
  • exhibit_event_not_supported
  • planning_event_not_supported
  • stage_identity_conflict
  • payload_too_large
  • rate_limited
  • rate_limit_unavailable

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/planning/{eventId}/stages/register" \
  -b "bounty_session=$COOKIE_AUTH" \
  -H "Content-Type: application/json" \
  -d '{}'
POST /api/planning/{eventId}/stages/register | Bounty Developer