Automated Continuous API Replication to SQL Server

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live API data into your SQL Server instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure SQL Server as a Replication Destination

Using CData Sync, you can replicate API data to SQL Server. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select SQL Server as a destination.
3. Enter the necessary connection properties. To connect to SQL Server, set the following:
   • Server: The name or network address of the computer running SQL Server.
   • User: The username provided for authentication with SQL Server, if using forms authentication.
   • Password: The password provided for authentication with SQL Server, if using forms authentication.
   • Database: The name of the SQL Server database.

   Java Edition

   The Java version requires the Microsoft SQL Server JDBC driver, which can be downloaded from the Microsoft Download Center. Copy the JDBC driver to the lib folder of your Java Web server to make a connection.

4. Click Test Connection to ensure that the connection is configured properly.
5. Click Save Changes.

Configure the API Connection

You can configure a connection to API from the Connections tab. To add a connection to your API account, navigate to the Connections tab.

1. Click Add Connection.
2. Select a source (API).
3. Configure the connection properties.
   
   

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next"
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
   9. Preview the tabular model of the API response and click "Confirm"
4. Click Connect to ensure that the connection is configured properly.
5. Click Save Changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your API data to SQL Server.