How to connect to ShipStation Data from IntelliJ

The CData JDBC Driver for ShipStation enables you to access ShipStation as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to ShipStation data in IntelliJ.

Create a JBDC Data Source for ShipStation

Follow the steps below to add the driver JAR and define connection properties required to connect to ShipStation data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.shipstation.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.shipstation.ShipStationDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:shipstation: and includes connection properties separated with semicolons.

     Use the BASIC Authentication standard to connect.

     1. Login to your ShipStation account
     2. Click on the settings icon in the upper right corner. A column menu will show up on the left
     3. Click Account -> API Settings
     4. On the API Settings page, note the API Key and API Secret.

     Authenticating to ShipStation

     • APIKey: Set this to the API key from the API settings page.
     • APISecret: Set this to the Secret key from the API settings page.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the ShipStation JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.shipstation.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is the following:

     jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'

Edit and Save ShipStation Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.