本文へ移動
Bounty Developer

POST/api/orgs/logo-variants

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

要約

ロゴ版を追加。SVGは正規化した原素材と別WebPプレビューに分けて私有保存

呼び方と印

ログイン・レート制限

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

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

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

  • purpose必須"square" | "wordmark" | "light" | "dark"
  • label必須string
    長さ ≤60
  • kind必須"guild" | "venture"
  • orgId必須string(uuid)
  • file必須string(binary)

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

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

  • variantobject
    • idstring(uuid)
    • purpose"square" | "wordmark" | "light" | "dark"
    • labelstring
    • ordinalinteger
    • revisioninteger
    • previewImageIdstring(uuid)
    • previewUrlstring
    • sourceUrlstring | null

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • org_forbidden
  • org_not_found
  • logo_variant_not_found
  • logo_variant_limit
  • logo_variant_invalid
  • revision_conflict
  • image_not_found
  • invalid_input
  • invalid_origin
  • multipart_required
  • invalid_multipart
  • file_required
  • empty_file
  • image_too_large
  • unsupported_image
  • invalid_image
  • svg_too_large
  • svg_dimensions_invalid
  • storage_not_configured
  • guild_synced
  • consent_required

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/orgs/logo-variants" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -F "purpose=square" \
  -F "label=string" \
  -F "kind=guild" \
  -F "orgId=00000000-0000-4000-8000-000000000000" \
  -F "file=@file"
POST /api/orgs/logo-variants | Bounty Developer