API การแจ้งเตือนกิจกรรมชุมชน
Community Activity Notification API รองรับให้บริษัทเกมสามารถรับ PlayerID ของผู้เขียนโพสต์เมื่อผู้ใช้เขียนโพสต์บนบอร์ดเฉพาะในคอมมูนิตี้
ภาพรวม¶
เมื่อบริษัทเกมลงทะเบียน API endpoint สำหรับรับ PlayerID ใน Hive Console แล้ว Hive Community จะส่ง PlayerID ของผู้เขียนโพสต์หรือคอมเมนต์ไปยัง endpoint นี้ สามารถใช้เพื่อเชื่อมต่อ Hive Community กับเซิร์ฟเวอร์เกมเพื่อเชื่อมโยงกิจกรรมคอมมูนิตี้ของผู้ใช้กับระบบรางวัลในเกมและอื่นๆ
วิธีใช้งานมีดังนี้:
-
บริษัทเกม: ลงทะเบียน API endpoint (callback URL) ใน Hive Console Community & Web Shop > Community UI > Game Integration > Notification Settings
- รูปแบบ callback URL สามารถกำหนดได้อย่างอิสระโดยบริษัทเกม
- สเปก API อื่นๆ ให้ปฏิบัติตามหัวข้อ API Request Configuration และ API Response Configuration ด้านล่าง
-
เซิร์ฟเวอร์ Hive Community: เมื่อผู้ใช้เขียนโพสต์บนบอร์ดเฉพาะหรือแสดงความคิดเห็น PlayerID ของผู้เขียนจะถูกส่งไปยังเซิร์ฟเวอร์เกมในรูปแบบ callback (โดยมี
player_idใน Request body) - บริษัทเกม: ใช้ PlayerID นี้ได้อย่างอิสระสำหรับอีเวนต์ในเกม ลอจิกรางวัลเควส และอื่นๆ
ข้อกำหนดเบื้องต้น¶
การกำหนดค่า API Request (เซิร์ฟเวอร์ Hive → เซิร์ฟเวอร์เกม)¶
นี่คือข้อมูล POST request ที่ส่งจากเซิร์ฟเวอร์ Hive ไปยังเซิร์ฟเวอร์เกม
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 | Board IDX |
| board_name | String | O | ชื่อบอร์ด |
| write_type | String | O | ประเภทโพสต์ (board: โพสต์, comment: คอมเมนต์) |
| reg_date | String | O | เวลา callback |
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 Response (เซิร์ฟเวอร์เกม → เซิร์ฟเวอร์ Hive)¶
นี่คือข้อมูล response ที่ส่งจากเซิร์ฟเวอร์เกมไปยังเซิร์ฟเวอร์ Hive
Response body¶
- Data type: JSON
- Parameters
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
| result_code | Integer | รหัสผลลัพธ์ (100: สำเร็จ) |
| result_msg | String | ข้อความผลลัพธ์ |
Response Code¶
| HTTP Status Code | Code | Message | คำอธิบาย |
|---|---|---|---|
| 200 | 100 | Success. | สำเร็จ |
- ต้องส่งค่าสำเร็จเป็น 100 เสมอ
