Ready to get started?

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

Download Now

Access PayPal Data with Entity Framework 6

This article shows how to access PayPal data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

Entity Framework is an object-relational mapping framework that can be used to work with data as objects. While you can run the ADO.NET Entity Data Model wizard in Visual Studio to handle generating the Entity Model, this approach, the model-first approach, can put you at a disadvantage if there are changes in your data source or if you want more control over how the entities operate. In this article you will complete the code-first approach to accessing PayPal data using the CData ADO.NET Provider.

  1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
  2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.
  3. Modify the App.config file in the project to add a reference to the PayPal Entity Framework 6 assembly and the connection string.

    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.

    <configuration> ... <connectionStrings> <add name="PayPalContext" connectionString="Offline=False;Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH" providerName="System.Data.CData.PayPal" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.PayPal" type="System.Data.CData.PayPal.PayPalProviderServices, System.Data.CData.PayPal.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.PayPal.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
  5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
  6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named PayPalContext. The following code example overrides the OnModelCreating method to make the following changes:
    • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
    • Remove requests to the MigrationHistory table.
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class PayPalContext : DbContext { public PayPalContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<PayPalContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the PayPal entity you are retrieving, for example, Transactions. In this file, define both the Entity and the Entity Configuration, which will resemble the example below: using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; [System.ComponentModel.DataAnnotations.Schema.Table("Transactions")] public class Transactions { [System.ComponentModel.DataAnnotations.Key] public System.String Date { get; set; } public System.String GrossAmount { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<Transactions> Transactions { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: PayPalContext context = new PayPalContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Transactions select line;