跳轉至

社群活動通知 API

社群活動通知 API 可在使用者於社群特定討論板發文時,讓遊戲公司接收該發文者的 PlayerID。

概述

當遊戲公司在 Hive 控制台註冊接收 PlayerID 的 API 端點後,Hive 社群會將發文或留言作者的 PlayerID 傳送至該端點。這可用於整合 Hive 社群與遊戲伺服器,將使用者的社群活動與遊戲內獎勵系統等功能連結。

使用方法如下:

  1. 遊戲公司:在 Hive 控制台社群 & 網路商店 > 社群 UI > 遊戲連動 > 通知設定 中註冊 API 端點(回呼 URL)。

    • 回呼 URL 格式可由遊戲公司自由設定
    • 其他 API 規格請遵循下方的 API 請求配置及 API 回應配置項目

  2. Hive 社群伺服器:當使用者在特定討論板發文或留言時,會以回呼形式(Request body 中的 player_id)將發文者的 PlayerID 傳送至遊戲伺服器。

  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" : "Event",
    "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"
}