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.

Configure the CData JDBC Driver for ShipStation in a Connection Pool in Tomcat



Connect to ShipStation data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to ShipStation data from a connection pool in Tomcat.

Connect to ShipStation Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    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.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/shipstation" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.shipstation.ShipStationDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access ShipStation data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to ShipStation for all applications.

  3. Add a reference to the resource to the web.xml for the application. ShipStation data JSP jdbc/ShipStation javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/ShipStation"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to ShipStation data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.