GET/api/boshu/calls/{id}/embedded/uploads/{uploadId}
「BOSHU」の分類の、情報を読み出す API。募集の埋め込みフォームの許可(トークン)を付けて呼ぶ。
- 要約
募集専用iframeの本人添付画像。秘密をURLへ含めずproof headerで取得
- 呼び方と印
トークン(募集の埋め込み)
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)uploadIdpath必須string(uuid)
返るもの(応答)200 · image/*
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401HTTP 401(x-bounty-error-codes を参照)
- 403HTTP 403(x-bounty-error-codes を参照)
- 404HTTP 404(x-bounty-error-codes を参照)
- 428HTTP 428(x-bounty-error-codes を参照)
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl "https://bounty.spikes.4s.link/api/boshu/calls/{id}/embedded/uploads/{uploadId}" \
-H "X-Boshu-Grant: $BOSHU_GRANT" \
-H "X-Boshu-Proof: $BOSHU_PROOF"