การออก OAuth token¶

ออกโทเค็น OAuth ที่จำเป็นสำหรับการตรวจสอบการอนุญาตและการตรวจสอบสิทธิ์ที่ปลอดภัยเมื่อเรียกใช้ Hive Server API API 'ออกโทเค็น OAuth' เป็นไปตามมาตรฐาน OAuth 2.0 Client Credentials Grant และทำงานเป็นขั้นตอนการตรวจสอบสิทธิ์แบบเซิร์ฟเวอร์ถึงเซิร์ฟเวอร์ โดยที่เซิร์ฟเวอร์แอปเรียกใช้เซิร์ฟเวอร์การตรวจสอบสิทธิ์ Hive โดยตรง API 'การออกโทเค็น OAuth' มีลักษณะดังต่อไปนี้ - ออกโทเค็นโดยใช้รหัสลูกค้าและความลับเท่านั้น - ออกเฉพาะโทเค็นการเข้าถึง (ไม่มีการออกโทเค็นการรีเฟรช) - ใช้ได้ 1 ชั่วโมง (3600 วินาที)

URL คำขอ¶

curl -X POST https://auth.qpyou.cn/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
    "grant_type": "client_credentials",
    "client_id": "project_abc123",
    "client_secret": "secret_xyz789"
  }'

ร่างกาย¶

{
  "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
  "grant_type": "client_credentials",
  "client_id": "project_abc123",
  "client_secret": "secret_xyz789"
}

เนื้อหาการตอบสนอง¶

รหัสตอบกลับ¶

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

{
  "result_code": 0,
  "result_msg": "SUCCESS",
  "data": {
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InByb2plY3RfYWJjMTIzIn0.eyJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5leGFtcGxlIiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsImdyYW50X3R5cGUiOiJwcm9qZWN0IiwiaWF0IjoxNzE1NTg0MDAwLCJleHAiOjE3MTU1ODc2MDAsImF1dGhfdmVyIjoidjQiLCJ1c2VyX2lkIjoiIiwiaXNfd2hpdGVsaXN0Ijp0cnVlfQ.signature"
  }
}

ตัวอย่างการตอบสนองข้อผิดพลาด¶

{
  "result_code": 4001,
  "result_msg": "INVALID_CLIENT",
  "data": null
}

วิธีใช้โทเค็น¶

รวมโทเค็นการเข้าถึงที่ออกไว้ในส่วนหัว HTTP เมื่อเรียกใช้ Hive Server API

โครงสร้างโทเค็น JWT¶

โทเค็นการเข้าถึงที่ออกให้อยู่ในรูปแบบ JWT (JSON Web Token) และประกอบด้วยสามส่วนที่คั่นด้วยจุด (.): ส่วนหัว เพย์โหลด และลายเซ็น

หัวเรื่อง¶

การตั้งค่าส่วนหัว¶

curl -X POST https://auth.qpyou.cn/v2/game/player/get-idp \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InByb2plY3RfYWJjMTIzIn0..." \
  -H "ISCRYPT: 0" \
  -d '{
    "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
    "player_id": 123456789
  }'

ข้อผิดพลาดในการตรวจสอบโทเค็น JWT¶

เมื่อการตรวจสอบโทเค็น JWT ล้มเหลวใน Hive Server API ข้อมูลข้อผิดพลาดโดยละเอียดจะถูกระบุผ่านฟิลด์ token_validation

ฟิลด์โทเค็น_การตรวจสอบความถูกต้อง¶

ฟิลด์นี้มีข้อมูลข้อผิดพลาดในการตรวจสอบ JWT: | ชื่อฟิลด์ | คำอธิบาย | ประเภท | | --- | --- | --- | | token_validation | รายละเอียดการตรวจสอบ JWT | Object | | token_validation.result_code | รหัสผลลัพธ์การตรวจสอบ JWT รายละเอียด | Integer | | token_validation.result_msg | ข้อความผลการตรวจสอบ JWT | String | ???+ note- เมื่อการตรวจสอบ JWT สำเร็จ: token_validation.result_code: 0 - เมื่อการตรวจสอบ JWT ล้มเหลว: รหัสข้อผิดพลาดโดยละเอียดจะถูกส่งกลับใน token_validation.result_code - ฟิลด์นี้มักใช้โดย Hive Server API

ตัวอย่างการตอบกลับข้อผิดพลาด¶

ไม่มีข้อมูลลูกค้า¶

"token_validation": {
  "result_code": 2400,
  "result_msg": "No client information found."
}

โทเค็นหายไป¶

"token_validation": {
  "result_code": 2406,
  "result_msg": "The access token is missing."
}

ข้อผิดพลาดลายเซ็นโทเค็น¶

"token_validation": {
  "result_code": 2407,
  "result_msg": "Invalid token signature."
}

โทเค็นหมดอายุ¶

"token_validation": {
  "result_code": 2408,
  "result_msg": "The access token is expired. Please refresh your token."
}

รหัสข้อผิดพลาดในการตรวจสอบ JWT¶

"token_validation": {
  "result_code": 0,
  "result_msg": "success"
}

การต่ออายุโทเค็น¶

โทเค็นการรีเฟรชไม่ได้ออกใน Client Credentials Grant

การจัดการการหมดอายุของโทเค็น¶

1. Access Token จะหมดอายุ (1 ชั่วโมงหลังจากออก)
2. การตรวจสอบ JWT ล้มเหลวเมื่อเรียก API (token_validation.result_code: 2408)
3. เรียก /oauth/token API เพื่อออกโทเค็นการเข้าถึงใหม่อีกครั้ง

โทเค็นที่แนะนำนำมาใช้ซ้ำ¶

Access Token สามารถใช้ซ้ำได้จนกว่าจะหมดอายุ คำแนะนำ: - แนะนำ: แคชโทเค็นที่ออกและนำมาใช้ซ้ำจนกว่าจะหมดอายุ - ไม่แนะนำ: ออกโทเค็นใหม่สำหรับการเรียก API ทุกครั้ง

คำแนะนำด้านความปลอดภัย¶

การจัดการความลับของลูกค้า¶

ความลับของลูกค้าเป็นข้อมูลที่ละเอียดอ่อนและต้องได้รับการจัดการอย่างปลอดภัย | รายการ | คำอธิบาย | | --- | --- | | ห้ามเปิดเผย | อย่าเปิดเผยความลับของลูกค้ากับลูกค้า (แอป/เว็บ) | | เซิร์ฟเวอร์เท่านั้น | ใช้เฉพาะบนเซิร์ฟเวอร์เกมเท่านั้น (การสื่อสารแบบ Server-to-Server) | | การจัดเก็บที่ปลอดภัย | เก็บไว้ในตัวแปรสภาพแวดล้อมหรือที่เก็บข้อมูลที่ปลอดภัย (Vault) |

ต้องใช้ HTTPS¶

คุณต้องใช้ HTTPS เมื่อออกโทเค็น OAuth และการเรียก API - แนะนำ: https://auth.qpyou.cn/oauth/token - ต้องห้าม: ใช้ http:// (เสี่ยงต่อการโจมตีแบบแทรกกลาง)