API โปรไฟล์

API โปรไฟล์ใช้เมื่อดำเนินการ 'โปรไฟล์ชุมชน' โดยอิสระในชุมชนของคอนโซลหรือเมื่อเชื่อมโยง 'โปรไฟล์เกม' กับ 'โปรไฟล์ชุมชน'

การเตรียมการ

การลงทะเบียน API

คุณต้องลงทะเบียน API ที่เชื่อมโยงตามประเภทโปรไฟล์ที่คุณต้องการใช้โดยคลิกที่โปรไฟล์ชุมชนในคอนโซล

• ใช้เฉพาะโปรไฟล์ชุมชน, ลงทะเบียน API รูปโปรไฟล์พื้นฐาน
• เมื่อเชื่อมต่อโปรไฟล์เกม, ลงทะเบียน API โปรไฟล์เกม

สำหรับรายละเอียดเพิ่มเติม โปรดดูที่ การเชื่อมต่อ API โปรไฟล์ ในคอนโซล

อนุญาตกฎไฟร์วอลล์

เพื่อให้เซิร์ฟเวอร์ Hive สามารถส่งคำขอไปยัง API endpoint ของแอปเซิร์ฟเวอร์ได้ ให้เพิ่มกฎอนุญาตขาเข้า (Inbound) สำหรับที่อยู่ IP ด้านล่างในการตั้งค่าไฟร์วอลล์ของแอปเซิร์ฟเวอร์

IP ของเซิร์ฟเวอร์ Hive
15.165.223.210
3.34.158.195
43.202.20.33
13.209.91.38
3.34.235.15
15.165.134.120

API รูปโปรไฟล์พื้นฐาน

API รูปโปรไฟล์พื้นฐานจะถูกใช้เมื่อใช้โปรไฟล์ชุมชนเฉพาะในประเภทโปรไฟล์ชุมชน ดังที่แสดงด้านล่าง เมื่อเปลี่ยนรูปโปรไฟล์พื้นฐาน

เมื่อมีการร้องขอ API รูปโปรไฟล์พื้นฐาน เซิร์ฟเวอร์ Hive จะเรียกดู API ดังกล่าวด้วยโปรแกรมแบตช์ในเวลา 02:00 (KST) แล้วอัปเดตข้อมูลโปรไฟล์ (ใช้ร่วมกันระหว่างการใช้งานจริงและแซนด์บ็อกซ์)

ข้อกำหนดขนาดรูปโปรไฟล์มีดังต่อไปนี้

• ขนาดขั้นต่ำ 160 x 160px
• รูปทรงอัตราส่วนสี่เหลี่ยมจัตุรัส
• ค่ามุมและขอบของกรอบจะถูกนำไปใช้โดยพื้นฐาน

URL ที่ร้องขอ

URL เชิงพาณิชย์	https://{URL}/profile/get-image-list
URL ทดสอบ	https://{URL}/profile/get-image-list

เนื้อหาคำขอ

• ประเภทวิธีการ: POST
• พารามิเตอร์
  • ไม่มีพารามิเตอร์

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

• ประเภทข้อมูล: Json

• พารามิเตอร์

  ชื่อ	คำอธิบาย	ประเภท	ค่าของ value
  result	ค่าผลลัพธ์	JSON Object
  result.code	รหัสผลลัพธ์ (100 : สำเร็จ)	Integer	100
  result.msg	ข้อความผลลัพธ์	String
  params	พารามิเตอร์	JSON Object
  params.total	จำนวนรายการ	int	10
  params.list	รายการ (URL รูปภาพ)	String Away	["https://test-img.co.kr/profile1.jpg","https://test-img.co.kr/profile2.jpg" ...]

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

รหัสสถานะ HTTP	รหัส	ข้อความ	คำอธิบาย
200	100	สำเร็จ.	สำเร็จ

• กรุณาส่งมอบความสำเร็จเป็น 100 เสมอ

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

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params":{
        "total": 10,
        "list":[
                "https://test-img.co.kr/profile1.jpg",
                "https://test-img.co.kr/profile2.jpg",
                "https://test-img.co.kr/profile3.jpg",
                ……
                "https://test-img.co.kr/profile10.jpg"
        ]
    }
}

API โปรไฟล์เกม

API โปรไฟล์เกมจะถูกใช้ในกรณีที่เชื่อมโยงโปรไฟล์ชุมชนให้เหมือนกับโปรไฟล์เกมดังต่อไปนี้

โปรไฟล์ชุมชนที่เชื่อมโยงกับโปรไฟล์เกมจะถูกอัปเดตเมื่อผู้ดูแลชุมชนเข้าสู่ระบบชุมชน

URL คำขอ

URL การใช้งาน	https://${URL}/profile/get-player
URL ทดสอบ	https://${URL}/profile/get-player

เนื้อหาคำขอ

• ประเภทวิธีการ: POST

• พารามิเตอร์

  ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็นหรือไม่
  pid	PlayerID ของผู้ใช้	string	Y

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

{
    "pid" : "20000010000"
}

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

• ประเภทข้อมูล: Json

• พารามิเตอร์

  ชื่อ	คำอธิบาย	ประเภท	ค่า
  result	ค่าผลลัพธ์	JSON Obejct
  result.code	รหัสผลลัพธ์ (100:สำเร็จ)	Integer	100
  result.msg	ข้อความผลลัพธ์	String
  params	พารามิเตอร์	JSON Obejct
  params.pid	PlayerID ของผู้ใช้	String	20000010000
  params.nickname	ชื่อเล่นของผู้ใช้	String	홍길동
  params.p_image	URL ของภาพโปรไฟล์ผู้ใช้	String	https://test-img.co.kr/profile1.jpg หมายเหตุ: หากส่งเป็นค่าว่าง พื้นที่โปรไฟล์จะไม่แสดงในเว็บช็อป ดังนั้นแม้ไม่มีรูปภาพที่เหมาะสม ขอแนะนำให้ส่งรูปภาพเริ่มต้น

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

รหัสสถานะ HTTP	รหัส	ข้อความ	คำอธิบาย
	100	สำเร็จ.	สำเร็จ
	101	INVALID_REQUEST	ขาดคีย์ที่จำเป็น
	102	NOT_EXIST_USE	เมื่อผู้ใช้ไม่มีอยู่

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

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params": {
        "pid": "20000010000",
        "nickname": "홍길동",
        "p_image": "https://test-img.co.kr/profile1.jpg"
    }
}