커뮤니티 활동 알림 API
커뮤니티 활동 알림 API는 사용자가 커뮤니티 특정 게시판에 글을 작성할 때, 게임사가 해당 글 작성자의 PlayerID를 수신할 수 있도록 지원합니다.
개요¶
게임사가 PlayerID를 수신할 API 엔드포인트를 하이브 콘솔에 등록하면, 이 엔드포인트로 하이브 커뮤니티가 게시글 또는 댓글 작성자의 PlayerID를 전달합니다. 하이브 커뮤니티와 게임 서버를 연동해 사용자 커뮤니티 활동을 게임 내 보상 시스템 등과 연결하는 데 사용할 수 있습니다.
사용 방법은 다음과 같습니다.
-
게임사: Hive 콘솔 커뮤니티 & 웹 상점 > 커뮤니티 UI > 게임 연동 > 알림 설정에서 API 엔드포인트(콜백 URL)를 등록합니다.
- 콜백 URL 형식은 게임사가 자유롭게 설정
- 그 외 API 스펙은 하단의 API 요청 구성 및 API 응답 구성 항목을 따름
-
하이브 커뮤니티 서버: 사용자가 특정 게시판에 글을 작성하거나 댓글을 남기면 해당 글 작성자 PlayerID를 콜백 형태(Request body에
player_id)로 게임 서버에 전달합니다. - 게임사: 이 PlayerID를 다양한 인게임 이벤트, 퀘스트 보상 로직 등에 자유롭게 활용합니다.
사전 준비¶
API 요청(하이브 서버 → 게임 서버) 구성¶
하이브 서버에서 게임 서버로 보내는 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 응답(게임 서버 → 하이브 서버) 구성¶
게임 서버에서 하이브 서버로 보내는 응답 정보입니다.
Response body¶
- Data type: JSON
- Parameters
| 명칭 | 타입 | 설명 |
|---|---|---|
| result_code | Integer | 결과 코드 (100 : 성공) |
| result_msg | String | 결과 메시지 |
Response Code¶
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | 100 | Success. | 성공 |
- 성공은 반드시 100으로 전달하세요.
