Ready to get started?

Learn more about the CData ADO.NET Provider for PayPal or download a free trial:

Download Now

Build MVC Applications with Connectivity to PayPal Data

This article shows how to use only the Entity Framework and the CData ADO.NET provider to access PayPal from an ASP.NET MVC application.

This article shows how to use wizards in Visual Studio to drop the CData ADO.NET Provider for PayPal into a simple 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 MvcPayPalApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the PayPal 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 PayPalModel.
  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 PayPal Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

    • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
    • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

    See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

    To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

    For testing purposes you can set UseSandbox to true and use sandbox credentials.

    A typical connection string is below:

    Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
  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 PayPalEntities.

  8. Select the views you need. In this example, Transactions 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

After creating the model and building the project, you can use ASP.NET Scaffolding wizards to create 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, Transactions.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

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