ソーシャルログインURL
ソーシャルログインURL とは、ソーシャルPLUS を用いたソーシャルログインを実装する際、一連の流れの入り口となる URL です。ソーシャルPLUS が提供する URL であり、お客様サービスに設置するログインボタンなどのリンク先としてご利用いただくものです。
ソーシャルログインURL は GET メソッドのみサポートしています。
ソーシャルログインURL の書式
ソーシャルログインURL には以下の 2 パターンがあります。
- 新規登録・ログイン併用（通常のソーシャルログイン処理）
- ログインのみ許可する
挙動の違い
| ソーシャルPLUS ID 未発行ユーザー | ソーシャルPLUS ID 発行済みユーザー | |
|---|---|---|
| 1 | ID 新規発行＋ログイン | 既存 ID でログイン |
| 2 | エラー応 答 | 既存 ID でログイン |
以下にそれぞれの書式を記載します。
1. 新規登録・ログイン併用の書式
https://{認証サブドメイン}.auth.socialplus.jp/{アカウントID}/{サービスID}/{ログインプロバイダ名}/authenticate?callback={コールバックURL}
この URL は、ソーシャルログインマネージャーの［プロバイダー設定］ページよりコピーできます。
2. ログインのみ許可する書式（非推奨）
特に理由のない限り 1. の書式のご利用を推奨します。
https://{認証サブドメイン}.auth.socialplus.jp/{アカウントID}/{サービスID}/{ログインプロバイダ名}/authenticate/login?callback={コールバックURL}
利用するパラメータ
書式に必要な値は以下のとおりです。
| 名称 | 取得方法 |
|---|---|
| 認証サブドメイン | サービスID ごとに発行されるランダムな文字列です。プロバイダ設定ページの「ソーシャルログインURL」より取得可能です |
| アカウントID | お客様ごとに発行するアカウントID です |
| サービスID | ソーシャルログインマネージャーで作成したサービスごとのサービスID です |
| ログインプロバイダ名 | 下記の表「ログインプロバイダ名一覧」を参照してください |
| コールバックURL | ソーシャルログイン完了後に結果を返すリダイレクト先となるお客様システムの URL |
ソーシャルプロバイダー名一覧
| 利用するログインプロバイダ | ログインプロバイダ名（指定する文字列） |
|---|---|
| LINE | line |
| Apple | apple |
| Yahoo! JAPAN | yahoo |
| 新 Google | gplus |
facebook | |
twitter |
以下は古い実装の後方互換性を担保するために残っている名称です。
今後新しくご利用いただくことはできません。
| 利用するログインプロバイダ | ログインプロバイダ名（指定する文字列） |
|---|---|
| 旧 Google | google |
| 楽天 | rakuten |
ソーシャルログインURL 書式例
実際に値を当てはめた場合の一例です。
| パラメータ名称 | 例とする値 |
|---|---|
| 認証サブドメイン | 95fdje87f6yaefe ※ソーシャルログインマネージャーで自動発行されます |
| アカウントID | example |
| サービスID | demosite |
| ログインプロバイダ | |
| コールバックURL | https://example.com/login/callback |
以上の構成の場合、ソーシャルログインURL は以下のようになります。
https://95fdje87f6yaefe.auth.socialplus.jp/example/demosite/facebook/authenticate?callback=https://example.com/login/callback
この URL にアクセスすることで、ソーシャルPLUS を経由して Facebook の認証画面に遷移し、認可に同意された後、「コールバックURL」である https://example.com/login/callback へリダイレクトされます。
ログインオプション
上記に記載した必須のパラメータだけではなく、追加で利用可能なパラメータの一覧です。ソーシャルログインURL のクエリとして指定します。
| キー名 | 型 | 説明 |
|---|---|---|
| callback | String | 必須 上記のとおり |
| callback_if_failed | String | ソーシャルログインの結果が "失敗" だった場合に結果を返すリダイレクト先となるお客様システムの URL。成功時とコールバック先を変えたい場合に利用します。指定しない場合は、成功・失敗いずれも callback に指定したコールバック先に返されます |
| token_param | String | 詳しくは ワンタイムトークンのパラメータ名 参照 |
ソーシャルログイン開始の導線
お客様サービスの適切な位置に、ソーシャルログインを経由して「新規ユーザ登録」または「ログイン」を実行するための入り口となるボタンを設置します。
ソーシャルログインボタンには「ソーシャルログインURL」へのリンクを設定します。
ソーシャルログインボタンの押下から、ログインプロバイダへ遷移して認証が完了し、コールバックURLに遷移することを確認してください。
ログインプロバイダからソーシャルPLUS へ遷移するコールバック URL
通常、お客様側 実装時にこのURLを意識する必要はありません。ソーシャルログインURL のパラメータとして指定が必要な「コールバックURL」についてはコールバックURLをご確認ください。
以下に説明している URL は、各ログインプロバイダ側設定時に必要となります。詳しくは ログインプロバイダ連携 の各手順のなかで解説します。
各ログインプロバイダで認可を終えたあと、一度ソーシャルPLUS 側にコールバックのリダイレクトが行われます。
ここでソーシャルPLUS システム側への「ソーシャルPLUS ID の登録」、あるいは「既存のソーシャルPLUS ID の特定」、「ログインプロバイダからの個人情報の取得処理」などが実行されます。
https://{認証サブドメイン}.auth.socialplus.jp/{アカウントID}/{サービスID}/{ログインプロバイダ名}/authenticate/callback
各項目の値は ソーシャルログインURL で利用するパラメータ と同様の値です。