コンテンツにスキップ

コミュニティ活動通知 API

コミュニティ活動通知APIは、ユーザーがコミュニティの特定掲示板に投稿する際、ゲーム会社がその投稿者のPlayerIDを受信できるようにサポートします。

概要

ゲーム会社がPlayerIDを受信するAPIエンドポイントをHiveコンソールに登録すると、そのエンドポイントにHiveコミュニティが投稿またはコメント作成者のPlayerIDを送信します。Hiveコミュニティとゲームサーバーを連携して、ユーザーのコミュニティ活動をゲーム内報酬システムなどと連動させるために使用できます。

使用方法は以下の通りです。

  1. ゲーム会社:Hiveコンソール コミュニティ & ウェブショップ > コミュニティUI > ゲーム連携 > 通知設定でAPIエンドポイント(コールバックURL)を登録します。

    • コールバックURL形式はゲーム会社が自由に設定可能
    • その他のAPI仕様は下記のAPIリクエスト構成およびAPIレスポンス構成項目に従う

  2. Hiveコミュニティサーバー:ユーザーが特定の掲示板に投稿したりコメントを残したりすると、その投稿者のPlayerIDをコールバック形式(Request bodyにplayer_id)でゲームサーバーに送信します。

  3. ゲーム会社:このPlayerIDを様々なインゲームイベント、クエスト報酬ロジックなどに自由に活用します。

事前準備

APIリクエスト(Hiveサーバー → ゲームサーバー)構成

HiveサーバーからゲームサーバーへのPOSTリクエスト情報です。

Request header

API情報 説明
Method POST
Response Format JSON
Content-type application/json

Request body

名称 タイプ 必須かどうか(必須:O、オプション:X) 説明
player_id Integer O ユーザー固有識別子
lang String O 掲示板言語
board_idx Integer O 掲示板IDX
board_name String O 掲示板名
write_type String O 投稿タイプ(board:投稿、comment:コメント)
reg_date String O コールバック時間

Request body sample

{
    "player_id" : 20000010000,
    "lang" : "ko",
    "board_idx" : 12345,
    "board_name" : "イベント",
    "write_type" : "board",
    "reg_date" : "2025-08-14 10:12:18"
}

APIレスポンス(ゲームサーバー → Hiveサーバー)構成

ゲームサーバーからHiveサーバーへのレスポンス情報です。

Response body

  • Data type: JSON
  • Parameters
名称 タイプ 説明
result_code Integer 結果コード(100:成功)
result_msg String 結果メッセージ

Response Code

HTTPステータスコード コード メッセージ 説明
200 100 Success. 成功
  • 成功は必ず100で送信してください。

Response Sample

{
    "result_code": 100,
    "result_msg": "success"
}