本文へ移動
Bounty Developer

GET/api/boshu

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

要約

公開中で締切前の募集（受付中・受付前）と、自分の応募すべて（状態は結果を知らせた後だけ決定が出る）。?ownerKind=&ownerId= で持ち主の募集だけ（承認済み・承認不要と、機能 boshu が ON のイベントの募集だけが出る）

呼び方と印

ログイン・ポーリング

画面が一定の間隔で呼び直す前提の API（ポーリング）。

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

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

  • ownerKindquery任意enum(5)
    • "platform"
    • "event"
    • "guild"
    • "venture"
    • "person"
  • ownerIdquery任意string(uuid)

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

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

  • revinteger
  • callsarray<object>
    • idstring
    • thumbnailUrl任意string
    • hasKeyVisual任意boolean
    • applicantKind任意"individual" | "guild" | "venture"
    • groupSubmissionPolicy任意"managers" | "confirmed_members"
    • template任意string | null
    • profilePolicy任意"kind" | "basic" | "required"
    • portfolioRequired任意boolean
    • mode任意"review" | "first_come"
    • applicationFields任意object | null
      • headline任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • message任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • links任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • portfolio任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
    • messagePolicy任意"legacy" | "required" | "optional" | "off"
    • audience"all" | "student" | "professional"
    • kind"staff" | "talk" | "pitch" | "other"
    • kindLabelstring
    • titlestring
    • descriptionstring | null
    • requirementsstring | null
    • capacityinteger | null
    • remaininginteger | null
    • remainingLabelstring
    • talkMinutesinteger | null
    • opensAtstring
    • closesAtstring
    • phase"hidden" | "upcoming" | "open" | "closed"
    • closingSoonboolean
    • countdownstring
    • paidboolean
    • compensationstring | null
    • ribbonLabelstring | null
    • sessionobject | null
      • idstring
      • titlestring
      • startsAtstring
      • durationMininteger
      • dayLabelstring
      • rangestring
      • roomNamestring | null
    • questionCountinteger
    • mineobject | null
      • applicantOrg任意object | null
        • kind"guild" | "venture"
        • idstring
        • namestring
        • logoUrlstring | null
      • idstring
      • callIdstring
      • headlinestring | null
      • messagestring
      • linksarray<object>
        • urlstring
        • labelstring | null
      • portfolioItemIdsarray<string>
      • answersrecord<string | array<string> | boolean>
      • statusobject
        • kindenum(5)"pending" "accepted" "waitlisted" "rejected" "withdrawn"
        • labelstring
        • positioninteger | null
      • canWithdrawboolean
      • canEditboolean
      • inSelectionboolean
      • createdAtstring
      • updatedAtstring
    • ownerobject
      • kindenum(5)"platform" "event" "guild" "venture" "person"
      • idstring | null
      • namestring
      • hrefstring | null
  • minearray<object>
    • applicantOrg任意object | null
      • kind"guild" | "venture"
      • idstring
      • namestring
      • logoUrlstring | null
    • idstring
    • callIdstring
    • headlinestring | null
    • messagestring
    • linksarray<object>
      • urlstring
      • labelstring | null
    • portfolioItemIdsarray<string>
    • answersrecord<string | array<string> | boolean>
    • statusobject
      • kindenum(5)"pending" "accepted" "waitlisted" "rejected" "withdrawn"
      • labelstring
      • positioninteger | null
    • canWithdrawboolean
    • canEditboolean
    • inSelectionboolean
    • createdAtstring
    • updatedAtstring
    • callobject
      • idstring
      • kind"staff" | "talk" | "pitch" | "other"
      • kindLabelstring
      • titlestring
      • closesAtstring
      • phase"hidden" | "upcoming" | "open" | "closed"
      • sessionobject | null
        • idstring
        • titlestring
        • startsAtstring
        • durationMininteger
        • dayLabelstring
        • rangestring
        • roomNamestring | null

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • invalid_query

呼び出しの見本

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

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