ข้ามไปที่เนื้อหา

API การเปิดตัวระยะไกลของ Crossplay Launcher

ภาพรวม

API การเรียกใช้ระยะไกลของ Crossplay Launcher มีฟังก์ชันในการสอบถามรายการของ PC ที่กำลังทำงานและเลือก PC เฉพาะเพื่อเรียกใช้เกมระยะไกลหากเกมถูกยกเลิกโดยไม่ตั้งใจในขณะที่ทำงานกับ Crossplay Launcher.

มันประกอบด้วย PC List Query API และ PC Remote Execution API เป็นหลัก

ข้อกำหนดเบื้องต้น

  • เวอร์ชัน Windows ของ Hive SDK v4.24.4.0 หรือสูงกว่า
  • Crossplay Launcher 1.0.16.0 หรือสูงกว่า

ขั้นตอนการทำงานพื้นฐาน

  • ตั้งค่าให้ใช้การดำเนินการระยะไกลสำหรับแต่ละเกม

    Note

    ขณะนี้ รองรับเพียงการตั้งค่าด้วยตนเองว่าใช้การดำเนินการระยะไกลหรือไม่ และฟังก์ชันการตั้งค่าอัตโนมัติจะมีให้ในอนาคต

  • เรียกเล่นเกมบนพีซี Windows ผ่าน Crossplay Launcher.

  • เรียกใช้ PC List Query API ในเกมเพื่อตรวจสอบรายการพีซีที่ทำงานด้วย Crossplay Launcher.
  • เรียกใช้ PC Remote Run API ด้วยข้อมูลของพีซีที่เลือกจากรายการพีซีเป็นผลลัพธ์ของการค้นหา.
    (โทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกจะถูกส่งไปยังพีซีที่เลือก.)
  • เชื่อมต่อกลับไปยังเกมและเข้าสู่ระบบอัตโนมัติด้วยโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกจาก Crossplay Launcher.

API ค้นหารายการ PC

นี่คือ API ที่สอบถามรายชื่อ PC ที่กำลังทำงานอยู่ด้วย Crossplay Launcher และสามารถทำการรันระยะไกลได้

Note
  • การสอบถามรายการ PC เป็นไปได้เฉพาะเมื่อคำขอถูกต้องหลังจากการตรวจสอบผ่าน API Token Verification

URL และเงื่อนไขการร้องขอ

หมวดหมู่ URL และเงื่อนไข
URL เชิงพาณิชย์ https://api-launcherplay.withhive.com/api/pc/list
URL SANDBOX https://sandbox-api-launcherplay.withhive.com/api/pc/list
วิธีการ HTTP PUT
รูปแบบข้อมูล JSON

หัวข้อคำขอ

ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
Content-Type application/json String Y
Authorization Bearer token key
(Token key ที่ส่งคืนหลังจากเข้าสู่ระบบสำเร็จ)
String Y

ตัวอย่างส่วนหัวของคำขอ

Content-Type : application/json
Authorization : Bearer b630b963152efa1f97a8c066831222

เนื้อหาคำขอ

ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
appId AppID ของเกมที่เข้าสู่ระบบ String Y
playerId PlayerID ของการตรวจสอบสิทธิ์ V4 ที่ส่งกลับหลังจากเข้าสู่ระบบสำเร็จ String Y
did DID ที่ส่งกลับหลังจากเข้าสู่ระบบสำเร็จ String Y

ตัวอย่างเนื้อหาคำขอ

{
    "appId" : "com.com2us.hivesdk.normal.freefull.google.global.android.common",
    "playerId" : "20000023036",
    "did" : "304166094"
}

เนื้อหาการตอบกลับ

ชื่อฟิลด์ คำอธิบาย ประเภท
code รหัสผลลัพธ์การตอบกลับ จำนวนเต็ม
msg ข้อความผลลัพธ์การตอบกลับ สตริง
data รายการของ PC ที่สามารถดำเนินการได้ อาร์เรย์
pc_name ชื่อ PC สตริง
did ข้อมูลอุปกรณ์ สตริง

ตัวอย่างเนื้อหาการตอบกลับ

{
    "code": 100,
    "msg": "success",
    "data": [
        {
            "pc_name" : "pc1",
            "did" : "304162817",
        },
        {
            "pc_name" : "pc2",
            "did" : "304166094"
        },
        ...
    ]
}

ข้อกำหนดรหัสการตอบกลับ

รหัส ข้อความ คำอธิบาย
100 สำเร็จ สำเร็จ
101 สำเร็จ(ไม่มีอยู่) สำเร็จ
└ อย่างไรก็ตาม เนื่องจากไม่มีรายการที่สามารถดำเนินการจากระยะไกลได้ ข้อมูลจึงไม่ถูกส่งกลับ
400 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์การอนุญาต) พารามิเตอร์ส่วนหัวไม่ถูกต้อง
└ การอนุญาต
401 ล้มเหลว(ข้อผิดพลาดวิธีการ) คำขอ HTTP METHOD ไม่ถูกต้อง
402 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์คำขอ) พารามิเตอร์คำขอไม่มีอยู่
403 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ appId) พารามิเตอร์ไม่ถูกต้อง
└ appId
404 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ playerId) พารามิเตอร์ไม่ถูกต้อง
└ playerId
405 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ did) พารามิเตอร์ไม่ถูกต้อง
└ did
500 ล้มเหลว(ข้อผิดพลาด hiveCertificationKey) ไม่สามารถดึงข้อมูลเกมที่เกี่ยวข้อง (คีย์การรับรองความถูกต้องของ Hive)
501 ล้มเหลว(####) ข้อผิดพลาดอื่น #### เกิดขึ้นระหว่างการตรวจสอบเซิร์ฟเวอร์การรับรองความถูกต้อง
502 ล้มเหลว(####) ข้อผิดพลาดอื่น #### เกิดขึ้นระหว่างการดึงรายการ PC
503 ล้มเหลว(####) เมื่อเข้าถึง Redis เพื่อดึงรายการ PC จะเกิดข้อผิดพลาด ####
900 ล้มเหลว(ข้อผิดพลาด curl - ####) กำลังตรวจสอบเซิร์ฟเวอร์การรับรองความถูกต้อง เกิดข้อผิดพลาด curl เมื่อเรียก API (เกิดข้อผิดพลาด ####)
901 ล้มเหลว(ข้อผิดพลาด api - ####) การตรวจสอบเซิร์ฟเวอร์การรับรองความถูกต้องล้มเหลว (เกิดข้อผิดพลาด ####)

API การดำเนินการระยะไกลของ PC

นี่คือ API ที่ส่งข้อมูลโทเค็นเพื่อดำเนินการพีซีที่เลือกจากรายการพีซีที่ดึงมาได้หลังจากขอ PC List Inquiry API

Note

  • API นี้ส่งโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกไปยัง PC ที่เลือก และการดำเนินการระยะไกลจริง (การเข้าถึงเกมและการเข้าสู่ระบบอัตโนมัติ) จะทำงานใน Crossplay Launcher
  • จะสามารถใช้งานได้เฉพาะเมื่อคำขอถูกต้องหลังจากการตรวจสอบผ่าน API Token Verification

URL และเงื่อนไขการร้องขอ

หมวดหมู่ URL และเงื่อนไข
URL เชิงพาณิชย์ https://api-launcherplay.withhive.com/api/pc/remoteplay
URL SANDBOX https://sandbox-api-launcherplay.withhive.com/api/pc/remoteplay
วิธีการ HTTP POST
รูปแบบข้อมูล JSON

ส่วนหัวคำขอ

ส่วนหัวคำขอ

ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
Content-Type application/json String Y
Authorization Bearer token key
(Token key ที่ส่งคืนหลังจากเข้าสู่ระบบสำเร็จ)
String Y

ตัวอย่างหัวข้อคำขอ

Content-Type : application/json
Authorization : Bearer b630b963152efa1f97a8c066831222

เนื้อหาคำขอ

ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
appId AppID ของเกมที่เข้าสู่ระบบ String Y
playerId PlayerID การรับรองความถูกต้อง V4 ที่ส่งคืนหลังจากการเข้าสู่ระบบสำเร็จ String Y
did DID ที่ส่งคืนหลังจากการเข้าสู่ระบบสำเร็จ String Y
idpUserId ค่า ID สมาชิกที่จัดเตรียมโดย IDP หลังจากการเข้าสู่ระบบสำเร็จ String Y
idpIndex ข้อมูล INDEX ของ IDP
1: HIVE
2: Facebook
3: GOOGLE
9: APPLE
Integer Y
selected_did ในผลลัพธ์การค้นหาของ /api/pc/list DID ของ PC ที่เลือก String Y
selected_pcName ในผลลัพธ์การค้นหาของ /api/pc/list ชื่อ PC ที่เลือก String Y

ตัวอย่างเนื้อหาคำขอ

{
    "appId" : "com.com2us.hivesdk.normal.freefull.google.global.android.common",
    "playerId" : "20000023036",
    "did" : "304166094",
    "idpUserId" : "68261324",
    "idpIndex" : 1,
    "selected_did" : "304162817",
    "selected_pcName" : "pc1"
}

เนื้อหาการตอบกลับ

ชื่อฟิลด์ คำอธิบาย ประเภท
code รหัสผลลัพธ์การตอบกลับ จำนวนเต็ม
msg ข้อความผลลัพธ์การตอบกลับ สตริง

ตัวอย่างเนื้อหาการตอบกลับ

{
    "code" : 100,
    "msg" : "success"
}

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

รหัส ข้อความ คำอธิบาย
100 สำเร็จ สำเร็จ
400 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์การอนุญาต) ข้อผิดพลาดพารามิเตอร์ส่วนหัว
└ การอนุญาต
401 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์คำขอ) พารามิเตอร์คำขอไม่มี
402 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ appId) ข้อผิดพลาดพารามิเตอร์
└ appId
403 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ playerId) ข้อผิดพลาดพารามิเตอร์
└ playerId
404 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ did) ข้อผิดพลาดพารามิเตอร์
└ did
405 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ idpUserId) ข้อผิดพลาดพารามิเตอร์
└ idpUserId
406 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ idpIndex) ข้อผิดพลาดพารามิเตอร์
└ idpIndex
407 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ selected_did) ข้อผิดพลาดพารามิเตอร์
└ selected_did
408 ล้มเหลว(ข้อผิดพลาดพารามิเตอร์ selected_pcName) ข้อผิดพลาดพารามิเตอร์
└ selected_pcName
409 ล้มเหลว(ข้อผิดพลาดวิธีการ) คำขอด้วย HTTP METHOD ที่ไม่ถูกต้อง
500 ล้มเหลว(ข้อผิดพลาด hiveCertificationKey) ไม่สามารถดึงข้อมูลเกมที่เกี่ยวข้อง (คีย์การตรวจสอบสิทธิ์ Hive)
501 ล้มเหลว(####) ในระหว่างการตรวจสอบสิทธิ์เซิร์ฟเวอร์เกิดข้อผิดพลาด ####
502 ล้มเหลว(ปัจจุบันไม่มีอยู่หรือไม่สามารถใช้งานได้) ล้มเหลวเนื่องจากข้อมูล PC ที่เลือกไม่ได้เชื่อมต่อในขณะนี้
503 ล้มเหลว(####) เมื่อเข้าถึง Redis เพื่อตรวจสอบข้อมูล PC ที่เลือกเกิดข้อผิดพลาด ####
504 ล้มเหลว(มีมากกว่า 2 รายการ) หากมีการเชื่อมต่อมากกว่า 2 รายการที่สอดคล้องกับข้อมูล PC ที่เลือก จะล้มเหลว.
└ หมายเหตุ: เกิดขึ้นเมื่อ playerId, did และชื่อ PC เหมือนกันทั้งหมด.
505 ล้มเหลว(####) ตรวจสอบข้อมูล PC ที่เลือกเกิดข้อผิดพลาด ####
506 ล้มเหลว(####) การดึงข้อมูลที่เกี่ยวข้องกับโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอก (enc_idp และ web_idp_token) เกิดข้อผิดพลาด ####
507 ล้มเหลว(ข้อผิดพลาดการเผยแพร่) ไม่สามารถส่งโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกไปยัง PC ที่เลือกได้.
ᄂ หมายเหตุ: เกิดขึ้นเมื่อจำนวน PC ที่ได้รับข้อความน้อยกว่า 1 (ค่าผลลัพธ์การเผยแพร่ redis).
508 ล้มเหลว(####) เมื่อเข้าถึง Redis เพื่อส่งโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกไปยัง PC ที่เลือกเกิดข้อผิดพลาด ####
509 ล้มเหลว(####) ส่งโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกไปยัง PC ที่เลือกเกิดข้อผิดพลาด ####
900 ล้มเหลว(ข้อผิดพลาด curl - ####) กำลังดำเนินการตรวจสอบสิทธิ์เซิร์ฟเวอร์, เกิดข้อผิดพลาด curl เมื่อเรียก API (เกิดข้อผิดพลาด ####)
901 ล้มเหลว(ข้อผิดพลาด api - ####) การตรวจสอบสิทธิ์เซิร์ฟเวอร์ล้มเหลว (เกิดข้อผิดพลาด ####)
902 ล้มเหลว(ข้อผิดพลาด curl - ####) กำลังดำเนินการดึงค่า enc_idp สำหรับการดึงโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอก, เกิดข้อผิดพลาด curl เมื่อเรียก API (เกิดข้อผิดพลาด ####)
903 ล้มเหลว(ข้อผิดพลาด api - ####) การดึงค่า enc_idp สำหรับการดึงโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอกล้มเหลว (เกิดข้อผิดพลาด ####)
904 ล้มเหลว(ข้อผิดพลาด curl - ####) กำลังดำเนินการดึงโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอก (web_idp_token), เกิดข้อผิดพลาด curl เมื่อเรียก API (เกิดข้อผิดพลาด ####)
905 ล้มเหลว(ข้อผิดพลาด api - ####) การดึงโทเค็นการเข้าสู่ระบบอัตโนมัติภายนอก (web_idp_token) ล้มเหลว (เกิดข้อผิดพลาด ####)