社区活动通知 API
社区活动通知 API 支持游戏公司在用户在社区特定版块发帖时接收该帖子作者的 PlayerID。
概述¶
当游戏公司在 Hive 控制台注册用于接收 PlayerID 的 API 端点后,Hive 社区会将帖子或评论作者的 PlayerID 发送到该端点。这可用于将 Hive 社区与游戏服务器集成,将用户的社区活动与游戏内奖励系统等功能连接起来。
使用方法如下:
-
游戏公司:在 Hive 控制台社区 & 网上商店 > 社区 UI > 游戏集成 > 通知设置 中注册 API 端点(回调 URL)。
- 回调 URL 格式可由游戏公司自由设置
- 其他 API 规范请遵循下方的 API 请求配置和 API 响应配置部分
-
Hive 社区服务器:当用户在特定版块发帖或留下评论时,会以回调形式(Request body 中的
player_id)将作者的 PlayerID 发送到游戏服务器。 - 游戏公司:可自由地将此 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。
