Connect to PayPal Data in Aqua Data Studio

The CData JDBC Driver for PayPal integrates PayPal data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to PayPal data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The PayPal data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, PayPal.
   • Driver Location: Click the Browse button and select the cdata.jdbc.paypal.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.paypal.PayPalDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:paypal: and is followed by a semicolon-separated list of connection 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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the PayPal JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.paypal.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is below:
     jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH

Query PayPal Data

You can now query the tables exposed.