本文へ移動
Bounty Developer

GET/api/portfolio/files/{userId}/{purpose}/{name}

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

要約

ポートフォリオのファイル（BOUNTY が正本のとき。本人と、作品を見られる参加者だけ。Range 対応・公開 URL は無い）

呼び方と印

ログイン・レート制限

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

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

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

  • userIdpath必須string(uuid)
  • purposepath必須"media" | "poster" | "document"
  • namepath必須string
    /^[A-Za-z0-9][A-Za-z0-9._-]{0,119}$/

返るもの（応答）200 · */*

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 429レート制限（Retry-After 付き）
  • portfolio_file_not_found
  • storage_not_configured
  • portfolio_unavailable
  • rate_limited

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/portfolio/files/{userId}/{purpose}/{name}" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/portfolio/files/{userId}/{purpose}/{name} | Bounty Developer