本文へ移動
Bounty Developer

POST/api/boshu/contact/verify

「BOSHU」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

本人と4S資格に結び付いた確認コードで募集連絡先を確定する

呼び方と印

ログイン・レート制限

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

送るもの(本文)application/json

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

  • challengeId必須string(uuid)
  • nonce必須string
    長さ ≤40

返るもの(応答)200 · application/json

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

  • revisioninteger≥0
  • verifiedboolean
  • suppressedboolean
  • maskedEmailstring | null
  • digestEnabledboolean
  • configuredboolean
  • pendingChallengeIdstring(uuid) | null
  • pendingExpiresAtstring(date-time) | null

失敗したとき(エラー)

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

  • 400HTTP 400(x-bounty-error-codes を参照)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403HTTP 403(x-bounty-error-codes を参照)
  • 409HTTP 409(x-bounty-error-codes を参照)
  • 410HTTP 410(x-bounty-error-codes を参照)
  • 413HTTP 413(x-bounty-error-codes を参照)
  • 428HTTP 428(x-bounty-error-codes を参照)
  • 429レート制限(Retry-After 付き)
  • 503HTTP 503(x-bounty-error-codes を参照)
  • invalid_input
  • human_action_required
  • contact_identity_unverified
  • contact_identity_changed
  • contact_changed
  • contact_confirmation_limit
  • consent_required

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/boshu/contact/verify" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "challengeId": "00000000-0000-4000-8000-000000000000",
    "nonce": "string"
  }'
POST /api/boshu/contact/verify | Bounty Developer