本文へ移動
Bounty Developer

GET/api/v1/public/events/{slug}/sponsors

「公開の読み取り」の分類の、情報を読み出す API。ログインなしで呼べる。

要約

公開中の協賛(ティアと会社)

呼び方と印

認証なし

URL に付ける値(パラメータ)

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

  • slugpath必須string
    /^[A-Za-z0-9_-]{1,100}$/

返るもの(応答)200 · application/json

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

  • schemaVersion1
  • eventobject
    • idstring(uuid)
    • slugstring
    • titlestring
  • tiersarray<object>件数 ≤20
    • numberinteger1–20
    • displayNamestring
    • sponsorsarray<object>
      • idstring(uuid)
      • companyobject
        • idstring(uuid)
        • slugstring
        • namestring
        • descriptionstring | null
        • websiteUrlstring | null
        • logoUrlstring | null
        • darkLogoUrlstring | null
      • priorityinteger | null

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 404HTTP 404(x-bounty-error-codes を参照)
  • 500HTTP 500(x-bounty-error-codes を参照)
  • event_not_found
  • invalid_query
  • internal_error

呼び出しの見本

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

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