In-app information API

The in-app information retrieval API is an API for fetching the app server, channel, and character information of users who access the web store. This API sends a request from the Hive server to the developer's app server, and the developer's server returns the response to the Hive server.

Overview¶

When using the Hive community and web store, the app server, channel, and character information of the connected user are required to implement the UI for purchasing in the web store as shown below.

The entire process, including the use of this API, can be summarized as follows.

App Developer: Prepare the server URL by configuring the API endpoint
App Developer: Set the information to be sent to the Hive server in the Hive console in-game information
Hive Server: The app developer sends a POST API request to the registered server URL and receives data as a response
Hive Server: Sends the received app server, channel, and character information to the frontend
Web Store Frontend: Displays the dropdown menu in the web store purchase UI

API endpoint configuration (server url)¶

Register the API endpoint in the Hive Console Community & Web Shop > Web Shop > Web Shop Settings > In-Game Information.

The API endpoint must receive the user information (cs_code) in the request parameters when it receives a request, and it should return app server, channel, and character information in the response. The API endpoint is configured as shown in the example below, corresponding to the Hive console (production, sandbox, test).

Console Environment	API Endpoint
Production	https://{URL}/webstore-profile
Sandbox	https://{URL}/webstore-profile
Testing	https://{URL}/webstore-profile

API request (Hive server → app server) configuration¶

This is the POST request information sent from the Hive server to the app server. You will receive the app server list, the channels included in the server, and the character list in response.

API Information	Description
Method	POST
Response Format	JSON
Content-type	application/json

The following is the Request Body information.

Name	Type	Required (Required: O, Optional: X)	Description
cs_code	String	O	User unique identifier

Here is an example of a Request Body.

{
  cs_code: "c_1234123"
}

API response (app server → Hive server) configuration¶

This is the response value information that must be delivered from the app server to the Hive server when the response is successful. For the purchase limit function based on character level for each product, even if a character is not selected in the Hive console in-app information, character level information must be delivered. If no character is selected and there are multiple characters in the array (data.channels.characters), the level of the character corresponding to the first element of the array is used.

Name	Type	Required (Required: O, Optional: X)	Description
result_code	Integer	O	Result code
result_message	String	O	Result message
cs_code	String	O	Unique identifier for the user
data	Array	O	Server list (if no user information, response value: "[ ]")
data.server_id	String	O	Unique identifier for the server
data.server_name	String	O	Name of the server
data.channels	Array	O	List of channels included in the server
data.channels.channel_id	String	O	Unique identifier for the channel (if channel not used, response value: "0")
data.channels.channel_name	String	O	Name of the channel (if channel not used, response value: "-")
data.channels.characters	Array	O	List of characters included in the channel
data.channels.characters.character_id	String	O	Unique identifier for the character (if character not used, response value: "-")
data.channels.characters.character_name	String	O	Name of the character (if character not used, response value: "-")
data.channels.characters.character_level	String	O	Level of the character (if character level is not available, response value: "0")

The following is an example of the response value when the response is successful.

// When you activated the server, the channel, and the character in the console
{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
    {
      "server_id": "1",
      "server_name": "Server 1",
      "channels": [{
        "channel_id": "1",
        "channel_name": "Channel 1",
        "characters": [{
            "character_id": "A",
            "character_name": "Character A",
            "character_level": "99"
          },
          {
            "character_id": "B",
            "character_name": "Character B",
            "character_level": "10"
          }
        ]
      }]
    }
  ]
}

// When you activated the server and the character in the console
{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
    {
      "server_id": "2",
      "server_name": "Server 2",
      "channels": [{
        "channel_id": "0",
        "channel_name": "-",
        "characters": [{
            "character_id": "C",
            "character_name": "Character C",
            "character_level": "11"
          },
          {
            "character_id": "D",
            "character_name": "Character E",
            "character_level": "12"
          }
        ]
      }]
    }
  ]
}

 // When you activated the server and the channel in the console
{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
    {
      "server_id": "3",
      "server_name": "Server 3",
      "channels": [{
        "channel_id": "2",
        "channel_name": "Channel 2",
        "characters": [{
          "character_id": "-",
          "character_name": "-",
          "character_level": "99"
        }]
      }]
    }
  ]
}

// When you activated the server in the console
{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
    {
      "server_id": "4",
      "server_name": "Server 4",
      "channels": [{
        "channel_id": "0",
        "channel_name": "-",
        "characters": [{
          "character_id": "-",
          "character_name": "-",
          "character_level": "99"
        }]
      }]
    }
  ]
}

// When you activated the server, the channel, and the character in the console: multiple channels
{
    "result_code": 200,
    "result_message": "success",
    "cs_code": "c_123412341234",
    "data": [
        {
            "server_id": "1",
            "server_name": "Server 1",
            "channels": [
                {
                    "channel_id": "1",
                    "channel_name": "Channel 1",
                    "characters": [
                        {
                            "character_id": "A",
                            "character_name": "Character A",
                            "character_level": "99"
                        }, {
                            "character_id": "B",
                            "character_name": "Character B",
                            "character_level": "10"
                        }
                    ]
                }, {
                    "channel_id": "2",
                    "channel_name": "Channel 2",
                    "characters": [
                        {
                            "character_id": "A2",
                            "character_name": "Character A2",
                            "character_level": "99"
                        }, {
                            "character_id": "B2",
                            "character_name": "Character B2",
                            "character_level": "10"
                        }
                    ]
                }
            ]
        }
    ]
}

The following is the response code (result_code).

Code	Description
200	Success
204	No information about the user
500	Server error