Manage ShipStation Data in DBArtisan as a JDBC Source

The CData JDBC Driver for ShipStation seamlessly integrates ShipStation data into database management tools like DBArtisan by enabling you to access ShipStation data as a database. This article shows how to create a JDBC source for ShipStation in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate ShipStation Data into DBArtisan Projects

Follow the steps below to register ShipStation data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to ShipStation data. ShipStation entities are displayed in the Datasource Explorer.

You can now work with ShipStation data as you work with any other database. See the driver help documentation for more information on the queries supported by the ShipStation API.