VOOZH about

URL: https://www.cdata.com/kb/tech/spotify-odata-infragistics-reveal.rst

⇱ Analyze Spotify Data in Infragistics Reveal


Analyze Spotify Data in Infragistics Reveal

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Server to create an OData API on top of Spotify data and visualize live Spotify data in Infragistics Reveal.

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Spotify data. The CData API Server generates an OData API for Spotify, which is natively consumable in Reveal. In this article, we walk through connecting to Spotify in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Spotify from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open API Server and click Settings -> Connection -> Add Connection πŸ‘ Adding a connection
  2. Select "Spotify" πŸ‘ Selecting a Connector (Salesforce is shown).
  3. Enter the necessary authentication properties to connect to 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.
    πŸ‘ Configuring a connection (Salesforce is shown).

Add Spotify Resource Definitions in API Server

After connecting to Spotify, create Resources, which represent API endpoints for Spotify data.

  1. Click Settings -> Resources -> Add Resource πŸ‘ Adding a new resource
  2. Select the Spotify connection πŸ‘ Selecting a connection (Salesforce is shown)
  3. Select the table you wish to retrieve and click Next πŸ‘ Selecting a Table (Salesforce is shown)
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

Add an API Server User

Create a User to connect to Spotify from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the Spotify Connection and Resource(s) πŸ‘ Creating a new user
πŸ‘ API Server users

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

πŸ‘ Configuring CORS settings

Create a Dashboard in Reveal

With the API Server configured, we can visualize Spotify data in Reveal.

  1. Log into Reveal and click Dashboards -> New πŸ‘ Adding a new dashboard
  2. Click Data Source -> OData Feed πŸ‘ Adding a new OData data source
  3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc πŸ‘ Configuring the OData URL
  4. Select Generic Credentials and specify the API Server username and authentication token πŸ‘ Configuring the credentials
  5. Select the entity you wish to visualize πŸ‘ Selecting an entity to visualize (Salesforce is shown.)
  6. Select fields and choose a chart type πŸ‘ Visualizing data in Reveal (Salesforce is shown.)

More Information & Free Trial

At this point, you have created a simple dashboard from live Spotify data. For more information on creating OData feeds from Spotify (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Spotify data in tools that consume OData APIs.