Access PayPal Data in Mule Applications Using the CData JDBC Driver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

PayPal JDBC Driver

Easy-to-use PayPal client enables Java-based applications to easily consume PayPal Transactions, Orders, Sales, Invoices, etc.



Create a simple Mule Application that uses HTTP and SQL with the CData JDBC Driver for PayPal to create a JSON endpoint for PayPal data.

The CData JDBC Driver for PayPal connects PayPal data to Mule applications enabling read functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze PayPal data.

This article demonstrates how to use the CData JDBC Driver for PayPal inside of a Mule project to create a Web interface for PayPal data. The application created allows you to request PayPal data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a Database Select Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties.
    • Set Connection to "Generic Connection"
    • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.paypal.jar).
    • Set the URL to the connection string for PayPal

      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.

    • Set the Driver class name to cdata.jdbc.paypal.PayPalDriver.
    • Click Test Connection.
  6. Set the SQL Query Text to a SQL query to request PayPal data. For example: SELECT Date, GrossAmount FROM Transactions
  7. Add a Transform Message Component to the flow.
  8. Set the Output script to the following to convert the payload to JSON:
    %dw 2.0
    output application/json
    ---
    payload
            
  9. To view your PayPal data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The PayPal data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with PayPal data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for PayPal and see the CData difference in your Mule Applications today.