Learn more
 

Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo

In this article

Related articles

Analyze Shippo Data in R


Create data visualizations and use high-performance statistical functions to analyze Shippo data in Microsoft R Open.

Access Shippo data with pure R script and standard SQL. You can use the CData ODBC Driver for Shippo and the RODBC package to work with remote Shippo data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Shippo data and visualize Shippo data in R.

Install R

You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).

Connect to Shippo as an ODBC Data Source

Information for connecting to Shippo follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

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.

Linux

If you are installing the CData ODBC Driver for Shippo in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Source] Driver = CData ODBC Driver for Shippo Description = My Description Profile = C:\profiles\Shippo.apip ProfileSettings = 'APIKey = my_api_key'

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Load the RODBC Package

To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.

After installing the RODBC package, the following line loads the package:

library(RODBC)

Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.

library(checkpoint) checkpoint("2016-01-01")

Connect to Shippo Data as an ODBC Data Source

You can connect to a DSN in R with the following line:

conn <- odbcConnect("CData API Source")

Schema Discovery

The driver models Shippo APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

sqlTables(conn)

Execute SQL Queries

Use the sqlQuery function to execute any SQL query supported by the Shippo API.

orders <- sqlQuery(conn, "SELECT ObjectId , OrderStatus FROM Orders WHERE ShopApp = 'Shippo'", believeNRows=FALSE, rows_at_time=1)

You can view the results in a data viewer window with the following command:

View(orders)

Plot Shippo Data

You can now analyze Shippo data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(orders$OrderStatus, main="Shippo Orders", names.arg = orders$ObjectId , horiz=TRUE)