This connector is currently in beta and subject to change.
The Sisense PayPal connector is a standalone connector that allows you to import data from PayPal’s API into the ElastiCube Manager. After you have downloaded and installed the connector, you can connect through a connection string you provide Sisense in the ElastiCube Manager. The connection string is used to authenticate users who connect to PayPal’s API. To obtain a connection string, you will need to retrieve an API Key from PayPal or register a PayPal app.
Once you have connected to PayPal, you can import a variety of tables from the PayPal API.
This page describes how to install the PayPal connector, how to connect to
PayPal with a connection string, and what tables you can import into the ElastiCube Manager:
- Installing the PayPal Connector
- Connecting to the PayPal REST API
- Adding PayPal Tables to your ElastiCube
- PayPal Tables
Sisense provides the PayPal connector as a standalone connector that you can download and add to your list of default Sisense connectors.
To install the PayPal connector:
- Contact us for the PayPal installation file.
- Open the installation file and click Install.
- After the installation process is complete, click Close.
The PayPal connector is displayed in the ElastiCube Manager under Add Data > Web Services.
There are two authentication methods available for connecting to PayPal, through an API Key or through OAuth. Both methods expose the same data, the difference is in what information is required by PayPal to authenticate your account. For the API Key, all you need is a key provided my PayPal in your account. For Oauth, you need to register an app with PayPal, and then pass those details to Sisense.
After you have the relevant information from PayPal, you create a connection string and connect to PayPal.
To access PayPal’s REST API from Sisense, you must provide valid Oauth PayPal credentials. These credentials are provided by PayPal when you create an application.
Creating an App
You can follow the procedure below to register an app and obtain the OAuth client credentials, the Client Id and Client Secret:
- Log in to your PayPal developer account and click the Dashboard tab.
- On the REST API apps section, click Create App.
- Enter the App Name.
- From the drop down list, select the sandbox account that will be used to get data from.
PayPal generates a set of sandbox and live OAuth keys for the application. The sandbox credentials are shown after creating the app. For the live credentials, select the Live option. The sandbox credentials will be used to get data only for the sandbox account selected when creating the App, while the Live credentials will be used to get data only for the developer account used to create this app.
Authenticating through PayPal
After setting the following connection properties, you are ready to connect:
- OAuthClientId: Set this to the consumer key in your app settings.
- OAuthClientSecret: Set this to the consumer secret in your app settings.
- CallbackURL: Set this to the callback URL you specified in your app settings.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken and OAuthAccessTokenSecret.
- UseSandbox: Set this to true if you are using sandbox credentials.
When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Refreshes the access token when it expires.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
After you have retrieve your API Key or OAuth credentials from PayPal, you provide the relevant information in a connection string. Sisense uses connection strings to connect to PayPal and import data into the ElastiCube Manager. Each connection string contains a authentication parameters that the data source uses to verify your identity and what information you can export to Sisense. To learn more, see Connection String Parameters.
For API Keys, the connection string to PayPal is in the following format:
For OAuth, the connection string to PayPal is in the following format:
To add PayPal data:
- In ElastiCube Manager, click Add Data and then, PayPal. The Connect to PayPal window is displayed.
- In Datasource Connection String, enter your connection string.
- Click Connect to Server. PayPal is displayed in the Select Database list.
- Click OK. Sisense connects to PayPal and displays a list of tables available for you to import.
- Select the relevant tables and click Add. The tables are displayed in the ElastiCube Manager.
The Sisense PayPal connector allows you to import the following tables into the ElastiCube Manager.
|AuthorizationDetails||Query details about Authorizations.|
|CaptureDetails||Query details about a captured Payment.|
|CreditCardDetails||Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.|
|Invoices||Query Invoices in PayPal.|
|Notifications||Query the list of event types that are subscribed to a Webhook.|
|OrderDetails||Query details about an Order in PayPal.|
|Payments||Query details about Payments|
|PaymentTransactions||Query Transaction details including the amount and item details.|
|RefundDetails||Query details about a specific Refund.|
|Refunds||Query the available refunds in Stripe.|
|SaleDetails||Query details about a Sale Transaction.|
|Webhooks||Query the list of Webhooks.|
Hey! Was this article helpful?
Questions? Ask the community.