Building a Custom API Connector
Create and use your own custom REST API ODBC driver or SSIS connector
Documentation

Using a Custom API Connector in an SSIS package


Now, we are ready to read data with the Hello-World Connector, which we created in the previous step, in SSIS:

Read data with Custom API Connector in an SSIS package

In this section we will learn how to configure and use Custom API Connector in API Source to extract data from Custom API.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Once the next window opens, just click OK:
    Hello-World Connector Selection

  8. Then use the Hello-World Connector by selecting it from disk:
    Hello-World Connector Selection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Hello-World Connector
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Custom API using Custom API Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Custom API and load into target