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

Guide Changes Notice

[คู่มือสำหรับนักพัฒนา] การเปลี่ยนแปลงเนื้อหาและโครงสร้างของคู่มือสำหรับนักพัฒนา

เราจะเปลี่ยนเนื้อหาและโครงสร้างของคู่มือสำหรับนักพัฒนาดังต่อไปนี้

ก่อนเปลี่ยน

หน้าแนะนำการเริ่มต้นใช้งาน SDK ของ Hive มีคำแนะนำเกี่ยวกับการจัดเตรียม, การสนับสนุนลูกค้า, และคู่มือการพัฒนาที่เกี่ยวข้องกับชุมชน.

หลัง

แยกหน้าคู่มือสำหรับนักพัฒนาสำหรับ การเริ่มต้น Hive SDK, การจัดเตรียม, บริการลูกค้า, และ ชุมชน. อัปเดตเนื้อหาและปรับปรุงความสามารถในการอ่านและการเข้าถึง

[คู่มือ API] อัปเดตคู่มือ API สำหรับการล็อกอินผ่านเว็บ

\ ได้มีการอัปเดต คู่มือ API การล็อกอินผ่านเว็บ แล้ว

นื่องจากเวอร์ชันเดิมที่แยกกันของ Web Login API (v2 และ v1) ไม่มีการสนับสนุนอีกต่อไป คู่มือจึงได้รับการปรับปรุงให้เป็นเวอร์ชันรวมที่อัปเดตแล้ว

นอกจากนี้ยังมีการเพิ่มคู่มือสำหรับ การรีเฟรชโทเค็น และ การทำให้ล็อกอินคงอยู่ (SSO)

การอัปเดตเอกสาร API: การอัปเดตคู่มือ API แชท

ฉันได้เปลี่ยนการจำแนกประเภท API และแก้ไขข้อมูลหลายฟิลด์

http API อัปเดต

  • เพิ่มการจำแนกประเภท API ข้อความ
    • เปลี่ยนการจำแนกประเภท API
      • ที่มีอยู่: Channel API > Announcement Message Sending API
      • เปลี่ยน: Message API > Channel Announcement Message Sending API
    • เพิ่ม API ข้อความประกาศผู้ใช้
    • เพิ่ม API ข้อความที่กำหนดเองของช่อง
    • เพิ่ม API ข้อความที่กำหนดเองของผู้ใช้
    • เพิ่ม API การดึงประวัติข้อความของช่อง
  • เพิ่มรหัสข้อผิดพลาดที่ละเอียด
    • รหัสใหม่ที่เพิ่มสำหรับรหัสสถานะ HTTP 400
      • 400 ขนาดข้อความที่กำหนดเองเกินขนาด ขนาดสูงสุดคือ 8,000 ไบต์.: ขนาดข้อความที่กำหนดเองเกิน (สูงสุด 8,000 ไบต์)
  • ลบ extraData ออกจากค่าการตอบกลับ
    • API การดึงช่อง (response > data > members)
    • API การดึงผู้เข้าร่วมช่อง (response > data > members)
  • เพิ่ม chatHistoryAllowed ความสามารถในการดึงประวัติข้อความ
    • ค่าการตอบกลับสำหรับการดึงรายการช่องทั้งหมด
    • ค่าการตอบกลับสำหรับการดึงช่อง
    • ค่าคำขอสำหรับการสร้างช่อง
    • ค่าการตอบกลับสำหรับการดึงช่องที่ผู้ใช้เข้าร่วม
  • แก้ไขการพิมพ์ผิดและเปลี่ยนคำอธิบาย
    • การดึงรายการช่องทั้งหมด
      • เปลี่ยนคำอธิบายของฟิลด์พารามิเตอร์การค้นหา size
        • ที่มีอยู่: ขั้นต่ำ 10 ~ สูงสุด 100
        • เปลี่ยน: ขั้นต่ำ 1 ~ สูงสุด 10
    • เปลี่ยนประเภทเวลาของ timestampMillis
      • integer → long
    • การเข้าช่อง
      • เปลี่ยนตัวอย่างคำขอ
    • การดึงประวัติข้อความของช่อง
      • เปลี่ยนจุดสิ้นสุด API
      • ลบ Content-Type จากพารามิเตอร์เส้นทาง
    • การสร้างช่อง
      • เปลี่ยนแนวทางในการดำเนินการตามการมีอยู่ของ playerId ในข้อมูลคำขอ
    • การออกจากช่อง
      • เพิ่มคำอธิบายว่าช่องที่ไม่มีผู้เข้าร่วม ซึ่งเจ้าของช่องไม่ใช่ SYSTEM จะถูกลบออกเป็นระยะ
    • การบล็อกผู้ใช้
      • เพิ่มคำอธิบายว่านี่เป็นฟีเจอร์เพื่อจำกัดการส่งและรับข้อความแบบเรียลไทม์
    • ข้อความประกาศช่อง
      • เพิ่มแนวทางในการดำเนินการตามการมีอยู่ของ channelId และ langCode ในข้อมูลคำขอ
    • ปรับปรุงคำอธิบายภาพรวม
    • เปลี่ยนคำ
      • เวลา → วันที่
    • แก้ไขระยะห่างบางส่วน
    • เปลี่ยนการเขียนประเภทอาร์เรย์
      • ตัวอย่าง: array → object array

การเปลี่ยนแปลง API websocket

  • ประเภทแพ็กเกจ
    • เพิ่ม NOTIFY_NOTICE
  • การเชื่อมต่อของลูกค้า
    • เปลี่ยนตัวอย่างคำขอ
  • การเชื่อมต่อใหม่ของลูกค้า
    • เปลี่ยนตัวอย่างคำขอ
  • ข้อความแจ้งเตือน
    • เปลี่ยนชื่อเป็นข้อความแจ้งเตือนผู้ใช้
    • เปลี่ยนข้อมูล Body playerId
  • ข้อความแจ้งเตือนช่อง
    • เปลี่ยนข้อมูล Body channelId
  • เปลี่ยนแพ็กเกจการส่งข้อมูล extraData
    • ลบ extraData ออกจากค่าคำขอ
      • CONNECT
      • RECONNECT
    • เพิ่ม extraData ลงในค่าคำขอ
      • CHANNEL_CHAT
      • DIRECT_CHAT
    • ลบ extraData ออกจากค่าการตอบกลับ
      • NOTIFY_ENTER_CHANNEL
      • NOTIFY_EXIT_CHANNEL
    • เปลี่ยนค่าคีย์การตอบกลับ (fromExtra → extraData)
      • NOTIFY_CHANNEL_CHAT
      • NOTIFY_DIRECT_CHAT
  • เพิ่ม timestampMillis ลงในค่าการตอบกลับ
    • NOTIFY_ENTER_CHANNEL
    • NOTIFY_EXIT_CHANNEL
    • NOTIFY_DELETE_CHANNEL
    • NOTIFY_CHANNEL_NOTICE
    • NOTIFY_CHANNEL_CHAT
    • NOTIFY_DIRECT_CHAT
  • เพิ่ม langCode ลงในค่าคำขอ
    • CONNECT
    • RECONNECT
  • เพิ่มข้อความเหตุการณ์เซิร์ฟเวอร์ Socket
    • NOTIFY_NOTICE
  • ลบแพ็กเกจที่ไม่สนับสนุน
    • NOTIFY_DISCONNECT