RoomScope

อัปเดตล่าสุด

บันทึกการเปลี่ยนแปลง

สิ่งที่เปลี่ยนแปลงใน API เรียงจากใหม่ไปเก่า การเปลี่ยนแปลงที่ทำให้เข้ากันไม่ได้จะออกภายใต้คำนำหน้าเวอร์ชันใหม่ ทุกอย่างบน v1 จะยังเข้ากันได้กับเวอร์ชันก่อนหน้าเสมอ

  1. เปลี่ยนแปลงเปลี่ยนชื่อ header ของ webhook
    การส่ง webhook มี header x-roomscope-signature, x-roomscope-timestamp, x-roomscope-alert-id และ x-roomscope-schema-version แล้ว รูปแบบการลงลายเซ็นและ payload ไม่เปลี่ยนแปลง ให้อ่านชื่อ header ใหม่เมื่อตรวจสอบลายเซ็น
  2. แก้ไขเอกสารตรงกับ API
    หน้าข้อผิดพลาด เครดิต ขีดจำกัดอัตราการเรียก การยืนยันตัวตน และ Webhook อธิบายพฤติกรรมจริงแล้ว ได้แก่ รหัสข้อผิดพลาดจริง ขีดจำกัดอัตราการเรียกต่อคีย์พร้อม header X-RateLimit ค่าเครดิตและโควตารายเดือน และรูปแบบการลงลายเซ็นของ webhook เอกสารอ้างอิงเพิ่มข้อมูลเชิงลึกของครีเอเตอร์ ช่วงเวลาที่ดีที่สุด และสถานะการไลฟ์รายชั่วโมง เปิดใช้การค้นหาในเอกสารแล้ว (⌘K)
  3. เพิ่มเทมเพลตเอกสาร API
    เริ่มต้นใช้งาน การยืนยันตัวตน ข้อผิดพลาด ขีดจำกัดอัตราการเรียก เอกสารอ้างอิง Rankings และ Webhook หน้าเอกสารอ้างอิงของทรัพยากรที่เหลือจะตามมาเมื่อสร้างจากเอกสาร OpenAPI แล้ว
  4. เปลี่ยนแปลงโครงสร้างข้อผิดพลาด
    ทุกข้อผิดพลาดส่งกลับเป็น { code, message, requestId, retryable } แล้ว ไคลเอนต์ควรแยกกรณีด้วย code และลองใหม่เฉพาะเมื่อ retryable เป็น true
  5. เพิ่มRankings: บล็อก provenance
    GET /v1/rankings/official ส่งคืนออบเจกต์ provenance (coverageStatus, observedAt) คู่กับ data
  6. เพิ่มAPI key แบบกำหนดสโคป
    คีย์มีสโคปที่ระบุชัดเจน (rank:read, live:read, creator:read, …) คำขอที่อยู่นอกสโคปของคีย์จะล้มเหลวด้วย 403 insufficient_scope
หน้านี้มีประโยชน์หรือไม่