本文へ移動
Bounty Developer

GET/api/planning/blocks/{contentId}/thumbnail/{format}

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

要約

今のデザインの PNG（その場で描く。下書きも見られる。企画できる人だけ。w を渡すとその幅へ縮めた見本、type=jpeg / webp で軽い見本〔応答は image/jpeg・image/webp〕）

呼び方と印

ログイン・レート制限

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

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

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

  • contentIdpath必須string(uuid)
  • formatpath必須enum(6)
    • "story"
    • "portrait"
    • "square"
    • "landscape"
    • "classic"
    • "ogp"
  • wquery任意integer
    320–1920
  • typequery任意"png" | "jpeg" | "webp"

返るもの（応答）200 · image/png

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 501HTTP 501（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • unauthorized
  • forbidden
  • content_not_found

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/planning/blocks/{contentId}/thumbnail/{format}" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/planning/blocks/{contentId}/thumbnail/{format} | Bounty Developer