本文へ移動
Bounty Developer

POST/api/orgs/images

「学生団体・ベンチャー」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

団体・会社の画像（ロゴ・カバー・作品）を上げる（WebP に書き直しメタデータを落とす）

呼び方と印

ログイン・レート制限

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

送るもの（本文）multipart/form-data

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

  • file必須string(binary)
  • kind必須"org_logo" | "org_cover" | "org_work"

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

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

  • imageobject
    • idstring
    • kind"org_logo" | "org_cover" | "org_work"
    • urlstring
    • widthinteger
    • heightinteger

失敗したとき（エラー）

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

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

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/orgs/images" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -F "file=@file" \
  -F "kind=org_logo"
POST /api/orgs/images | Bounty Developer