Build MVC Applications with Connectivity to Spotify Data

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for Spotify into a basic MVC (Model, View, Controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

1. Create a new MVC project in Visual Studio. In this example, the project name is MvcAPIApp.

2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the Spotify Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

   Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.
3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is APIModel.
4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
5. Click New Connection. Select CData Spotify Data Source in the dialog that is displayed.

6. Specify the required connection string 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.

   A typical connection string is below:

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

   

7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as APIEntities.

   
8. Select the views you need. In this example, Albums is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
9. Build your project to complete this step.

Scaffold the Controller and Views

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both the controller and the views.

1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
2. In the Add Controller dialog that is then displayed, select the following options:
   • Model class: Select a table you imported; for example, Albums.
   • Data context class: Select your context class.
3. Leave the default values for the other fields.

You can now access the list of Albums records at http://MySite/Albums. With every state change the site picks up any data changes.