POST/api/boshu/calls/{id}/embedded/exchange
「BOSHU」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインなしで呼べる。
- 要約
本人popupで認可済みの同一募集sessionだけをPKCE verifierで交換。cookie不要。新session/本人を作らずLP親へ返さない
- 呼び方と印
認証なし・レート制限
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
proof必須string/^[a-f0-9]{64}$/
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
grantstring | null
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 403HTTP 403(x-bounty-error-codes を参照)
- 404HTTP 404(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/exchange" \
-H "Content-Type: application/json" \
-d '{
"proof": "string"
}'