本文へ移動
Bounty Developer

GET/api/v1/boshu/events/{slug}/forms

「BOSHU の外部 API」の分類の、情報を読み出す API。ログインなしで呼べる。

要約

イベントの公開中の団体フォーム（パートナー登録 = a+b+c・GUILD ROYALE などの企画募集 = a+b+c+d）の id・題・段階・BOUNTY のフォームの URL を匿名で読む（下書き・申請者・回答なし）。ASSEMBLE が id を書き込まずに入口から BOUNTY のフォームへ送るため

呼び方と印

認証なし・レート制限

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

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

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

  • slugpath必須string

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

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

  • version1
  • eventobject
    • slugstring
    • titlestring
  • partnerobject | null
    • idstring(uuid)
    • titlestring
    • templatestring
    • pattern"partner" | "royale"
    • phase"upcoming" | "open" | "closed"
    • pathstring/^\/forms\/partners\/[0-9a-f-]{36}$/
    • urlstring(uri)
  • programmesarray<object>件数 ≤20
    • idstring(uuid)
    • titlestring
    • templatestring
    • pattern"partner" | "royale"
    • phase"upcoming" | "open" | "closed"
    • pathstring/^\/forms\/partners\/[0-9a-f-]{36}$/
    • urlstring(uri)

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • event_not_found
  • rate_limited

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/v1/boshu/events/{slug}/forms"
GET /api/v1/boshu/events/{slug}/forms | Bounty Developer