Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →
Replicate Multiple Shippo Accounts
Replicate multiple Shippo accounts to one or many databases.
CData Sync for Shippo is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Shippo connections. In this article we show how to use the CLI to replicate multiple Shippo accounts.
Configure Shippo Connections
You can save connection and email notification settings in an XML configuration file. To replicate multiple Shippo accounts, use multiple configuration files. Below is an example configuration to replicate Shippo to SQLite:
Windows
<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
<DatabaseProvider>System.Data.SQLite</DatabaseProvider>
<ConnectionString>Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';</ConnectionString>
<ReplicateAll>False</ReplicateAll>
<NotificationUserName></NotificationUserName>
<DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
<TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
<TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>
Java
<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
<DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
<ConnectionString>Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';</ConnectionString>
<ReplicateAll>False</ReplicateAll>
<NotificationUserName></NotificationUserName>
<DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>
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.
Configure Queries for Each Shippo Instance
Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Shippo API. The statement below caches and incrementally updates a table of Shippo data:
REPLICATE Orders;
You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Shippo accounts into the same database:
You can use a different table prefix in the REPLICATE SELECT statement:
REPLICATE PROD_Orders SELECT * FROM Orders
Alternatively, you can use a different schema:
REPLICATE PROD.Orders SELECT * FROM Orders
Run Sync
After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:
Windows
APISync.exe -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql
Java
java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql
Data Connectors
ETL/ ELT Solutions
Cloud & API Connectivity
OEM & Custom Drivers
