RoomScope

最終更新

変更履歴

API の変更点を新しい順に掲載しています。互換性のない変更は新しいバージョンのプレフィックスで提供し、v1 のものはすべて後方互換性を保ちます。

  1. 変更Webhook ヘッダーの名称を変更
    Webhook の配信には x-roomscope-signature、x-roomscope-timestamp、x-roomscope-alert-id、x-roomscope-schema-version が付くようになりました。署名方式とペイロードに変更はありません。検証時は新しいヘッダー名を読み取ってください。
  2. 修正ドキュメントを API の実際の動作に合わせました
    エラー、クレジット、レート制限、認証、Webhook の各ページが、実際の動作を説明するようになりました:実際のエラーコード、X-RateLimit ヘッダーを伴うキーごとのレート制限、クレジットのコストと毎月の付与分、署名付き Webhook の方式。リファレンスにクリエイターのインサイト、ベストな時間帯、配信状況を追加しました。ドキュメント検索(⌘K)が使えるようになりました。
  3. 追加API ドキュメントのテンプレート
    クイックスタート、認証、エラー、レート制限、ランキングのリファレンス、Webhook。残りのリソースのリファレンスページは、OpenAPI ドキュメントから生成でき次第追加します。
  4. 変更エラーエンベロープ
    すべてのエラーが { code, message, requestId, retryable } を返すようになりました。クライアントは code で分岐し、retryable が true のときだけリトライしてください。
  5. 追加ランキング:provenance ブロック
    GET /v1/rankings/official は data と並んで provenance オブジェクト(coverageStatus、observedAt)を返します。
  6. 追加スコープ付き API キー
    キーには明示的なスコープ(rank:read、live:read、creator:read など)が付きます。キーのスコープ外のリクエストは 403 insufficient_scope で失敗します。
このページは役に立ちましたか?