本文へ移動
Bounty Developer

POST/api/boshu/calls/{id}/embedded/uploads

「BOSHU」の分類の、新しく作る、または操作を実行するために内容を送る API。募集の埋め込みフォームの許可（トークン）を付けて呼ぶ。

要約

募集専用iframe内の本人画像添付。既存正規化/所有/制限を共用

呼び方と印

トークン（募集の埋め込み）・レート制限

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

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

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

  • idpath必須string(uuid)

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

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

  • file必須string(binary)
  • more任意"1"
  • parts任意string
    長さ ≤200

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

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

  • uploadobject
    • idstring
    • urlstring
    • widthinteger
    • heightinteger
  • part任意true

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/boshu/calls/{id}/embedded/uploads" \
  -H "X-Boshu-Grant: $BOSHU_GRANT" \
  -H "X-Boshu-Proof: $BOSHU_PROOF" \
  -F "file=@file"
POST /api/boshu/calls/{id}/embedded/uploads | Bounty Developer