Access Spotify Data in Mule Applications Using the CData JDBC Driver

The CData API Driver for JDBC connects Spotify data to Mule applications enabling read functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Spotify data.

This article demonstrates how to use the CData API Driver for JDBC inside of a Mule project to create a Web interface for Spotify data. The application created allows you to request Spotify data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the hundreds of available data sources.

1. Create a new Mule Project in Anypoint Studio.
2. Add an HTTP Connector to the Message Flow.
3. Configure the address for the HTTP Connector.
4. Add a Database Select Connector to the same flow, after the HTTP Connector.
5. Create a new Connection (or edit an existing one) and configure the properties.
   • Set Connection to "Generic Connection"
   • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.api.jar).
   • Set the URL to the connection string for Spotify

     Using OAuth Authentication

     Spotify uses OAuth 2.0 for authentication. You will need to create an application in the Spotify Developer Dashboard to obtain your client credentials.

     Setting Up Your Spotify Application

     1. Visit the Spotify Developer Dashboard.
     2. Log in with your Spotify account and click Create app.
     3. Provide an app name, description, and set a Redirect URI (e.g.,

        http://localhost:33333

        for desktop applications).
     4. Copy your Client ID and Client Secret from the app settings.

     Connection Properties

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to OAuth.
     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
     • OAuthClientId: Set this to your Spotify application's Client ID.
     • OAuthClientSecret: Set this to your Spotify application's Client Secret.
     • Scope: Set this to the required OAuth scopes (space-separated). The default includes all read scopes needed for the tables in this profile.
     • CallbackURL: Set this to the Redirect URI configured in your Spotify application (e.g., http://localhost:33333).

     Example Connection String

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

     Available OAuth Scopes

     • user-read-private: Read access to user's subscription details and explicit content settings.
     • user-read-email: Read access to user's email address.
     • user-library-read: Read access to a user's saved tracks, albums, episodes, shows, and audiobooks.
     • playlist-read-private: Read access to user's private playlists.
     • playlist-read-collaborative: Read access to collaborative playlists the user follows.
     • user-follow-read: Read access to the list of artists the current user follows.
     • user-read-playback-state: Read access to a user's player state (device, current track, progress).
     • user-read-currently-playing: Read access to a user's currently playing content.
     • user-read-playback-history: Read access to a user's recently played tracks.
     • user-top-read: Read access to a user's top artists and tracks.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Spotify JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     		java -jar cdata.jdbc.api.jar
     		

     Fill in the connection properties and copy the connection string to the clipboard.

   • Set the Driver class name to cdata.jdbc.api.APIDriver.
   • Click Test Connection.
6. Set the SQL Query Text to a SQL query to request Spotify data. For example:

   SELECT ,  FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'

   
7. Add a Transform Message Component to the flow.
8. Set the Output script to the following to convert the payload to JSON:

   %dw 2.0
   output application/json
   ---
   payload
           

   
9. To view your Spotify data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Spotify data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Spotify data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Spotify and see the CData difference in your Mule Applications today.