Ready to get started?

Download a free trial of the ShipStation Driver to get started:

 Download Now

Learn more:

ShipStation Icon ShipStation JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with ShipStation.

Connect to ShipStation Data in the Denodo Platform



Use CData driver technologies to create a virtual data source for ShipStation data in the Denodo Virtual DataPort Administrator.

Denodo Platform is a data virtualization product providing a single point of contact for enterprise database data. When paired with the CData JDBC Driver for ShipStation, Denodo users can work with live ShipStation data alongside other enterprise data sources. This article walks through creating a virtual data source for ShipStation in the Denodo Virtual DataPort Administrator.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live ShipStation data. When you issue complex SQL queries to ShipStation, the driver pushes supported SQL operations, like filters and aggregations, directly to ShipStation and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze ShipStation data using native data types.

Create the ShipStation Virtual Port

To connect to live ShipStation data from Denodo, you need to copy the JDBC Driver JAR file to the external library directory for Denodo and create a new JDBC Data Source from the Virtual DataPort Administrator tool.

  1. Download the CData JDBC Driver for ShipStation installer, unzip the package, and run the JAR file to install the driver.
  2. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for ShipStation\lib\) to the Denodo external library directory (C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-shipstation-19).
  3. Open the Denodo Virtual DataPort Administrator tool and navigate to the Server Explorer tab.
  4. Right-click "admin" and select New -> Data source -> JDBC.
  5. Configure the JDBC Connection:
    • Name: your choice, e.g.: shipstation
    • Database adapter: Generic
    • Driver class path: C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-shipstation-19
    • Driver class: cdata.jdbc.shipstation.ShipStationDriver
    • Database URI: Set this to a JDBC URL using the necessary connection properties. For example,

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

      Information on creating the Database URI follows:

      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.

      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.
  6. Click the "Test connection" button to confirm the configuration and click Save.

View ShipStation Data in the VirtualPort Administrator Tool

After creating the data source, you can create a base view of ShipStation data for use in the Denodo Platform.

  1. Click the "Create base view" button in the newly created VirtualPort (admin.ShipStation).
  2. Expand the object tree and select the objects (tables) you wish to import.
  3. Click the "Create selected" button to create views of the ShipStation data.
    Optional: Click "Create associations from foreign keys" to define relationships between the objects.
  4. With the view(s) created, navigate to a table (cdata_shipstation_tags) in the Server Explorer and double-click the selected table.
  5. In the new tab, click "Execution panel" to open a query panel.
  6. Customize the query in the "Execute" tab or use the default:
    SELECT * FROM cdata_shipstation_tags CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
    
  7. Click Execute to view the data.

With the base view created, you can now work with live ShipStation data like you would any other data source in Denodo Platform, for example, querying ShipStation in the Denodo Data Catalog.

Download a free, 30-day trial of the CData JDBC Driver for ShipStation and start working with your live ShipStation data in Denodo Platform. Reach out to our Support Team if you have any questions.