始めに
ウェブログイン API 概要¶
ウェブログイン API は、ウェブページ上で IdP (アイデンティティプロバイダー) 接続を提供する API です。ウェブログイン API を実装することで、ユーザーはウェブページから直接 Google や Facebook などの希望する IdP でログインできます。ウェブログインは、アプリではなく外部サイト(例えば、ゲームアプリ開発者が運営するゲームコミュニティサイト)でユーザーをログインさせるために一般的に推奨されます。ウェブログイン API には、v2 と v1 の2つのバージョンがあります。
ウェブログイン V2¶
Hive SDKを使用してアプリを開発し、外部サイトでアプリユーザーにログインさせたい場合、 ウェブログイン V2の使用をお勧めします。ユーザーがIdPアカウントでウェブページにログインすると、Verification V2 APIを通じてIdP識別子(idp_user_id
)を取得できます。開発者はこのIdP識別子を外部サイトユーザーのアカウント識別子として使用し、外部サイトデータベースに保存する必要があります。これは、PlayerID Lookup APIを使用してこのIdP識別子からアプリで使用されるユーザー識別子であるPlayerIDを取得できるためです。ウェブログイン V2は直接PlayerIDを生成しません。IdP識別子を通じてPlayerIDを取得する必要があります。このようにして、開発者はアプリに存在する同じユーザーアカウントを外部サイトのものと統合できます。
例えば、ゲームアプリの開発者は、Web Login V2を使用して、ユーザーがゲームコミュニティのウェブサイトにGoogleアカウントでログインする機能を実装できます。ログイン後、Verification V2 APIを呼び出すことで、GoogleアカウントでログインしたユーザーのIdP識別子を取得できます。同じユーザーがゲームアプリにログインすると、ゲーム内ユーザー識別子であるPlayerIDが作成されます。このPlayerIDは、IdP識別子とPlayerID Lookup APIを使用して取得できます。したがって、開発者はゲームコミュニティとゲームアプリの両方に存在する同じユーザーアカウントを統合できます。
ウェブログイン V1¶
Hive SDKを使用してアプリを開発していない場合、外部サイトでアプリユーザーにログインさせたい場合は、ウェブログイン V1の使用をお勧めします。言い換えれば、アプリの外でHive SDKが提供する機能の中でログイン機能のみを使用したい場合は、ウェブログイン V1が推奨されます。ユーザーがIdPアカウントでウェブページにログインすると、ウェブログイン V1はすぐにユーザーのPlayerID(pid
)を生成します。開発者はPlayerIDを使用してユーザーを識別でき、IdP識別子のような別の識別子を取得または管理する必要はありません。
例えば、ゲームアプリの開発者は、Web Login V1を使用して、ユーザーがGoogleアカウントでゲームコミュニティにログインする機能を実装できます。ユーザーがGoogleアカウントでログインすると、PlayerIDも生成されるため、アプリ開発者はこのPlayerIDを使用して、Hiveコンソールでユーザー情報を検索または利用できます。
Warning
Hive SDKを使用してアプリを開発した場合でも、Web Login V1を引き続き使用できます。ただし、この場合、ユーザーの最初のログイン(初期IdP接続)は、外部サイトではなくアプリ自体内で行う必要があります。