API Connection Manager
 PreviousNext

SSIS API Connection Manager can be used with API Source (Predefined Templates), API Destination (Predefined Templates) to read/write popular API Data using predefined Connector File without learning internals of API Calls.

Download SSIS PowerPack

Content

Video Tutorial

Coming soon...

Step-By-Step

In this tutorial we will learn how to create API Connection in various mode. You can create multiple connection(Used with API Source, API Destination).
  1. Firstly, You need to Download and Install SSIS ZappySys PowerPack.
  2. Once you finished above steps, Open Visual Studio and Create New SSIS Package Project.
  3. Right click in the Connection Manager panel and click on New Connection.
    SSIS Create New Connection
  4. Select ZS-API Connection Manager from the Connection Managers list and Click on Add Button.
    SSIS API Connection - ADD
  5. Here, there are three various mode([Choose from Popular Connection List], [Local Path], [Embedded Text]) to create API Connection.
    SSIS API Connection - Various Mode
  6. Let's configure it.

How to create API Connection using Choose from Popular Connection List.

  1. Choose [OData] from Popular Connectors dropdown and Click Continue.
    SSIS API connection
  2. This example doesn't need any authentication so leave everything else default. However in real world you will need to supply Authentication information.
    SSIS API connection
  3. Click Test Connection to confirm everything is good.
  4. Click OK to save UI and go back to API Source UI.
  5. Once you finished, you will see API Connection in Connection Manager panel.
    SSIS API Connection Manager - Success

How to create API Connection using Local Path.

In this case need to download predefined API Connector file and use it with Local Path.
  1. Choose [Search Online] and Click on [Search Online] button.
    SSIS API Connection Manager - Search Online
  2. Now, In the HTML Preview you can Search by API name and download API Connector file from the list.
    SSIS API Connection Manager - HTML Preview
  3. Once you click on the Download button, it will ask you to save API Connector file in the local drive and Save it.
  4. Now, Connector file downloaded. Select option below what would you like to do with new API connector file.
    SSIS API Connection Manager - Select Option

    --- OR ---

    Select API Connector file, Which is earlier downloaded and Click Continue.
    SSIS API Connection Manager - Select File
  5. This example doesn't need any authentication so leave everything else default. However in real world you will need to supply Authentication information.
    SSIS API connection
  6. Click Test Connection to confirm everything is good.
  7. Click OK to save UI and go back to API Source UI.
  8. Once you finished, you will see API Connection in Connection Manager panel.
    SSIS API Connection Manager - Success

How to create API Connection using Embedded Text.

  1. Choose [Enter Direct Config XML (Embedded Text)], Click on <<Edit Config>> to enter embedded text or you can copy paste from predefined API connector file and Click Continue.
    SSIS API Connection Manager - Embedded Text
  2. This example doesn't need any authentication so leave everything else default. However in real world you will need to supply Authentication information.
    SSIS API connection
  3. Click Test Connection to confirm everything is good.
  4. Click OK to save UI and go back to API Source UI.
  5. Once you finished, you will see API Connection in Connection Manager panel.
    SSIS API Connection Manager - Success

Properties

Property Name Description

Setting UI

SSIS API Connection - Setting UI

See Also

References

Copyrights reserved. ZappySys LLC.