本文へ移動
Bounty Developer

GET/api/auth/4s/email

「ログイン」の分類の、情報を読み出す API。ログインなしで呼べる。

要約

メールでのログインの今の段階（メール入力・コード入力・連携の確認）

呼び方と印

認証なし

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • returnToquery任意string

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

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

  • |1object
    • step"consent"
    • clientobject
      • namestring
      • descriptionstring | null
    • destinationstring
    • retryHrefstring
    • returnTostring
    • flowIdstring
  • |2object
    • step"email" | "code"
    • destinationstring
    • retryHrefstring
    • returnTostring
    • flowIdstring

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 502HTTP 502（x-bounty-error-codes を参照）
  • email_auth_unavailable
  • email_flow_expired
  • email_flow_changed
  • invalid_provider_response

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/auth/4s/email"
GET /api/auth/4s/email | Bounty Developer