Learn more
 

Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo

In this article

Related articles

Viewing Shippo Data in RAD Studio Data Explorer


How to view Shippo data in RAD Studio Data Explorer using the CData ODBC Driver for Shippo.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Shippo, you gain access to live Shippo data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve Shippo data. This article will walk through connecting to Shippo using the Data Explorer.

Configure a Connection to Shippo

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Connecting to Shippo Data Using Data Explorer

You can create a simple application for displaying Shippo data by utilizing the CData FireDAC Components for Shippo and a new VCL Forms Application:

  1. Open the Data Explorer in RAD Studio and expand FireDAC.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Shippo.
  6. Back in the Data Explorer, expand the views for the connection.

  7. Create a new VCL Forms application and drag a view (for example: Orders) onto the form.

  8. Select the OrdersView object on the form and set the Active property to true.

  9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

  10. Arrange the TStringGrid on the form and run the application to see the Orders data.