ログイン
アプリや画面がログインするための API。4S のアカウント(メールでのログインや認可コード)で本人を確かめ、BOUNTY のアプリ用のトークンを受け取る。トークンの更新とログアウト、アプリの中の WebView にログインを引き継ぐ入口もここにある。
この分類のあらまし
- 誰が呼べるか
ログインの前に呼ぶ入口なので、ほとんどは認証なしで呼べる。WebView にログインを引き継ぐ入口だけは、ログイン済みの本人が呼ぶ。
ログイン 1 件・認証なし 9 件
- 件数と印
この分類の API は 10 件・レート制限 7 件
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
認証(ネイティブ)
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API10 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 4S の認可コード / 4S のアクセストークン / 開発ペルソナを Bounty のアプリ用トークンに交換するPOST作成・操作
/api/v1/auth/token認証なし・レート制限 - リフレッシュトークンのローテーション(古いものは使えなくなる。再利用すると系統ごと失効)POST作成・操作
/api/v1/auth/refresh認証なし・レート制限 - ログアウト(refresh_token か Bearer のアクセストークンが指す系統を失効)POST作成・操作
/api/v1/auth/revoke認証なし(任意)・レート制限 - WebView に cookie セッションを張る 1 回限りのコード(60 秒)。Bounty のアプリ用アクセストークン(Bearer)が必須。bridge_path に &next=/path を足して WebView で開くPOST作成・操作
/api/v1/auth/web-sessionログイン・レート制限 - メールでのログインの今の段階(メール入力・コード入力・連携の確認)GET取得
/api/auth/4s/email認証なし - メールでのログインを進める(コード送信・確認・連携の許可・やり直し)POST作成・操作
/api/auth/4s/email認証なし・レート制限 - 参加フォームの中でメールでのログインを始めるPOST作成・操作
/api/auth/4s/email/start認証なし・レート制限 - ログイン画面に出せるログイン方法(Apple でサインインの有無)GET取得
/api/auth/4s/methods認証なし - ログアウトする(Accept: application/json のとき JSON。フォームからは 303 でログイン画面へ)POST作成・操作
/api/auth/logout認証なし(任意) - 審査用アカウントでログインする(同じサイトのブラウザだけ)POST作成・操作
/api/auth/review/login認証なし・レート制限