作品一覧を自分のサイトに出す(API)
sonoTracks に公開した作品の一覧を、ご自身のサイトに出すための公開APIです。 WordPress をお使いの方は配布プラグインをお使いいただくのが簡単です。このページは、ご自分で組み込む方への説明です。
エンドポイント
認証は要りません。公開されている作品の情報だけを返します。
GET https://sono-tracks.com/api/tracks/public/artist-releases?slug=あなたのslugslug は、あなたの公開プロフィール https://sono-tracks.com/u/{slug} の末尾の部分です。
指定できるもの
- slug
- どなたの作品を返すか。必須です。
- limit
- 1回に返す件数。既定は 8、 最大は 24 です。 これを超える値を指定しても最大値に丸めます(エラーにはしません)。
- page
- ページ番号(1から)。応答に
totalとtotalPagesを 含めるので、全件をたどれます。
1回の件数に上限があるのは、作品の多い方で応答が重くなるのを防ぐためです。 全件を出したい場合は、ページ送りでたどってください。
返ってくるもの
作品ごとに、作品名・アーティスト名・ジャンル・曲数・最低価格・ジャケット画像のURL・ 作品ページのURLを返します。試聴や購入に関わる情報は含みません。
呼び出す間隔
応答は10分間キャッシュされます。それより短い間隔で呼んでも、新しい結果は返りません。 作品の更新はそれほど頻繁ではないので、1日に数回ほどで十分です。
キャッシュがあるため、作品を公開した直後に取得しても、 最大10分ほどは反映前の内容が返ることがあります。手動で同期する場合は少し時間をおいてください。
うまくいかないとき
- 503 が返る
- こちら側の障害です。そのとき手元にある前回の結果を残してください。空の一覧で上書きすると、障害の一瞬のために作品が消えたように見えます。
- 空の一覧が返る(200)
- slug が違うか、公開中の作品がまだ無い状態です。障害ではありません。
- ブラウザから直接呼べない
- 意図的にそうしています(CORSを開けていません)。訪問者のブラウザからではなく、サーバー側やビルド時に取得してください。そのほうが表示も速く、こちらへの負荷もかかりません。
お願い
このAPIは予告なく変わることがあります。とはいえ、既にお使いの方がいる形を 黙って壊すことはしません。変更する際はお知らせでご案内します。
ご不明な点はお問い合わせください。 このAPIを使った道具を作られた場合、よろしければお知らせください。 ほかの方にもご案内できるかもしれません。