Skip to content

Getting Started

Web login is a feature that allows users to log in to the IdP via the web. Please refer to IdP that supports web login.

Using the Web Login API, users can implement IdP login on external websites (e.g., community sites operated by game developers) instead of the app. Currently, the Web Login API integrates the existing Web Login v1 and Web Login v2.

Warning
  • The method of calling the Web Login API version v2 and v1 separately is not currently supported. To receive ongoing support, you must use the integrated Web Login API.
  • The integrated Web Login API does not distinguish between versions.
Note

To use the web login API, you need to complete the relevant settings in the Hive console. For more details, please refer to the IdP that supports web login in the console guide under Authentication > Login Settings.

How to Use the Web Login API

The web login API varies in usage depending on the purpose of the 'web login AppID'.

When the purpose of 'Web Login AppID' is 'Community' or 'Website'

If you select the purpose of 'Web Login AppID' as Community or Website in the Hive console's App Center > AppID Management > Register Web Login AppID, game developers will use the Web Login API as follows.

  1. Call the login page
  2. Use the response values of the User Verification and User Information Retrieval API, specifically the IdP identifiers (idp_index, idp_user_id), as user account identifiers and store them in the developer's database

The reason for using it as above is that if you log in to the IdP first on a community or website rather than in the game, a PlayerID, which is the user identifier used in the game, will not be generated. By using the IdP identifier as the user account identifier instead of the PlayerID, you can prevent account conflicts.

However, when the user accesses the game app and logs in, a PlayerID, which is the game user identifier, is generated. Therefore, it can be used as the user account identifier, distinguishing it from the PlayerID in the response value of the Verify and User Information Retrieval API's user_info or the PlayerID in the response value of the User Information Retrieval by Authentication API API.

Note

Account conflicts occur in situations like the following.

  1. Log in with web login to create the initial IdP and PlayerID
  2. After logging in to the game using the Hive SDK, connect additional IdP integration in the game profile
  3. An account conflict occurs because a PlayerID has already been created with web login, prompting the user to select an account

The purpose of using 'Web Login AppID' is for 'Blockchain'

In the Hive console, when selecting 'Blockchain' as the purpose of the 'Web Login AppID' in App Center > AppID Management > Web Login AppID Registration, game developers use the Web Login API as follows.

  1. Login Page API call
  2. Login Verification and User Information Retrieval API call and the response value PlayerID allows for user account identification (there is no need to obtain and manage a separate identifier like an IdP identifier)

In the case of blockchain, calling the login page API and the login verification and user information retrieval API will generate a PlayerID, so there is no need to use a separate IdP identifier like a community or website.