Getting started

Web login API overview¶

The Web Login API is an API that provides IdP (Identity Provider) connection on web pages. By implementing login with the Web Login API, users can log in with their desired IdP, such as Google or Facebook, directly from a web page. Web login is generally recommended for logging in users on external sites (for example, a game community site operated by a game app developer) rather than on apps. There are two versions of the Web Login API: v2 and v1.

Web login V2¶

If you've developed an app with the Hive SDK and want to log in app users on an external site, we recommend using Web Login V2. When users log in on a web page with their IdP account, you can obtain the IdP identifiers (idp_user_id) through the Verification V2 API. Developers should use this IdP identifiers as the account identifiers for external site users and store them in the external site database. This is because you can obtain the PlayerID, which is the user identifier used in the app, using the PlayerID Lookup API with this IdP identifier. Web Login V2 does not directly generate a PlayerID; you must obtain the PlayerID through the IdP identifier. In this way, developers can integrate the same user account that exists in the app with the one on an external site.

For example, a game app developer can implement the function for a user to log in to their game community website with a Google account using Web Login V2. After logging in, by calling the Verification V2 API, you can obtain the IdP identifier of the user who logged in with a Google account. If the same user logs into the game app, a PlayerID, which is the in-game user identifier, is created. You can obtain this PlayerID with the IdP identifier and the PlayerID Lookup API. Thus, developers can integrate the same user account that exists in both the game community and the game app.

Web login V1¶

If you have not developed your app with the Hive SDK and wish to log in app users on an external site, we recommend using Web Login V1. In other words, Web Login V1 is recommended if you want to use only the login function among the functions provided by Hive SDK outside the app. When users log in on a web page with their IdP account, Web Login V1 immediately generates a user PlayerID (pid). Developers can identify users with the PlayerID, and there is no need to acquire or manage a separate identifier like the IdP identifier.

For example, a game app developer can implement the function for a user to log in to their game community with a Google account using Web Login V1. When a user logs in with a Google account, a PlayerID is also generated, so the app developer can use this PlayerID to look up or utilize user information in the Hive Console.