API การจับคู่ส่วนตัว

นี่คือ API ที่ใช้เมื่อทำการจับคู่แบบเดี่ยวระหว่างการเล่นเกม สำหรับการจับคู่แบบกลุ่ม กรุณาใช้ Group API

การจับคู่คำขอ¶

นี่เรียกใช้เมื่อเริ่มคำขอการแข่งขัน การแข่งขันที่ตรงกับ matchId จะต้องถูกสร้างล่วงหน้าในคอนโซล Hive.

URL ที่ร้องขอ¶

พารามิเตอร์หัวเรื่อง¶

พารามิเตอร์เส้นทาง¶

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

การตอบสนอง¶

ตัวอย่างคำขอ¶

curl --location 'https://sandbox-api-match.withhive.com/gameindexes/1/matchmakings/1/request' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ya3a' \
--data '{
   "playerId":100,
   "point": 1000
}'

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

{
   "playerId": 100,
   "matchInfo": {
       "gameIndex": 1,
       "matchId": 1
   },
   "requestingStatus": "requested",
   "requestingInfo": {
       "requestTimeUtc": "2024-06-05T05:09:28.72",
       "point": 1000
   },
   "matchingInfo": {
       "status": "matchingInProgress"
   }
}

ตรวจสอบสถานะการจับคู่¶

กำลังตรวจสอบสถานะการจับคู่ที่ร้องขอ

URL ที่ร้องขอ¶

พารามิเตอร์หัวเรื่อง¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์การค้นหา¶

การตอบกลับ¶

ตัวอย่างคำขอ¶

curl --location --request GET 'https://sandbox-api-match.withhive.com/gameindexes/1/matchmakings/1/players?id=100' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ya3a'

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

เมื่อผู้พัฒนายังไม่ได้ทำการร้องขอที่ตรงกัน ผลลัพธ์สถานะการจับคู่เป็นดังนี้

{
   "playerId": 100,
   "matchInfo": {
       "gameIndex": 1,
       "matchId": 1
   },
   "requestingStatus": "notRequested"
}

เมื่อมีการส่งคำขอที่ตรงกัน 매칭 요청 และการจับคู่ยังคงดำเนินอยู่ มันจะส่งคืนผลลัพธ์ requested และ matchingInProgress

{
   "playerId": 100,
   "matchInfo": {
       "gameIndex": 1,
       "matchId": 1
   },
   "requestingStatus": "requested",
   "requestingInfo": {
       "requestTimeUtc": "2024-06-05T05:09:28.72",
       "point": 1000
   },
   "matchingInfo": {
       "status": "matchingInProgress"
   }
}

เมื่อทำการตรวจสอบสถานะคำขอหลังจากการจับคู่เสร็จสิ้น จะส่งคืนผลลัพธ์เป็น matched หรือ timeout นี่คือสถานะหลังจากการจับคู่เสร็จสิ้น แต่ก่อนที่จะได้รับ ผลลัพธ์การจับคู่ callback

    {
       "playerId": 100,
       "matchInfo": {
           "gameIndex": 1,
           "matchId": 1
       },
       "requestingStatus": "requested",
       "requestingInfo": {
           "requestTimeUtc": "2024-06-05T05:09:28.72",
           "point": 1000
       },
       "matchingInfo": {
           "status": "matched"
       }
   }

เมื่อการจับคู่เสร็จสมบูรณ์ เซิร์ฟเวอร์ Hive จะ ส่งผลลัพธ์การจับคู่เป็นการเรียกกลับ ไปยังเซิร์ฟเวอร์ของนักพัฒนา หลังจากที่เซิร์ฟเวอร์ของนักพัฒนาได้รับการเรียกกลับผลลัพธ์การจับคู่และส่งกลับ HTTP Status 200 ไปยังเซิร์ฟเวอร์ Hive หากสถานะคำขอการจับคู่ถูกตรวจสอบอีกครั้ง จะเปลี่ยนเป็น notRequested ตามที่แสดงด้านล่าง และคีย์ matchingInfo จะถูกลบออก นี่เป็นเพราะเมื่อเซิร์ฟเวอร์ Hive ได้รับ HTTP Status 200 เป็นการตอบกลับการเรียกกลับ จะถือว่าการจับคู่ที่นักพัฒนาขอได้เสร็จสิ้นแล้วและจะลบธุรกรรมคำขอการจับคู่ที่เกี่ยวข้องออก

{
   "playerId": 100,
   "matchInfo": {
       "gameIndex": 1,
       "matchId": 1
   },
   "requestingStatus": "notRequested"
}

ยกเลิกคำขอจับคู่¶

ยกเลิกคำขอการจับคู่ หากคุณยกเลิกคำขอการจับคู่ คำขอการจับคู่ในเซิร์ฟเวอร์ Hive จะถูกลบออก

หากคำขอการจับคู่เสร็จสมบูรณ์หลังจากที่ ขอการจับคู่ และส่งสถานะ HTTP 200 ในการตอบกลับไปยัง การเรียกกลับผลการจับคู่ เซิร์ฟเวอร์ Hive จะถือว่าการจับคู่เสร็จสมบูรณ์ภายในและลบธุรกรรมคำขอการจับคู่ที่เกี่ยวข้อง ในสถานะนี้ แม้ว่าจะมีการเรียกยกเลิกคำขอการจับคู่ แต่ธุรกรรมคำขอการจับคู่ได้ถูกลบไปแล้ว ดังนั้นคำขอยกเลิกจะไม่ถูกดำเนินการ และจะไม่มีข้อยกเว้นใด ๆ ถูกส่งกลับแยกต่างหาก

URL การร้องขอ¶

พารามิเตอร์หัวเรื่อง¶

พารามิเตอร์เส้นทาง¶

การตอบกลับ¶

ในกรณีของ 200 OK ข้อมูลใน Body ว่างเปล่า

ตัวอย่างคำขอ¶

curl --location --request DELETE 'https://sandbox-api-match.withhive.com/gameindexes/1/matchmakings/1/players/100' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ya3a'

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

ไม่มีเนื้อหาการตอบสนองพิเศษเมื่อการประมวลผลสำเร็จ