The Sisense Stripe connector is a standalone connector that allows you to import data from Stripe’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 the Stripe APIs. To obtain a connection string, you will need to create a Stripe app.
Once you have connected to Stripe, you can import a variety of tables from the Stripe API.
This page describes how to install the Stripe connector, how to connect to Stripe with a connection string, and what tables you can import into the ElastiCube Manager:
- Installing the Stripe Connector
- Connecting to the Stripe REST API
- Adding Stripe Tables to your ElastiCube
- Stripe Tables
Sisense provides the Stripe connector as a standalone connector that you can download and add to your list of default Sisense connectors.
To install the Stripe connector:
- Download the Stripe installation file.
- Open the installation file and click Install.
- After the installation process is complete, click Close.
The Stripe connector is displayed in the ElastiCube Manager under Add Data > Web Services.
To access Stripe’s REST API from the ElastiCube Manager, you must provide valid Oauth Stripe credentials through a connection string. These credentials are provided by Stripe when you create an application.
After you receive your credentials from Stripe, you can create the connection string and provide Sisense with it to connect to your data.
Registering an App
Follow the steps below to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:
- Log into your Stripe dashboard and click Your Account > Account Settings > Connect > Platform Settings.
- Enter a name, description, and other information to be displayed to users when they log in to grant permissions to your app.
- If you are making a desktop application, set the Redirect URL to http://localhost:33333 or a different port number of your choice.
If you are making a Web application, set the Redirect URL to a page on your Web app you would like the user to be returned to after they have authorized your application.
Authenticating through Stripe
After setting the following properties, you are ready to connect:
- OAuthClientId: Set this to the client Id in the Connect section of your account settings.
- OAuthClientSecret: Set this to a secret key in the API Keys section of your account settings.
- CallbackURL: Set this to the Redirect URL in the Connect section of your account settings.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver 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.
Sisense uses connection strings to connect to Stripe and import data into the ElastiCube Manager.
The connection string to connect to Stripe has the following structure:
The following is an example of a Stripe connection string:
Note: To switch between accounts, you need to delete the file OAuthsettings.txt file located at …\Users\xxx\AppData\Roaming\CData\Stripe Data Provider.
To add Stripe data:
- In ElastiCube Manager, click Add Data and then, Stripe. The Connect to Stripe window is displayed.
- In Datasource Connection String, enter your connection string.
- Click Connect to Server. Stripe is displayed in the Select Database list.
- Click OK. Sisense connects to Stripe 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.
Switching between Accounts
When you connect to the Stripe data source, Sisense saves your OAuth values in the file OAuthsettings.txt file located at …\Users\xxx\AppData\Roaming\CData\Stripe Data Provider on your Sisense server. To connect to the Stripe data source with another user on the same machine, you must delete the OAuthsettings.txt file. Sisense will then generate a new file for that user.
Another option to support multiple users is to define the location and file name of an OAuthsettings file for each unique user in your connection string through the OAuthSettingsLocation parameter. When each user connects to the data source, Sisense generates the OAuth file with the file name you specify in the location you define. In the examples below, two users are allowed to access the Stripe data source and for each user, Sisense generates a file that contains that user’s OAuth values in the location defined in the string.
In the example above, to OAuth files are created, one for John and one for Sally in the location C:\Stripe\auth\.
This is useful if you support many users who each need to access the Stripe data source.
Stripe’s RESTful APIs expose the following Stripe tables that you can import into the ElastiCube Manager through the Sisense Stripe connector:
|Accounts||Create, update, delete, and query the Accounts you manage in Stripe.|
|BankAccounts||Create, update, delete, and query the available Bank Accounts in Stripe.|
|BankAccountTokens||Insert and query the available Bank Account Tokens in Stripe.|
|Cards||Create, update, and query the available Cards in Stripe.|
|CardTokens||Create and query the available Card Tokens in Stripe.|
|Charges||Create, update, and query the available Charges in Stripe.|
|Customers||Create, update, delete, and query the available Customers in Stripe.|
|Disputes||Update and query the available Disputes in Stripe.|
|Refunds||Query the available refunds in Stripe.|
|TransferReversals||Query the available categories in Stripe.|
|Transfers||Query the available transfers in Stripe.|
|AvailableBalance||Query the Available Balance in Stripe.|
|BalanceHistory||Query Balance History in Stripe.|
|CountrySpecs||Query the available Country Specs in Stripe.|
|Events||Query the available events in Stripe.|
|Orders||Query the available orders in Stripe.|
|PendingBalance||Query the available balance in Stripe.|
|Products||Query the available products in Stripe.|
|Skus||Query the available SKUs in Stripe.|
- Not all fields can be filtered.
- When a field cannot be filtered, you can not perform an accumulative build on that field.
Hey! Was this article helpful?
Questions? Ask the community.