Skip to content

Item Distribution API

Query user information for products purchased in the Web Shop. Select game server, channel, and character in the console, and create and register the appropriate API for product delivery.

Menu: Community & Web Shop > Web Shop > Web Shop Settings > Item Distribution

Note

Create the API according to the delivery method. Check the details in the Request Example below.

Check game server (server, channel, character) list

Request URL

Environment URL
Production https://{URL}/webstore-profile
Sandbox https://{URL}/webstore-profile
Test https://{URL}/webstore-profile

Request Header

Type Value
Http Method POST
Content-Type application/json

Request Parameters

Field Type Required Description
cs_code String O Unique User Identifier

Response Data

Field Type Required Description
result_code Integer O Result Code
result_message String O Result Message
cs_code String O Unique User Identifier
data Array O Server List
data.server_id String O Unique Server Identifier
data.server_name String O Server Name
data.channels Array O Channels Included in the Server
data.channels.channel_id String O Unique Channel Identifier (If channels are not used, the response value is “0.”)
data.channels.channel_name String O Channel Name (If channels are not used, the response value is “-.”)
data.channels.characters Array O List of Characters Included in the Channel (If character is not used, the response value is [].)
data.channels.characters.character_id String O When Using Characters Unique Character Identifier
data.channels.characters.character_name String O When Using Characters Character Name
data.channels.characters.character_level String O When Using Characters Character Level (If there is no character level, the response value is “-.”)

Result Code

Code Description
200 Success
500 Server Error
- No User Info

Request Example

# Request Parameters
{
  cs_code: "c_1234123"
}

# Response
{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
   {
    # Server, Channel, Character
    "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",
      }]
    }]
  },
  {
    # Server, Character
    "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",
      }]
    }]
  },
  {
    # Server, Channel
    "server_id": "3",
    "server_name": "Server 3",
    "channels": [{
      "channel_id": "2",
      "channel_name": "Channel 2",
      "characters": []
    }]
  },
  {
    # Server
    "server_id": "4",
    "server_name": "Server 4",
    "channels": [{
      "channel_id": "0",
      "channel_name": "-",
      "characters": []
    }]
  }
 ]} 
}