Custom web login implementation¶

This guide explains how to implement web login directly using the Hive server API instead of the web login page provided by Hive Platform. Refer to this document if you want to build your own login UI and handle IdP authentication yourself.

Overview¶

Use custom web login in the following cases.

• When you want to apply your own login UI/UX
• When you want to implement a login screen that matches your existing website design
• When you want to process login within your own page without redirecting to the web login page

API list¶

Common request headers¶

Common response headers¶

Common response format¶

Success response¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": { }
}

Failure response¶

{
    "result_code": 4000,
    "result_msg": "Request has invalid format.",
    "data": null
}

IdP sign-in¶

Creates a new player with IdP information or returns the existing player information if the IdP is already registered. When sign-in succeeds, you can check the PlayerID in data.player_id.

Request URL¶

Request body¶

Request body example¶

{
    "appid": "com.com2us.example",
    "idp_index": 3,
    "idp_user_id": "google_67890",
    "hive_certification_key": "your_certification_key",
    "require_token": true
}

Response header¶

Response header example¶

HTTP/1.1 200
Content-Type: application/json; charset=UTF-8
Authorization: abcdf7ebce779429ea878f91d5f1c8
Iscrypt: 0

Response body¶

Response body sample (success)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": {
        "player_id": 100000002,
        "idp_index": 3,
        "idp_id": "GOOGLE",
        "idp_user_id": "google_67890"
    }
}

Response body sample (failure)¶

{
    "result_code": 4002,
    "result_msg": "Invalid certfication key"
}

Error codes¶

IdP linking¶

Links a new IdP to an existing player account. You must call this API after signing in through the IdP sign-in API.

Request URL¶

Request body¶

Request body example¶

{
    "appid": "com.com2us.example",
    "idp_index": 2,
    "idp_user_id": "fb_12345678",
    "player_id": 100000001,
    "hive_certification_key": "your_certification_key"
}

Response body¶

Response body sample (success)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": {
        "player_id": 100000001,
        "idp_index": 2,
        "idp_id": "FACEBOOK",
        "idp_user_id": "fb_12345678"
    }
}

Response body sample (already linked to another player)¶

{
    "result_code": 1002,
    "result_msg": "Already connected other player",
    "data": {
        "player_id": 100000002,
        "idp_index": 2,
        "idp_id": "FACEBOOK",
        "idp_user_id": "fb_12345678"
    }
}

Error codes¶

IdP unlinking¶

Unlinks the IdP linked to the player account. You must call this API after signing in through the IdP sign-in API.

Request URL¶

Request body¶

Request body example¶

{
    "appid": "com.com2us.example",
    "idp_index": 2,
    "idp_user_id": "fb_12345678",
    "player_id": 100000001,
    "hive_certification_key": "your_certification_key"
}

Response body¶

Response body sample (success)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS"
}

Response body sample (failure)¶

{
    "result_code": 4002,
    "result_msg": "Invalid certfication key"
}

Error codes¶

Delete account¶

Deletes a player account. You must call this API after signing in through the IdP sign-in API.

This API requires token validation, so you must complete the following steps first.

1. When calling the IdP sign-in API, set require_token to true
2. Store the Authorization value returned in the response header of the IdP sign-in API
3. When calling this API, include the Authorization value saved above in the request header

Request URL¶

Request header¶

Request body¶

Request body example¶

{
    "appid": "com.com2us.example",
    "player_id": 100000001,
    "did": 0,
    "hive_certification_key": "your_certification_key"
}

Response body¶

Response body sample (success)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS"
}

Response body sample (failure)¶

{
    "result_code": 7000,
    "result_msg": "Invalid token."
}

Error codes¶

IdP code definitions¶

Default IdPs¶

Custom IdP¶