ภาพรวมการเชื่อมต่อระบบ
ภาพรวม¶
- แนะนำสั้น ๆ เกี่ยวกับ คู่มือการเชื่อมต่อ API ของนักพัฒนาเกม MiraclePlay ที่ให้บริการโดย MiraclePlay
ภาพรวมการเชื่อมต่อ¶
- MiraclePlay API ใช้สำหรับการสื่อสาร WebAPI ในรูปแบบ RestFul สำหรับข้อมูลเฉพาะ เช่น คะแนน/ความสำเร็จ/การกระทำต่างๆ ในเกม
- จะมีการจัดเตรียมเพื่อให้สามารถใช้งานได้ในรูปแบบการแข่งขันที่หลากหลายของ MiraclePlay
โครงสร้างการเชื่อมต่อ¶
- เมื่อข้อมูลในเกมถูกเก็บในฐานข้อมูล มิราเคิลเพลย์จะใช้ Join API และ GameData API 2 ตัวในการเชื่อมต่อข้อมูลที่จำเป็นสำหรับการแข่งขัน
- ในกรณีนี้ API 2 ตัวที่จำเป็นสามารถให้กับมิราเคิลเพลย์ได้โดยไม่ต้องสร้าง API แยกต่างหากโดยใช้การวิเคราะห์
กฎการแข่งขัน¶
- รูปแบบการแข่งขัน: มี 2 รูปแบบคือ Ranking Battle และ Tournament Battle- Ranking Battle: มอบรางวัลตามอันดับของผู้เข้าร่วม
- Tournament Battle: การต่อสู้ระหว่างบุคคล/ทีมเพื่อให้ผู้ชนะเข้าสู่รอบถัดไป
 
- วิธีการนับคะแนน: จะแบ่งคะแนนออกเป็นคะแนนสูงสุด, คะแนนรวม, คะแนนเฉลี่ย โดยแยกเป็นแบบเดี่ยว/ทีม 2 ประเภท
การเชื่อมต่อ API¶
- Join API: API สำหรับตรวจสอบการมีบัญชีเมื่อเข้าร่วมการแข่งขัน- ต้องมีฟิลด์ UUID, NickName
- หากส่งบันทึกไปยัง Analytics สามารถใช้ API 'ตรวจสอบข้อมูล' ที่ Analytics ให้มาแทน Join API ได้- สามารถกำหนดบันทึกใหม่ที่ประกอบด้วยฟิลด์ UUID, NickName ใน Analytics หรือใช้ฟิลด์ playerId, userId ของ 'บันทึกเนื้อหา' ที่กำหนดไว้ล่วงหน้าเพื่อแทนที่ข้อมูล UUID, NickName
 
 
(25.04.07 기준) ตัวอย่างการออกแบบ API เข้าร่วม
| แยก | คำอธิบาย | การใช้งาน | ประเภท | ส่วนประกอบ | 
|---|---|---|---|---|
| UUID | รหัสประจำตัวที่ไม่ซ้ำกันของผู้ใช้ | ตรวจสอบการจับคู่ MiraclePlay | POST | จำเป็น | 
| NickName | ตรวจสอบการมีอยู่เป็น true/false | ตรวจสอบว่ามีอยู่ในเกมจริงหรือไม่ | POST | จำเป็น | 
| ClientVer | ข้อมูลเวอร์ชันของไคลเอนต์ | ตรวจสอบให้ตรงกับเวอร์ชันขั้นต่ำของผู้เข้าร่วมเกม | POST | เลือกได้ | 
| AccessKey | AccessKey สำหรับความปลอดภัยของข้อมูล | เพิ่มค่าฟิลด์ที่จำเป็นเมื่อเรียก API (อาจแตกต่างกันไปตามผู้ผลิต) | POST | เลือกได้ | 
| API URL | 
- GameData API: API สำหรับบันทึกผลการแข่งขัน- ต้องมีฟิลด์ UUID
- ฟิลด์อื่นๆ จะแตกต่างกันไปตามเกมและการแข่งขัน
- หากส่งบันทึกไปยัง Analytics สามารถใช้ API ‘การดึงข้อมูล’ ที่ Analytics ให้มาแทนที่ GameData API ได้- สามารถกำหนดบันทึกใหม่ที่ประกอบด้วย UUID และฟิลด์ที่จำเป็นสำหรับ API ใน Analytics หรือแทนที่ข้อมูล UUID ด้วยฟิลด์ playerId ของ ‘บันทึกเนื้อหา’ ที่กำหนดไว้ล่วงหน้า และสามารถแทนที่ฟิลด์ที่จำเป็นสำหรับ GameData API ด้วยข้อมูลที่เกี่ยวข้องกับเนื้อหาอื่นๆ
 
 
(25.04.07 기준) ตัวอย่างการออกแบบ API DataData
| แยก | คำอธิบาย | การใช้งาน | ประเภท | ส่วนประกอบ | 
|---|---|---|---|---|
| UUID | รหัสประจำตัวเฉพาะของผู้ใช้ | ตรวจสอบการจับคู่ MiraclePlay | POST | จำเป็น | 
| NickName | - | (ใช้ชื่อเล่นของ MiraclePlay) | POST | เลือกได้ | 
| ClientVer | ข้อมูลเวอร์ชันของไคลเอนต์ | ตรวจสอบเวอร์ชันในขณะเล่นของผู้เข้าร่วม | POST | เลือกได้ | 
| Starttime | เวลาที่เริ่มเกม (GMT) | สรุปผลการแข่งขัน | POST | ต่อเกม | 
| Endtime | เวลาที่เกมสิ้นสุด (GMT) | สรุปผลการแข่งขัน | POST | ต่อเกม | 
| Score | ข้อมูลผลลัพธ์ที่บันทึก | สรุปผลการแข่งขัน | POST | ต่อเกม | 
| playTime | เวลาการเล่นรวม | สรุปผลการแข่งขัน | POST | ต่อเกม | 
| AccessKey | AccessKey สำหรับความปลอดภัยของข้อมูล | เพิ่มค่าฟิลด์ที่จำเป็นเมื่อเรียกใช้ API (วิธีการอาจแตกต่างกันไปในแต่ละกรณี) | POST | เลือกได้ | 
อื่น ๆ¶
- จำเป็นต้องปฏิบัติตามฟีเจอร์ที่แนะนำหรือแนวทางด้านความปลอดภัยสำหรับลูกค้า ซึ่งต้องอ้างอิงจากคู่มือ MiraclePlay: ฟีเจอร์ที่แนะนำสำหรับลูกค้า, นโยบายความปลอดภัย
