Query, Visualize, and Share live ShipEngine Data in Redash

Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to live ShipEngine data in Redash for querying, visualizing, and sharing.

Redash is a collaboration tool that lets you query, visualize, and share your data. When paired with CData Connect AI, Redash gets access to live ShipEngine data. This article demonstrates how to connect to ShipEngine using Connect AI and work with live ShipEngine data in Redash.

CData Connect AI provides a pure SQL Server interface for ShipEngine, allowing you to query data from ShipEngine without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to ShipEngine, leveraging server-side processing to return the requested ShipEngine data quickly.

Configure ShipEngine Connectivity for Redash

Connectivity to ShipEngine from Redash is made possible through CData Connect AI. To work with ShipEngine data in Redash, we start by creating and configuring a ShipEngine connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Adding a Connection
  3. Select "ShipEngine" from the Add Connection panel
  4. Selecting a data source
  5. Enter the necessary authentication properties to connect to ShipEngine.

    Start by setting the Profile connection property to the location of the ShipEngine Profile on disk (e.g. C:\profiles\ShipEngine.apip). Next, set the ProfileSettings connection property to the connection string for ShipEngine (see below).

    ShipEngine API Profile Settings

    Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add ShipEngine Connection page and update the User-based permissions. Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to ShipEngine data from Redash.

Connect to ShipEngine from Redash using Connect AI

To establish a connection from Redash to CData Connect AI using the Virtual SQL Server, follow these steps:

  1. Log into Redash.
  2. Click the settings widget on the top right.
  3. Click New Data Source.
  4. Select Microsoft SQL Server as the Data Source Type.
  5. On the configuration tab, set the following properties:
    • Database Name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Salesforce1).
    • Server: enter the virtual SQL Server host name (tds.cdata.com)
    • User: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: enter the PAT you generated on the Settings page.
    • Port: enter 14333
    Configuring the connection to Connect AI from Redash.
  6. Click Create.
  7. Click Test Connection to ensure that the connection is configured properly.

You can now work with live ShipEngine data in Redash.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Redash, try CData Connect AI today!

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial