RoomScope

最後更新

更新紀錄

API 的變更，由新到舊排列。破壞性變更會以新的版本前綴發布；v1 上的一切都維持向下相容。

  1. 變更Webhook 標頭更名
    Webhook 推送現在改為攜帶 x-roomscope-signature、x-roomscope-timestamp、x-roomscope-alert-id 與 x-roomscope-schema-version。簽章機制與 Payload 維持不變；驗證時請讀取新的標頭名稱。
  2. 修正文件與 API 一致
    錯誤、點數、速率限制、身分驗證與 Webhook 頁面現在描述的是實際運作方式：真實的錯誤碼、以 X-RateLimit 標頭呈現的每金鑰速率限制、點數費用與每月點數額度，以及 Webhook 簽章機制。API 參考新增了創作者洞察、最佳開播時間與上線狀態。文件搜尋已啟用（⌘K）。
  3. 新增API 文件範本
    快速開始、身分驗證、錯誤、速率限制、排行榜 API 參考與 Webhook。其餘資源的參考頁面，將在由 OpenAPI 文件產生後陸續推出。
  4. 變更錯誤格式
    所有錯誤現在都回傳 { code, message, requestId, retryable }。用戶端應依 code 分支處理，並且只在 retryable 為 true 時重試。
  5. 新增排行榜：資料來源區塊
    GET /v1/rankings/official 會在 data 旁回傳 provenance 物件（coverageStatus、observedAt）。
  6. 新增具權限範圍的 API 金鑰
    金鑰帶有明確的權限範圍（rank:read、live:read、creator:read 等）。超出金鑰權限範圍的請求會以 403 insufficient_scope 失敗。
這個頁面對你有幫助嗎？