- 閲覧
- アカウント不要
- 形式
- サンプル付きの REST リファレンス
- サンドボックスキー
- 承認済みアカウントで
まずはリクエストから
API を理解する最短の方法は、実際に呼び出すことです。最初の1時間に適した4つのリクエストをご用意しました。キーが使えるかの確認、既存データの一覧、リリースの作成、イベントの購読です。
- 各エンドポイントに、リクエストとレスポンスを掲載
- エラーは原因と対処法とともに一覧で掲載
- サンプルは、記載どおりにサンドボックスで実行できます
最初のリクエスト
リクエスト例GET/v1/me
レスポンス
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}リソース別のリファレンス
- リリース
- リリースの作成、更新、申請、配信停止を、テリトリーや日付とともに行います。
- トラックとアセット
- トラックを追加し、音源とアートワークをアップロードして、クレジット、コード、分配率を設定します。
- 配信
- リリースをストアに送信し、各配信先を待機中から公開済みまたは拒否まで追跡します。
- アナリティクス
- ストリームとダウンロードを、ストア、テリトリー、リリース、トラック、日ごとに取得します。
- ロイヤリティ
- 明細の一覧と各行の取得、各受取人への未払い額の確認ができます。
- Webhook
- エンドポイントを登録し、受信するイベントを選び、送信された内容を確認します。
サンドボックスで試すクイックスタート
- 1
サンドボックスキーを作成
アカウントを申請し、承認されたらそこからキーをコピーしてください。
- 2
最初のリクエストを送信
Authorization ヘッダーにキーを付けて /v1/me を呼び出し、動作を確認します。
- 3
テストリリースを作成
タイトルとアーティストを指定してリリースを送信し、トラックを追加します。
- 4
配信をシミュレート
サンドボックスで配信し、ストアを介さずにステータスが変化する様子を確認します。
ヘッダー1つで、すぐに利用開始
認証は、ベアラートークンとして送る API キーだけです。ハンドシェイクも、維持すべきセッションもありません。これをコピーしてキーを差し替え、実行してください。
- サンドボックスと本番では、別のキーを使います
- キーはいつでも無効にできます
リリースを一覧表示
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"ドキュメントについてのよくある質問
いいえ。リファレンスは公開されています。アカウントが必要なのは、キーが欲しいときだけです。
エンドポイントとレスポンスは同じです。サンドボックスの配信はストアに届く手前で止まり、サンドボックスのデータは本番のカタログとは別に保管されます。
追加された内容は、変更履歴に記載されます。互換性のない変更は、パスの新しいバージョンで公開されるため、開発に使ったバージョンはそのまま変わりません。