Access Live PayPal Data in TIBCO Data Virtualization

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the CData TIBCO DV Adapter for PayPal, you get federated access to live PayPal data directly within TIBCO Data Virtualization. This article walks through deploying an adapter and creating a new data source based on PayPal.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live PayPal data. When you issue complex SQL queries to PayPal, the adapter pushes supported SQL operations, like filters and aggregations, directly to PayPal. Its built-in dynamic metadata querying allows you to work with and analyze PayPal data using native data types.

Deploy the PayPal TIBCO DV Adapter

1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name PayPal
   

2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.paypal.jar) to the server from the extract location.

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.paypal.jar
   

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Authenticate with PayPal Using OAuth

Since PayPal authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to PayPal directly from the adapter.

The following code sample shows how to authenticate with PayPal. You will simply need to execute the Java application with the tdv.paypal.jar file in the class path.

PayPalOAuth oauth = new PayPalOAuth();  
oauth.generateOAuthSettingsFile("InitiateOAuth=GETANDREFRESH;" + 
                                  "Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;" + 
                                  "OAuthSettingsLocation=C:\paypal\OAuthSettings.txt;");

Once you deploy the adapter and authenticate, you can create a new data source for PayPal in TDV Studio.

Create a PayPal Data Source in TDV Studio

With the CData TIBCO DV Adapter for PayPal, you can easily create a data source for PayPal and introspect the data source to add resources to TDV.

Create the Data Source

1. Right-click on the folder you wish to add the data source to and select New -> New Data Source.
2. Scroll until you find the adapter (e.g. PayPal) and click Next.
3. Name the data source (e.g. CData PayPal Source).

4. Fill in the required 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.

   NOTE: Set the OAuthSettingsLocation property in the DV Adapter to the same value you used when performing the OAuth authentication (see above).

5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected PayPal tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with PayPal data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.