Build Data Flows from ConvertAPI to SQL Server using SSIS

Using SQL Server as a backup for critical business data provides an essential safety net against loss. Backing up data to SQL Server enables business users to more easily connect that data with features like reporting, analytics, and more.

This example demonstrates how to use the CData SSIS Tasks for ConvertAPI inside of a SQL Server SSIS workflow to transfer ConvertAPI data into a Microsoft SQL Server database.

Add the Components

To get started, add a new ConvertAPI source and SQL Server ADO.NET destination to a new data flow task.

Create a New Connection Manager

Follow the steps below to save ConvertAPI connection properties in a connection manager.

1. In the Connection Manager window, right-click and then click New Connection. The Add SSIS Connection Manager dialog is displayed.
2. In the Connection Manager type menu, select API. The CData ConvertAPI Connection Manager is displayed.
3. Configure connection properties.

   ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

   Using APIKey Authentication

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your ConvertAPI API secret key.

   Example connection string:

   Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
   

   👁 Configuring a connection (Salesforce is shown).
   

Configure the ConvertAPI Source

Follow the steps below to specify the query to be used to extract ConvertAPI data.

1. Double-click the ConvertAPI source to open the source component editor.
2. In the Connection Manager menu, select the connection manager previously created.
3. Specify the query to use for the data extraction. For example:

   SELECT , FROM User WHERE = ''
   

   👁 The SQL query to retrieve records. (Salesforce is shown.)
   
4. Close the ConvertAPI Source control and connect it to the ADO.NET Destination.

Configure the SQL Server Destination

Follow the steps below to specify the SQL server table to load the ConvertAPI data into.

1. Open the ADO.NET Destination and add a New Connection. Enter your server and database information here.
2. In the Data access mode menu, select "table or view".
3. In the Table Or View menu, select the table or view to populate.
4. Configure any properties you wish to on the Mappings screen. 👁 The mappings from the SSIS source component to SQL Server. (Salesforce is shown.)
   

Run the Project

You can now run the project. After the SSIS Task has finished executing, your database will be populated with ConvertAPI data.