Monaca アプリで使えるSpotify のデータ連携用のバックエンドAPI をノーコードで開発

宮本航太
宮本航太
プロダクトスペシャリスト
ハイブリッドアプリ開発プラットフォームMonaca から Spotify のデータに接続するためのバックエンドAPI Server をCData API Server で構築



CData API Server を使って、Monaca ハイブリッドアプリ開発プラットフォーム(https://ja.monaca.io/) から Spotify に接続してデータを取得する方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSpotify OData サービスを作成していきましょう。

Spotify への接続

Monaca からSpotify のデータを操作するには、まずSpotify への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Spotify」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Spotify への接続設定を行っていきましょう！ 接続設定

  5. OAuth 認証の設定

    Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

    Spotify アプリケーションのセットアップ

    1. Spotify Developer Dashboard にアクセスします。
    2. Spotify アカウントでログインして Create app をクリックします。
    3. アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は 
      http://localhost:33333
      など）。
    4. アプリ設定から Client ID と Client Secret をコピーします。

    接続プロパティ

    以下の接続プロパティを設定して接続を確立してください：

    • AuthScheme：OAuth に設定します。
    • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId：Spotify アプリケーションの Client ID に設定します。
    • OAuthClientSecret：Spotify アプリケーションの Client Secret に設定します。
    • Scope：必要な OAuth スコープ（スペース区切り）に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
    • CallbackURL：Spotify アプリケーションで設定したリダイレクト URI に設定します（例：http://localhost:33333）。

    接続文字列の例

    Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;

    利用可能な OAuth スコープ

    • user-read-private：ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
    • user-read-email：ユーザーのメールアドレスへの読み取りアクセス。
    • user-library-read：ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
    • playlist-read-private：ユーザーの非公開プレイリストへの読み取りアクセス。
    • playlist-read-collaborative：ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
    • user-follow-read：現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
    • user-read-playback-state：ユーザーのプレーヤー状態（デバイス、現在のトラック、再生位置）への読み取りアクセス。
    • user-read-currently-playing：ユーザーが現在再生中のコンテンツへの読み取りアクセス。
    • user-read-playback-history：ユーザーが最近再生したトラックへの読み取りアクセス。
    • user-top-read：ユーザーのトップアーティストとトラックへの読み取りアクセス。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

OAuth 認証の設定

Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

Spotify アプリケーションのセットアップ

  1. Spotify Developer Dashboard にアクセスします。
  2. Spotify アカウントでログインして Create app をクリックします。
  3. アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は 
    http://localhost:33333
    など）。
  4. アプリ設定から Client ID と Client Secret をコピーします。

接続プロパティ

以下の接続プロパティを設定して接続を確立してください：

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：Spotify アプリケーションの Client ID に設定します。
  • OAuthClientSecret：Spotify アプリケーションの Client Secret に設定します。
  • Scope：必要な OAuth スコープ（スペース区切り）に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
  • CallbackURL：Spotify アプリケーションで設定したリダイレクト URI に設定します（例：http://localhost:33333）。

接続文字列の例

Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;

利用可能な OAuth スコープ

  • user-read-private：ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
  • user-read-email：ユーザーのメールアドレスへの読み取りアクセス。
  • user-library-read：ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
  • playlist-read-private：ユーザーの非公開プレイリストへの読み取りアクセス。
  • playlist-read-collaborative：ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
  • user-follow-read：現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
  • user-read-playback-state：ユーザーのプレーヤー状態（デバイス、現在のトラック、再生位置）への読み取りアクセス。
  • user-read-currently-playing：ユーザーが現在再生中のコンテンツへの読み取りアクセス。
  • user-read-playback-history：ユーザーが最近再生したトラックへの読み取りアクセス。
  • user-top-read：ユーザーのトップアーティストとトラックへの読み取りアクセス。

API Server のユーザー設定

次に、API Server 経由でSpotify にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Spotify 用のAPI エンドポイントの作成

ユーザーを作成したら、Spotify のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でSpotify への接続を設定してユーザーを作成し、API Server でSpotify データのAPI を追加しました。これで、OData 形式のSpotify データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。

Monaca で作成したモバイルアプリでの Spotify のデータ取得

Monacaではクラウド上にあるIDEが用意されていますので、まずはアカウント作成します。そこからCData API Server のデータをMonaca アプリ使う設定を作成していきます。

  1. ブラウザより Monaca のダッシュボードを開き、「新しいプロジェクトを作る」をクリックします。
    2. Monaca
  2. まずはテンプレートの種類は、フレームワークテンプレートを選択します。
    3. Monaca
  3. 今回は JavaScript を選択します。
    4. Monaca
  4. テンプレートは「Onsen UI V2 JS Navigation」を選択します。テンプレの画面構成は、「Push page」ボタンをクリックすると、画面遷移するものとなっています。
    5. Monaca
  5. 任意のプロジェクト名を設定し、「作成」ボタンをクリックします。
    6. Monaca
  6. 作成したプロジェクトを選択した状態で、「クラウドIDEで開く」をクリックします。
    7. Monaca
  7. 検索ボタンがクリックされたら、先ほど作成した API を Ajax で呼び出すようにしています。
    Monaca
    API Server で作成したエンドポイントをURL に設定し、ヘッダーにAPI Server のアクセストークンを設定します。
    Monaca
  8. レスポンスが返ってきた後、処理が成功していればリストにname だけを1データずつ加えています。

デバッグ実行してみる

Monaca でデバッグを行う際は、Monacaデバッガーアプリを実機にインストールすることで、MonacaのクラウドIDE と実機で動かしているMonacaデバッガーアプリが連動するようです。そのため、いちいちコードを修正してからのビルドが不要になるため、素早く検証を行うことができます。

また、Monaca Localkit を使うことで、ローカルの開発環境でも利用することができます。今回はこのLocalkit を使って vscode 上でコードを修正し、アプリ内容を確認していきました。

Monaca Localkit を起動し、プレビューを押すとすぐにアプリ画面が表示されます。

Monaca

初期画面→検索→画面遷移まで確認することができました。

Monaca

このように Spotify 内のデータをMonaca アプリで利用することができるようになります。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事