JDBC Driver for PayPal

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for PayPal consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example: 
    cdata.jdbc.paypal.PayPalDriver
  • Provide the JDBC URL. For example: 
    jdbc:paypal:Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

or

jdbc:cdata:paypal:Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:paypal:" or "jdbc:cdata:paypal:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to PayPal

The provider surfaces tables from two PayPal APIs. Each API uses a different authentication method.
  • The SOAP API requires Signature API credentials. To authenticate to the SOAP API, you must set the AuthScheme to Basic, and set the Username, Password, and Signature properties. These API credentials are generated when you enable the SOAP API.
  • The REST API uses the OAuth authentication standard. To authenticate to the REST API, you must set the AuthScheme to OAuth, and set the OAuthClientId, and OAuthClientSecret properties.

To specify your preferred API, set the Schema property to either REST or SOAP. If no Schema is set, PayPal uses the SOAP schema.

For testing purposes, set UseSandbox to true and use Sandbox credentials.

SOAP API

You can use the SOAP API to retrieve all transactions for the current account. The SOAP API uses the Signature API-credentials type, which has three credential values:

  • API Username
  • API Password
  • API Signature

To generate the API credentials:

  1. Log in to your PayPal business account and select Profile > My Selling Tools.
  2. In the Selling Online section, click Update for the API Access item.
  3. To generate the API signature, click Request API Credentials on the API Access page.
  4. Select Request API Signature and click Agree and Submit to generate the API signature.

After setting the following connection properties, you are ready to connect:

  • User = the API Username.
  • Password = the API Password.
  • Signature = the Signature.
  • UseSandbox = true if you are using sandbox credentials.

REST API

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth = GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
  • OAuthClientId = the Client Id in your app settings.
  • OAuthClientSecret = the Client Secret in your app settings.
  • UseSandbox = true if you are using sandbox credentials.

When you connect, the driver completes the OAuth process.

  1. Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
PayPal supports only OAuth authentication for use with the REST API. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to PayPal from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in PayPal, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId = the client Id assigned when you registered your application.
  • OAuthClientSecret = the client secret that was assigned when you registered your application.
  • CallbackURL = the redirect URI that was defined when you registered your application.

When you connect, the driver opens PayPal's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the driver then completes the OAuth process:

  1. The driver obtains an access token from PayPal and uses it to request data.
  2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the driver refreshes it automatically.

Web Applications

Authenticating via the Web requires you to create and register a custom OAuth application with PayPal, as described in Creating a Custom OAuth Application. You can then use the driver to get and manage the OAuth token values.

This section describes how to get the OAuth access token, how to have the driver refresh the OAuth access token automatically, and how to refresh the OAuth access token manually.

Get the OAuth access token:

  1. Set the following connection properties to obtain the OAuthAccessToken:
    • OAuthClientId = the client Id in your application settings.
    • OAuthClientSecret = the client secret in your application settings.

  2. Complete the OAuth exchange:
    • Log in and authorize the web application. You are redirected back to the callback URL.
    • Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic refresh of the OAuth access token:

To have the driver automatically refresh the OAuth access token, do the following:

  1. Before connecting to data for the first time, set the following connection parameters:
    • InitiateOAuth = REFRESH.
    • OAuthClientId = the client Id in your application settings.
    • OAuthClientSecret = the client secret in your application settings.
    • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation = the path where you want the driver to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set the following:
    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set the following connection properties:

    • OAuthClientId = the Client Id in your application settings.
    • OAuthClientSecret = the Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this by installing the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

  • InitiateOAuth = REFRESH
  • OAuthSettingsLocation = the path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.
  • OAuthClientId = the client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret = the client secret assigned when you registered your custom OAuth application.

When you are finished, configure the driver to automatically refresh the access token on the headless machine.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839