自社プロダクトからディストリビューションを運用
Engine は Aevora の API です。お客様がすでに使っているプロダクトから、REST でリリースの作成、ストアへの配信、アナリティクスの取得、ロイヤリティの処理が行えます。ドキュメントは公開されており、開発用のサンドボックスもあります。
- インターフェース
- REST と JSON
- 認証
- API キー(環境ごとに1セット)
- サンドボックス
- ストアを介さないテスト配信
4つの呼び出しで、下書きから明細まで
API は、ダッシュボードでリリースがたどる流れと同じ順序で動きます。作成し、配信し、届いた数字を読み、最後に明細を読みます。呼び出しを選ぶと、送信する内容と返ってくる内容を確認できます。
- リクエストとレスポンスは JSON
- エラーには、失敗したフィールドとその理由が示されます
- サンドボックスと本番で同じ呼び出しが使えます
Engine API
リクエスト例POST/v1/releases
リクエストボディ
{ "title": "Night Drive", "artist": "Mira Kaya", "label": "Northfield Audio", "release_date": "2027-03-12"}レスポンス
{ "id": "rel_8f2k1", "status": "draft", "upc": null}エンドポイントを支える機能
インテグレーションで呼び出し自体は、ほんの一部です。誰も見ていなくても動き続けるためには、次の機能が欠かせません。
- Webhook
- 配信の状態が変わったとき、リリースが公開されたとき、明細の準備ができたときにイベントを受信できるため、ポーリングは不要です。
- 冪等性キー
- 書き込みリクエストにキーを付けて送ると、再試行しても2つ目のリリースは作成されず、最初の結果が返ります。
- ページネーション
- 一覧はカーソルを返します。それを渡すと次のページを取得でき、順序は常に同じです。
- サンドボックス
- 専用のキーを持つ、独立した環境です。配信は最初から最後まで実行され、ストアに届く手前で止まります。
- バージョン管理
- バージョンはパスに含まれます。互換性のない変更は新しいバージョンで提供されるため、開発に使っているバージョンは変わりません。
- レート制限
- 各レスポンスに利用枠の残りが示され、制限されたリクエストには再試行までの目安が返されます。
最初のキーから本番配信まで
- 1
キーを取得
アカウントを申請します。承認されたら、サンドボックスキーを作成してください。
- 2
サンドボックスで開発
インテグレーションがすべての状態に対応できるまで、リリースの作成とテスト配信を繰り返します。
- 3
本番アクセスを申請
開発内容をお知らせください。審査のうえ、本番キーを発行します。
- 4
配信
本番キーに切り替えるだけで、同じ呼び出しが実際のストアに届きます。
Engine についてのよくある質問
いいえ。リファレンスは公開されています。キーが必要になったときにのみ、申請制で開設するアカウントが必要です。
はい。API で作成したリリースはダッシュボードに表示され、ダッシュボードで作成したリリースは API で取得・配信できます。
配信は本番と同じ状態を経て、同じ Webhook を送信しますが、ストアには何も送られません。