Query Shippo Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Shippo data as if it were a MySQL database. This article shows how to create a virtual database for Shippo in Connect and work with live Shippo data in MySQL Workbench.

Create a Virtual MySQL Database for Shippo Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Shippo" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Shippo.

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

   Shippo API Profile Settings

   In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Shippo from MySQL Workbench.

Query Shippo from MySQL Workbench

The steps below outline connecting to the virtual Shippo database in Connect from MySQL Workbench and issuing basic queries to work with live Shippo data.

Connect to Shippo through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Shippo Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Shippo data, like SELECT * FROM shippodb.Orders;

With access to live Shippo data from MySQL Workbench, you can easily query and update Shippo, just like you would a MySQL database. Request a demo of the CData Connect and start working with Shippo just like a MySQL database today.