การนำเว็บล็อกอินแบบกำหนดเองไปใช้¶

เอกสารนี้อธิบายวิธีนำเว็บล็อกอินไปใช้งานด้วย Hive Server API โดยตรงโดยไม่ใช้ หน้าเว็บล็อกอิน ที่ Hive Platform มีให้ หากผู้พัฒนาต้องการสร้าง UI สำหรับเข้าสู่ระบบของตนเองและจัดการการยืนยันตัวตนของ IdP โดยตรง ให้ดูเอกสารนี้

ภาพรวม¶

ใช้เว็บล็อกอินแบบกำหนดเองในกรณีต่อไปนี้

• เมื่อต้องการใช้ UI/UX สำหรับเข้าสู่ระบบที่เป็นเอกลักษณ์ของผู้พัฒนา
• เมื่อต้องการสร้างหน้าจอเข้าสู่ระบบให้สอดคล้องกับดีไซน์ของเว็บไซต์เดิม
• เมื่อต้องการให้ผู้ใช้เข้าสู่ระบบภายในหน้าของตนเองโดยไม่ต้องรีไดเรกต์ไปยังหน้าเว็บล็อกอิน

รายการ API¶

ส่วนหัวคำขอทั่วไป¶

ส่วนหัวการตอบกลับทั่วไป¶

รูปแบบการตอบกลับทั่วไป¶

การตอบกลับเมื่อสำเร็จ¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": { }
}

การตอบกลับเมื่อล้มเหลว¶

{
    "result_code": 4000,
    "result_msg": "Request has invalid format.",
    "data": null
}

การเข้าสู่ระบบด้วย IdP¶

สร้างผู้เล่นใหม่ด้วยข้อมูล IdP หรือส่งคืนข้อมูลผู้เล่นเดิมหาก IdP นั้นลงทะเบียนไว้แล้ว เมื่อเข้าสู่ระบบสำเร็จ คุณสามารถตรวจสอบ PlayerID ได้จาก data.player_id

Request URL¶

Request Body¶

Request Body Example¶

{
    "appid": "com.com2us.example",
    "idp_index": 3,
    "idp_user_id": "google_67890",
    "hive_certification_key": "your_certification_key",
    "require_token": true
}

Response Header¶

Response Header Example¶

HTTP/1.1 200
Content-Type: application/json; charset=UTF-8
Authorization: abcdf7ebce779429ea878f91d5f1c8
Iscrypt: 0

Response Body¶

Response Body Sample (สำเร็จ)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": {
        "player_id": 100000002,
        "idp_index": 3,
        "idp_id": "GOOGLE",
        "idp_user_id": "google_67890"
    }
}

Response Body Sample (ล้มเหลว)¶

{
    "result_code": 4002,
    "result_msg": "Invalid certfication key"
}

รหัสข้อผิดพลาด¶

การเชื่อมโยง IdP¶

เชื่อมโยง IdP ใหม่กับบัญชีผู้เล่นเดิม ต้องเรียกใช้หลังจากเข้าสู่ระบบผ่าน API การเข้าสู่ระบบด้วย IdP เท่านั้น

Request URL¶

Request Body¶

Request Body Example¶

{
    "appid": "com.com2us.example",
    "idp_index": 2,
    "idp_user_id": "fb_12345678",
    "player_id": 100000001,
    "hive_certification_key": "your_certification_key"
}

Response Body¶

Response Body Sample (สำเร็จ)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "data": {
        "player_id": 100000001,
        "idp_index": 2,
        "idp_id": "FACEBOOK",
        "idp_user_id": "fb_12345678"
    }
}

Response Body Sample (หากเชื่อมโยงกับผู้เล่นคนอื่นอยู่แล้ว)¶

{
    "result_code": 1002,
    "result_msg": "Already connected other player",
    "data": {
        "player_id": 100000002,
        "idp_index": 2,
        "idp_id": "FACEBOOK",
        "idp_user_id": "fb_12345678"
    }
}

รหัสข้อผิดพลาด¶

ยกเลิกการเชื่อมโยง IdP¶

ยกเลิกการเชื่อมโยง IdP ที่เชื่อมโยงกับบัญชีผู้เล่น ต้องเรียกใช้หลังจากเข้าสู่ระบบผ่าน API การเข้าสู่ระบบด้วย IdP เท่านั้น

Request URL¶

Request Body¶

Request Body Example¶

{
    "appid": "com.com2us.example",
    "idp_index": 2,
    "idp_user_id": "fb_12345678",
    "player_id": 100000001,
    "hive_certification_key": "your_certification_key"
}

Response Body¶

Response Body Sample (สำเร็จ)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS"
}

Response Body Sample (ล้มเหลว)¶

{
    "result_code": 4002,
    "result_msg": "Invalid certfication key"
}

รหัสข้อผิดพลาด¶

ลบบัญชี¶

ลบบัญชีผู้เล่น ต้องเรียกใช้หลังจากเข้าสู่ระบบผ่าน API การเข้าสู่ระบบด้วย IdP เท่านั้น

API นี้ต้องตรวจสอบโทเค็น จึงต้องดำเนินการต่อไปนี้ล่วงหน้า

1. เมื่อเรียก API การเข้าสู่ระบบด้วย IdP ให้ตั้งค่า require_token เป็น true
2. จัดเก็บค่า Authorization ที่ได้รับจากส่วนหัวการตอบกลับของ API การเข้าสู่ระบบด้วย IdP
3. เมื่อเรียก API นี้ ให้ใส่ค่า Authorization ที่จัดเก็บไว้ข้างต้นในส่วนหัวคำขอ

Request URL¶

Request Header¶

Request Body¶

Request Body Example¶

{
    "appid": "com.com2us.example",
    "player_id": 100000001,
    "did": 0,
    "hive_certification_key": "your_certification_key"
}

Response Body¶

Response Body Sample (สำเร็จ)¶

{
    "result_code": 0,
    "result_msg": "SUCCESS"
}

Response Body Sample (ล้มเหลว)¶

{
    "result_code": 7000,
    "result_msg": "Invalid token."
}

รหัสข้อผิดพลาด¶

คำจำกัดความรหัส IdP¶

IdP พื้นฐาน¶

IdP แบบกำหนดเอง¶