API การจับคู่¶
คุณสามารถใช้ matchmaking กับเกมโดยใช้ Matchmaking API
API การจับคู่ประกอบด้วย Private Match API และ Group Match API เป็นหลัก นอกจากนี้ เมื่อการจับคู่เสร็จสิ้น คุณสามารถตรวจสอบสถานะการจับคู่ได้ผ่าน Matching Result Callback API
ข้อกำหนดเบื้องต้น¶
ในการใช้ API การจับคู่ จำเป็นต้องมีรายการต่อไปนี้
- โทเค็นการรับรองความถูกต้องสำหรับการเรียก API (
Hive Certification Key
): สามารถพบได้ในคอนโซล Hive ภายใต้ App Center > Project Management > Select App after searching > Game Details > Basic Information > Hive Certification Key - ดัชนีเกม (
gameIndex
): สามารถพบได้ในคอนโซล Hive ภายใต้ App Center > Project Management > Select App after searching > Game Details > Basic Information > Game Index - Match ID (
matchId
): สามารถพบได้เมื่อสร้างแมตช์ในคอนโซล Hive
ข้อมูลพื้นฐาน¶
นี่อธิบายข้อมูลพื้นฐานที่คุณจำเป็นต้องรู้โดยทั่วไปก่อนที่จะใช้ API การจับคู่
URL การร้องขอ¶
API การจับคู่จะร้องขอที่ URL ด้านล่างนี้
เซิร์ฟเวอร์ | URL |
---|---|
LIVE | api-match.withhive.com |
SANDBOX | sandbox-api-match.withhive.com |
รหัสการตอบกลับ¶
รหัสสถานะการตอบกลับ HTTP ที่ใช้บ่อยเมื่อทำการร้องขอไปยัง API การจับคู่
นอกจากรหัสการตอบกลับแล้ว คุณสามารถตรวจสอบรหัสข้อผิดพลาดที่ให้โดยเซิร์ฟเวอร์ Hive ในกรณีที่เกิดข้อผิดพลาดในการดำเนินการ API การจับคู่ได้ใน เอกสารอ้างอิง
รหัส | ค่า | คำอธิบาย |
---|---|---|
200 | สำเร็จ | ดูที่การตอบสนอง API แต่ละรายการ |
400 | คำขอไม่ถูกต้อง | พารามิเตอร์คำขอหรือข้อมูลในคำขอไม่ถูกต้อง |
401 | ไม่ได้รับอนุญาต | ส่วนหัวการอนุญาตในข้อความคำขอขาดหายไปหรือค่าของมันไม่ถูกต้อง |
403 | ห้ามเข้าถึง | โทเค็นการตรวจสอบสิทธิ์ (Hive Certification Key) สำหรับการเรียก API ไม่ถูกต้อง |
404 | ไม่พบ | พาธ API ไม่ถูกต้อง |
500 | ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน | เกิดปัญหาภายในเซิร์ฟเวอร์ |