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 JRuby

Create a simple JRuby app with access to live ShipStation data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for ShipStation makes it easy to integrate connectivity to live ShipStation data in JRuby. This article shows how to create a simple JRuby app that connects to ShipStation data, executes a query, and displays the results.

Configure a JDBC Connection to ShipStation Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for ShipStation\lib).

JRuby natively supports JDBC, so you can easily connect to ShipStation and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for ShipStation:


Create a JRuby App with Connectivity to ShipStation Data

Create a new Ruby file (for example: ShipStationSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for ShipStation 2018/lib/cdata.jdbc.shipstation.jar' url = "jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Color FROM Tags") while ( do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your ShipStation data with JRuby. To do so, simply run your file from the command line:

jruby -S ShipStationSelect.rb

Writing SQL-92 queries to ShipStation allows you to quickly and easily incorporate ShipStation data into your own JRuby applications. Download a free trial today!