パブリック REST API キー認証、OpenAPI によるドキュメント化

RESTによる読み取りと書き込み

リリース、トラック、スマートリンク、統計データの読み取り — およびスマートリンクやドラフトリリースの作成・編集 — HTTPS を通じたシンプルな方法。JSON 応答、limit/offset ページネーション、予測可能なスキーマ。配信および提出機能は API に含まれません。

スコープ付き API キー

Bearer トークンまたは X-API-Key ヘッダーに ogr_pk_ キーを指定して認証します。各キーには明示的なスコープ（read:releases、read:smartlinks、read:stats、write:smartlinks、write:releases）が設定されており、ダッシュボード上でいつでもローテーションまたは無効化可能です。

レート制限 + ヘッダー

各応答には X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーが含まれます。制限を超えると 429 エラーが返され、Retry-After が指定されます。無料キーは 1,000 回/日、ビジネスキーは 100,000 回/日まで。

セルフホスト型 OpenAPI 3.0

完全に機械可読な仕様は /api/v1/public/openapi.json にあり、このページ上でインタラクティブなリファレンスとしてレンダリングされます — 第三者ドキュメントホストや外部呼び出しは一切不要。

• GET/api/v1/public/releasesあなたのリリース一覧を取得します。limit と offset によるページネーションに対応。
• GET/api/v1/public/releases/{id}ID で指定した単一のリリースを取得します。
• POST/api/v1/public/releasesドラフトリリースを作成します（write:releases）。KYC およびオンボーディングが必要です。
• PATCH/api/v1/public/releases/{id}ドラフトのメタデータを更新します（write:releases）。提出前のドラフトのみ対象。
• DELETE/api/v1/public/releases/{id}ドラフトリリースを削除します（write:releases）

• GET/api/v1/public/tracks?release_id={id}あなたが所有するリリースのトラック
• GET/api/v1/public/tracks/{id}ID で指定された単一のトラックを取得。

• GET/api/v1/public/smartlinksあなたのスマートリンク一覧を表示。
• POST/api/v1/public/smartlinks自分のリリース用にスマートリンクを作成する（write:smartlinks）。
• PATCH/api/v1/public/smartlinks/{id}自分のスマートリンクを更新する（write:smartlinks）。
• DELETE/api/v1/public/smartlinks/{id}スマートリンクを無効化する（write:smartlinks）。

• GET/api/v1/public/stats/release/{id}各 DSP および国ごとのストリーミング回数、リスナー数、保存数。range は 7d、14d、30d、90d、1y、または ytd のいずれか。
• GET/api/v1/public/openapi.jsonOpenAPI 3.0 ドキュメント。パブリックでキャッシュ可能。キーは不要。

• GET/api/v1/public/artistsあなたのロスターに登録されたアーティスト一覧を表示（read:artists）。
• GET/api/v1/public/earnings/balanceUSDウォレット残高のスナップショット（read:earnings）。

新規キーの標準設定。ダッシュボード、Cron同期、プロトタイピングに適しています。

本番環境の統合向けに高い日次制限。要相談。