POST/api/speaker-preview/{token}/photo-draft
「登壇者の限定リンク」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインなしで呼べる。
- 要約
本人が未採用の写真を準備する。提案は変更せず、同じリンク・提案専用の10分以内のreceiptを返す(multipart file、WebP変換、4 MB maximum)
- 呼び方と印
認証なし・レート制限
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
tokenpath必須string/^[A-Za-z0-9_-]{43}$/
送るもの(本文)multipart/form-data
送る本文の欄。「必須」の印がある欄は省けない。
file必須string(binary)
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
imageIdstring(uuid)receiptstring長さ 1–2048
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 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 付き)
- 501HTTP 501(x-bounty-error-codes を参照)
- 503HTTP 503(x-bounty-error-codes を参照)
- preview_link_invalid
- rate_limited
- rate_limit_unavailable
- invalid_origin
- preview_link_read_only
- proposal_required
- multipart_required
- invalid_multipart
- file_required
- empty_file
- image_too_large
- invalid_image
- storage_not_configured
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/speaker-preview/{token}/photo-draft" \
-F "file=@file"