Connecting to Stripe
The Sisense Stripe connector is a certified connector that allows you to import data from the Stripe API into Sisense via theSisense generic JDBC connector. The Stripe connector offers the most natural way to integrate with Stripe account data including Accounts, BankAccounts, Customers, Transfers, and more, and provide additional powerful features.
Sisense Stripe connector is a certified connector. The support for the connector is provided by Sisense and will be assisted by the certification partner's support, if needed. For any support issues or additional functionality requests, please contact your Sisense representative or open a request through our Help Center. For advanced inquiries specific to driver functionality, you can also contact our certification partner’s support directly via [email protected].
After you have downloaded the driver, you can connect through a connection string in Sisense. The connection string is used to authenticate users who connect to the Stripe APIs. To obtain a connection string, you will need to register 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 download the Stripe driver and deploy it, how to connect to Stripe with a connection string, provides information about the Stripe data model, and more.
- Downloading the Stripe JDBC Driver
- Deploying the Stripe JDBC Driver
- Connecting to Stripe
- Adding Stripe Tables to your ElastiCube
- Stripe Connector: Additional Resources
You can download the Stripe JDBC driver here.
- The driver is certified for Sisense v7.2 and above.
- Sisense v7.4 and above: Click the above link to download a ready-to-use driver.
- Sisense prior to v7.4: Click the above link to download a 30-days free-trail of the driver. Contact Sisense for the full license version.
To run the setup, execute the following command: java -jar setup.jar (OR, if your system is set up to run Java applications, double-click on setup.jar).
During the installation, pay attention to the path of the installation (you will need it later on, to direct Sisense to the Jar file. The default path is C:\Program Files\CData\CData JDBC Driver for Stripe 2019\lib).
Note: The install file (setup.jar) is a Java application that requires Java 6 (J2SE) or above to run. If you do not have Java 6 installed, you may download it from here.
To access Stripe’s REST API from Sisense, you must provide valid Oauth Stripe credentials through a connection string. These credentials are provided by Stripe when you register 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.
Creating the Stripe Connection String
Sisense uses connection strings to connect to Stripe and import data into Sisense. Each connection string contains a authentication parameters that the data source uses to verify your identity and what information you can export to Sisense.
The following is an example of a Stripe connection string:
Your Stripe connection string should include the following parameters, separated by a semicolon ';'.
- 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.
To help you create a connection string and test the connection, see Connection String Builder for Certified Connectors.
If you have any issues connecting to your data source, see Troubleshooting JDBC Data Connectors.
- In the Data page, open an ElastiCubeor create a new ElastiCube.
- In the Model Editor, click . The Add Data dialog box is displayed.
- Click Generic JDBC to open the JDBC settings.
- In Connection String, enter the Stripe URL. See Creating a Connection String for more information.
- In JDBC JARs Folder, enter the name of the directory where the Stripe JAR file is located (see Deploying the Stripe JDBC Driver).
- In Driver's Class Name, enter the following class name: cdata.jdbc.stripe.StripeDriver.
- In User Name and Password, enter your Stripe credentials. These fields are not required if the user name and password were provided in the connection string.
- Click Next. A list of tables in the database are displayed. All tables and views associated with the database will appear in a new window.
- From the Tables list, select the relevant table or view you want to work with. You can click next to the relevant table or click Preview to see a preview of the data inside it.
- (Optional) Click + to customize the data you want to import with SQL. See Importing Data with Custom Queries for more information.
- After you have selected all the relevant tables, click Done. The tables are added to your data model.
For the full documentation set for the Stripe connector, click here.
For connection string options, click here.
For information on the Stripe data model, click here.
- Not all fields can be filtered.
- When a field cannot be filtered, you cannot perform an accumulative build on that field.