Hcms

Use this API to monitor communities other than Hive Community that do not provide an API for collecting posts, comments, and board information.

Prerequisites¶

Make sure you can access Hive Console > AI Service > Community Monitoring > Post Monitoring System > Community Settings. If you cannot access the menu, refer to the Hive Console Permission Management Guide to obtain permission. Register a new project in Text Abusing Detection.

Register post, comment, and board information¶

This API registers post, comment, and board information in an array. Each item in the array must contain exactly one of the following keys: content (post), comment, or board (board information). Different item types can be included in the same request.

Request URL¶

Request Headers¶

Request Body¶

content (register a post)¶

Field	Description	Type	Required
content_idx	Unique post ID	Integer	Y
lang	One of the supported language codes	String	Y
title	Post title	String	Y
body	Post body	String	Y
pid	Author account identifier	String	Y
register	Author nickname	String	Y
regdate	Registration date and time (yyyy-MM-dd HHss)	String	Y
link	URL of the original post	String	Y

comment (register a comment)¶

Field	Description	Type	Required
comment_idx	Unique comment ID	Integer	Y
lang	One of the supported language codes	String	Y
contents_idx	content_idx of the post containing the comment	Integer	Y
body	Comment body	String	Y
pid	Author account identifier	String	Y
register	Author nickname	String	Y
regdate	Registration date and time (yyyy-MM-dd HHss)	String	Y
link	Comment URL	String	Y

board (register board information)¶

Supported language codes¶

The codes are based on ISO 639-1. Use one of the following codes for the content/comment lang field or the board lang_code field.

Response¶

The response always includes content, comment, or board when the corresponding type is included in the request.

If the registration API toggle for this project is disabled in the back office, the API returns only the following response with status code 200 instead of the fields above, and the data is not saved. This means that the request itself was received successfully.

{ "active": false, "message": "This project is currently inactive. The request was received successfully, but the data was not saved." }

Response code¶

For 400, 401, and 404 errors, the response body is a single object containing the reason for failure, as shown below.

{ "message": "Invalid api_key." }

Request example¶

curl -X POST https://hcms-backoffice.withhive.com/api/community/register-community-data \
  -H "Content-Type: application/json" \
  -H "api_key: {Issued API Key}" \
  -H "game_name: sample_game" \
  -d '[
    {
      "content": {
        "content_idx": 10234,
        "lang": "en",
        "title": "Question about the update",
        "body": "I cannot connect after the latest patch.",
        "pid": "player_00123",
        "register": "sample_user_1",
        "regdate": "2026-08-24 15:30:00",
        "link": "https://community.example.com/sample_game/board/5/10234"
      }
    },
    {
      "comment": {
        "comment_idx": 55021,
        "lang": "en",
        "contents_idx": 10234,
        "body": "I am experiencing the same issue.",
        "pid": "player_00987",
        "register": "sample_user_2",
        "regdate": "2026-08-24 15:31:10",
        "link": "https://community.example.com/sample_game/board/5/10234#comment-55021"
      }
    },
    {
      "board": {
        "board_idx": 5,
        "lang_code": "en",
        "board_name": "General Discussion"
      }
    }
  ]'

import java.util.List;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

public class HcmsRealtimeRegisterSample {

    private final String apiKey = "<API_KEY>";
    private final String gameName = "sample_game";
    private final String url = "https://hcms-backoffice.withhive.com/api/community/register-community-data";

    public void registerContent() throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();

        String body = "[{\"content\":{"
                + "\"content_idx\":10234,"
                + "\"lang\":\"en\","
                + "\"title\":\"Question about the update\","
                + "\"body\":\"I cannot connect after the latest patch.\","
                + "\"pid\":\"player_00123\","
                + "\"register\":\"sample_user_1\","
                + "\"regdate\":\"2026-08-24 15:30:00\","
                + "\"link\":\"https://community.example.com/sample_game/board/5/10234\""
                + "}}]";

        HttpHeaders headers = new HttpHeaders();
        headers.set("Content-Type", "application/json");
        headers.set("api_key", apiKey);
        headers.set("game_name", gameName);

        RestTemplate restTemplate = new RestTemplate();
        HttpEntity<String> entity = new HttpEntity<>(body, headers);
        ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.POST, entity, String.class);

        JsonNode result = objectMapper.readTree(response.getBody());
        System.out.println(result.toString());
    }
}

import requests

api_key = "<API_KEY>"
game_name = "sample_game"
url = "https://hcms-backoffice.withhive.com/api/community/register-community-data"

headers = {
    "Content-Type": "application/json",
    "api_key": api_key,
    "game_name": game_name,
}

body = [
    {
        "content": {
            "content_idx": 10234,
            "lang": "en",
            "title": "Question about the update",
            "body": "I cannot connect after the latest patch.",
            "pid": "player_00123",
            "register": "sample_user_1",
            "regdate": "2026-08-24 15:30:00",
            "link": "https://community.example.com/sample_game/board/5/10234",
        }
    }
]

response = requests.post(url, headers=headers, json=body)
print(response.json())

Response example¶

{
  "content": { "success": 1, "failed": 0 },
  "comment": { "success": 1, "failed": 0 },
  "board": { "success": 1, "failed": 0 },
  "failed_content_idx": [],
  "failed_comment_idx": []
}

Example: Two of five posts fail

{
  "content": { "success": 3, "failed": 2 },
  "failed_content_idx": [102, 104]
}

Example: Items that do not contain exactly one of content, comment, and board

{
  "content": { "success": 1, "failed": 0 },
  "failed_content_idx": [],
  "invalid_index": [1, 2]
}

Index 1 contains both content and comment, while index 2 is an empty object ({}) that contains none of them.

Check registration readiness¶

This read-only API checks whether the specified game_name can receive requests through the registration API above, including whether the project is registered and whether an API Key has been issued. api_key authentication is not required.

Request URL¶

Request Headers¶

Response¶

Response code¶

Request example¶

curl -X GET https://hcms-backoffice.withhive.com/api/community/register-community-data/check \
  -H "game_name: sample_game"

Response example¶

{ "ready": true, "message": "Ready to receive API requests." }

Notes¶

• Batch scope: Each request registers data for only the game specified in the game_name header.
• Duplicate handling: Resending the same content_idx or comment_idx saves a duplicate because the API does not provide idempotency. Boards are fully replaced, so duplicates are not an issue.
• Body length: There is no length limit for body.
• Key management: Reissuing a key invalidates the previous key immediately.