Integrate with Spotify Data in JReport Designer

The CData JDBC Driver for Spotify data enables access to live data from dashboards and reports as if Spotify were a relational database, allowing you to query Spotify data using familiar SQL queries. This article shows how to connect to Spotify data as a JDBC data source and create reports based on Spotify data in JReport Designer.

Connect to Spotify Data

1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Spotify 2016\lib\cdata.jdbc.api.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Spotify), select JDBC, and click OK.
4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
   • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:

     cdata.jdbc.api.APIDriver

   • URL: Enter the JDBC URL. This starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     Below is a typical JDBC URL:

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

   • User: The username to authenticate with; typically left blank.
   • Password: The password to authenticate with; typically left blank.
   

5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

   

   Click Done once the dialog has completed loading the tables.

6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Spotify), right-click on Queries, and select Add Query.
7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:

   SELECT ,  FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'
   

   

   With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Spotify data to a new or existing report.

   NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Spotify Data to a Report

You are now ready to create a report with Spotify data.

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).

3. Assign a Category and Value for the chart from the columns in your Query and click Finish.

4. Click the View tab for your report to see the chart.