本文へ移動
Bounty Developer

POST/api/auth/4s/email

「ログイン」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインなしで呼べる。

要約

メールでのログインを進める（コード送信・確認・連携の許可・やり直し）

呼び方と印

認証なし・レート制限

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

送るもの（本文）application/json

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

  • |1必須object
  • action必須"request"
  • email必須string(email)
    長さ ≤254
  • policyAgreed必須true
  • |2必須object
  • action必須"verify"
  • code必須string
    /^\d{6}$/
  • |3必須object
  • action必須"approve"
  • consent必須true
  • |4必須object
  • action必須"cancel"
  • |5必須object
  • action必須"change"
  • |6必須object
  • action必須"resend"

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

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

  • |1object
    • step"email"
  • |2object
    • callbackstring
  • |3object
    • step"code" | "consent"
    • destinationstring

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 502HTTP 502（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • forbidden
  • email_auth_unavailable
  • email_flow_expired
  • email_flow_changed
  • email_verification_required
  • invalid_registration_return
  • invalid_provider_response
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/auth/4s/email" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "request",
    "email": "user@example.com",
    "policyAgreed": true
  }'
POST /api/auth/4s/email | Bounty Developer