การจับคู่ตามรหัสเชิญ¶

ฟีเจอร์การเชิญผู้ใช้คือฟีเจอร์ที่อนุญาตให้ผู้ใช้สามารถออกโค้ดเชิญเพื่อเชิญผู้ใช้อื่นเข้าสู่เกมและรับรางวัลจากนักพัฒนาสำหรับการทำเช่นนั้น API การเชิญผู้ใช้คือ API ที่อนุญาตให้เกมออกโค้ดเชิญและจับคู่ผู้ใช้ที่ได้ตอบรับคำเชิญ

วิธีการใช้งาน¶

1. ใน Hive console > Promotion > User Invitation > Register Invitation Campaign ให้สร้าง แคมเปญ โดยใช้ประเภทการออกโค้ดเชิญ
2. ดึง ข้อมูลแคมเปญเชิญ และเก็บ ID แคมเปญที่ใช้ได้บนเซิร์ฟเวอร์เกม
3. บนหน้าเชิญผู้ใช้ ให้ส่งข้อมูลผู้เชิญที่ได้รับและ ID แคมเปญที่บันทึกไว้ข้างต้นเป็นพารามิเตอร์การเรียกเพื่อ ออกโค้ดเชิญ
4. ส่งข้อมูลของผู้เชิญ (player_id เป็นต้น) และโค้ดเชิญที่ได้รับจากผู้เชิญเป็นพารามิเตอร์การเรียกและทำการ matching request
5. เรียก check reward status เพื่อแสดงความก้าวหน้าสำหรับการรับรางวัลบนหน้าเชิญผู้ใช้

การเตรียมการ¶

ในการใช้ API ที่เกี่ยวข้องกับรหัสเชิญ คุณต้องเตรียมรายการต่อไปนี้

• รหัสการตรวจสอบสิทธิ์ Hive ที่จะใช้ใน Authorization Header: Hive Console > App Center > Project Management > เลือกแอปหลังจากค้นหาแอป > รายละเอียดเกม > ข้อมูลพื้นฐาน > รหัสการตรวจสอบสิทธิ์ Hive
• server_id: Hive Console > App Center > Project Management > เลือกแอปหลังจากค้นหาแอป > รายละเอียดเกม > เซิร์ฟเวอร์เกม
• แคมเปญเชิญชวน: ออกประเภทรหัสเชิญโดยการลงทะเบียน สร้างแคมเปญ ใน Hive Console > Promotion > User Invitation > การลงทะเบียนแคมเปญเชิญชวน

การดึงข้อมูลแคมเปญ¶

กำลังดึงข้อมูลแคมเปญเชิญชวนที่สร้างขึ้นในคอนโซล Hive ข้อมูลแคมเปญเชิญชวนที่ใช้งานอยู่และพร้อมใช้งานเท่านั้นที่จะถูกดึงมา ข้อมูลรางวัลที่ตั้งไว้สำหรับแคมเปญจะถูกรวมอยู่ในคำตอบด้วย

ข้อกำหนดการร้องขอ API¶

URL การร้องขอ¶

วิธีการร้องขอและรูปแบบข้อมูล¶

หัวข้อ¶

เนื้อหาคำขอ¶

ตัวอย่างการโทร¶

curl -L -v -X POST --location "http://sandbox-promotion.qpyou.cn/ua/inviteCode/campaign" \
        -H "Content-Type: application/json" \
        -d '{
        "gameindex": 539
        }'

ข้อกำหนดการตอบสนอง API¶

การตอบสนอง¶

ตัวอย่างการตอบกลับ¶

{
    "campaign_list": [
    {
        "id": "19",
            "title": "초대 코드 발급_행동_설치(초대 2, 수락 3, 제한 2)",
            "rewards": [
        {
            "reward_id": 33,
                "description": "행동_설치(초대 2, 수락 3, 제한 2)",
                "reward_type": "action",
                "action_type": "cpi",
                "cpa_code": null,
                "goal": 1,
                "limit": 2
        }
      ]
    }
  ],
    "result_code": 200,
    "result_message": "Success"
}

รับรหัสเชิญ¶

ผู้ใช้สามารถรับรหัสเชิญในแคมเปญได้ แคมเปญแต่ละรายการสามารถออกเพียงรหัสเชิญเดียวเท่านั้น เพื่อเป็นรางวัลให้กับผู้เชิญ จะต้องมีการระบุ ID เซิร์ฟเวอร์ที่ผู้เชิญเข้าถึง

ข้อกำหนดการร้องขอ API¶

URL ที่ร้องขอ¶

วิธีการร้องขอและรูปแบบข้อมูล¶

หัวข้อ¶

เนื้อหาการร้องขอ¶

ตัวอย่างการโทร¶

curl -L -v -X POST --location "http://sandbox-promotion.qpyou.cn/ua/inviteCode/getCode" \
    -H "Content-Type: application/json" \
    -d '{
          "gameindex" : 539,
          "campaign_id": 19,
          "player_id" : 12341234,
          "server_id" : "kr"
        }'

ข้อกำหนดการตอบสนอง API¶

การตอบกลับ¶

ตัวอย่างการตอบกลับ¶

{
  "invite_code": "ESOJ0TOC",
  "result_code": 200,
  "result_message": "Success"
}

รหัสเชิญที่ตรงกัน¶

กรอกโค้ดเชิญเพื่อ จับคู่ ผู้เชิญและผู้รับ เพื่อป้องกันการใช้รางวัลในทางที่ผิด แนะนำให้ตรวจสอบข้อมูลบัญชีของผู้รับบนเซิร์ฟเวอร์เกมก่อนที่จะทำการขอจับคู่ รางวัลการจับคู่จะมอบให้เพียงครั้งเดียวต่อแคมเปญ

ข้อกำหนดการร้องขอ API¶

URL ที่ร้องขอ¶

วิธีการร้องขอและรูปแบบข้อมูล¶

หัวข้อ¶

เนื้อหาคำขอ¶

ตัวอย่างการโทร¶

curl -L -v -X POST --location "http://sandbox-promotion.qpyou.cn/ua/inviteCode/companion" \
    -H "Content-Type: application/json" \
    -d '{
          "gameindex" : 539,
          "invite_code" :"ESOJ0TOC",
          "player_id" : 234234,
          "server_id" : "kr"
        }'

ข้อกำหนดการตอบสนอง API¶

การตอบสนอง¶

ตัวอย่างการตอบกลับ¶

{
  "detail": {
    "matched": true,
    "reason": "Both matching and rewards were successful"
  },
  "result_code": 200,
  "result_message": "Success"
}

ตรวจสอบสถานะรางวัล¶

กำลังตรวจสอบสถานะรางวัลของรหัสเชิญ

ข้อกำหนดการร้องขอ API¶

URL ที่ร้องขอ¶

วิธีการร้องขอและรูปแบบข้อมูล¶

หัวข้อ¶

เนื้อหาคำขอ¶

ตัวอย่างการโทร¶

curl -L -v -X POST --location "http://sandbox-promotion.qpyou.cn/ua/inviteCode/progress" \
        -H "Content-Type: application/json" \
        -d '{
          "gameindex" : 539,
          "invite_code" :"ESOJ0TOC"
        }'

ข้อกำหนดการตอบสนอง API¶

การตอบกลับ¶

ตัวอย่างการตอบกลับ¶

{
  "progress_list": [
    {
      "reward_id": 19,
      "reward_type": "action",
      "action_type": "match",
      "count": 1,
      "max_reward": 1,
      "goal_progress": 0,
      "goal_achieved": 0
    },
    {
      "reward_id": 20,
      "reward_type": "goal",
      "action_type": "cpi",
      "count": 2,
      "max_reward": 2,
      "goal_progress": 1,
      "goal": 3,
      "goal_achieved": 2
    }
  ],
  "result_code": 200,
  "result_message": "Success"
}