Connect to ShipStation Data in Aqua Data Studio

The CData JDBC Driver for ShipStation integrates ShipStation data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to ShipStation data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The ShipStation data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, ShipStation.
   • Driver Location: Click the Browse button and select the cdata.jdbc.shipstation.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.shipstation.ShipStationDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:shipstation: and is followed by a semicolon-separated list of connection properties.

     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 below:
     jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'

Query ShipStation Data

You can now query the tables exposed.