Muro Box、オープンAPIを正式サポート
APIキー認証により、Home AssistantやIFTTT、または自作のカスタムスクリプトといったサードパーティのサービスや自動化ツールが、オルゴールを直接制御できます。具体的には、曲やプレイリストの再生、再生の停止、デバイス設定の調整、曲とプレイリストのカタログ検索などが可能です。
すべての再生はオルゴール本体で行われます。APIはMIDIファイルやダウンロードリンクを返さないため、音楽コンテンツの著作権保護と完全性が保証されています。
APIでできること
- 1曲を再生する (
play_song) - プレイリストを再生します。システムはアカウント権限に基づき、再生可能な曲を自動的にフィルタリングします(
play_playlist) - 現在の再生を停止します (
stop_playing) - デバイス設定の読み取りと更新：モーター速度、シャッフルモード、最大再生時間、MIDI出力、Bluetooth MIDIトグル（
device_settings） - キーワード、ページネーション、多言語名サポートを利用した曲とプレイリストの検索 (
search/songs,search/packages)
3ステップで始める
- Muro Boxアプリを開き、設定→APIキー→追加を選択します。キーに名前を付け、確認してください。完全なキーは一度だけ表示されるため、すぐにコピーして保存してください（後から再取得することはできません）。
- アプリのデバイス設定ページで、デバイスのシリアル番号（
device_sn）をご確認いただけます。 - 「APIを呼び出す：ヘッダーにAPIキーを指定し、
https://api.murobox.com/muro_api/v1/...にPOSTリクエストを送信してください。」
curl -X POST https://api.murobox.com/muro_api/v1/devices/play_song/
-H "api-key: YOUR_API_KEY"
-H "Content-Type: application/json"
-d '{"device_sn": "YOUR_DEVICE_SN", "song_id": "SONG_ID"}'
曲ID（song_id）とプレイリストID（playlist_id）は、アプリ内で直接コピーできます。具体的には、プレイヤーメニューの「曲IDをコピー」、またはプレイリスト詳細ページの「プレイリストIDをコピー」をご利用いただけます。
セキュリティおよび利用上の注意
- APIキーはパスワードと同等です。サーバーにはSHA‑256フィンガープリントのみが保存され、元のキーを復元することはできません。共有しないでください。
- 各キーは毎分最大60リクエストを許可します（これを超えるとHTTP 429が返されます）。
- キーは、同じアカウントに紐付けられたオルゴールのみを制御できます。曲やMIDIファイルのダウンロードには使用できません。
- 完全なエンドポイントのドキュメントおよびインポート可能なPostmanコレクションについては、Muro Box Open API ユーザーガイドをご参照いただけます。
