In the previous article, we learned how to copy settings from curl to ZappySys products, and in this article, we will continue on how to migrate Postman API call to SSIS / ODBC PowerPack. Postman is a very popular client tool to test API calls. Many API providers document how to call their API using Postman. In this article we will focus on how to use the same settings in ZappySys Products to implement API integration in SSIS or other apps like Power BI, Informatica, Excel, Tableau, SSRS… many ODBC apps.

When you are connecting to an API you may have examples of how to do that in Postman. If you know how to do it in Postman, you are one step away from making it work in SSIS PowerPack and ODBC PowerPack (JSON, XML, CSV Drivers, and other). Most of the examples will show how to do that specifically using ODBC PowerPack and JSON Driver, but since ODBC PowerPack UI is very similar to the connectors of SSIS PowerPack, it will be quite clear where to use it in SSIS PowerPack as well. In the examples where UI differs significantly, both – ODBC and SSIS PowerPack – examples will be presented.

Prerequisites

In this article we assume you meet these requirements:

When migrating Postman API call to SSIS PowerPack

1. Postman installed.
2. SSIS designer installed. Sometimes it is referred to as BIDS or SSDT (download it from Microsoft site).
3. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
4. ZappySys SSIS PowerPack is installed (download it).

When migrating Postman API call to to ODBC PowerPack

1. Postman installed.
2. ZappySys ODBC PowerPack installed (download it).

The Basics

This section shows how to migrate simple options such as URL, HTTP Request Method, and HTTP Headers.

How to configure the URL and HTTP Request Method

Migrate Postman API call to SSIS / ODBC (API URL setting to ODBC Driver (GET / POST) )

How to configure HTTP Headers

Migrate Postman HTTP Headers setting to ODBC Driver

Posting data

In this section, you will find how to post data in ZappySys products. You will learn how to post different formats of data, upload files and send multi-part data.

How to configure POST raw body

Migrate Postman Body / Content-Type setting to ODBC Driver

How to configure POST JSON body

Migrate Postman Body / Content-Type setting to ODBC Driver

Use this table to determine what kind of Body Content Type to configure:

How to configure POST form/x-www-form-urlencoded data

Migrate Postman Body (x-www-form-urlencoded) setting to ODBC Driver

How to configure multipart form POST data

Migrate Postman Multi-Part File Upload setting to ODBC Driver (Upload File)

Authentication

This section will cover all common authentication methods, starting from using API Key to OAuth 2.0.

How to authenticate using API Key in HTTP headers

Authentication – Migrate Postman API Key (via header) setting to ODBC Driver

How to authenticate using API Key as a parameter in URL

Authentication – Migrate Postman API Key (via URL query parameter) setting to ODBC Driver

How to authenticate using Bearer Token

Authentication – Migrate Postman Bearer Token setting to SSIS / ODBC Driver

How to authenticate using Basic Authentication

In ODBC PowerPack

Authentication – Migrate Postman Basic Auth setting to SSIS / ODBC Driver (Login using Userid / password)

In SSIS PowerPack

In SSIS PowerPack use the same configuration as above, just create ZS-HTTP Connection Manager using instructions below:

Authentication – Migrate Postman Basic Auth setting to SSIS JSON / XML Source (Login using Userid / password)

How to authenticate using OAuth

In ODBC PowerPack

1. Configure main options:
   

   Authentication – Migrate Postman OAuth setting to SSIS / ODBC Drivers ( JSON / XML / CSV API) – Client ID / Secret / Scope / Auth and Token Url (Client Credential Grant Type, Password Grant Type, Code Authorization Grant Type)

2. Configure Callback/Return Url:
   

   Authentication – Migrate Postman OAuth setting to SSIS / ODBC Drivers ( Callback / Redirect URL )

If you are using a known, public API service, you may try locating it in the OAuth Providers list, which will save you from configuring Authorization and Access Token URLs:

For simplicity and if your company policy allows it or at least for testing purposes, you can use a Default OAuth Application created by ZappySys:

In SSIS PowerPack

In SSIS PowerPack use the same configuration as above, just create ZS-OAUTH Connection Manager using instructions below:

Authentication – Migrate Postman OAuth setting to SSIS JSON / XML Source

How to authenticate using AWS Signature

In ODBC PowerPack

Authentication – Migrate Postman AWS API call setting to SSIS / ODBC Drivers ( JSON / XML / CSV API call)

In SSIS PowerPack

In SSIS PowerPack use the same configuration as above, just create ZS-OAUTH Connection Manager using instructions below:

How to authenticate using NTLM Authentication

In ODBC PowerPack

In SSIS PowerPack

In SSIS PowerPack use the same configuration as above, just create ZS-HTTP Connection Manager using instructions below:

Conclusion

This article was quite self-explanatory, but if you have any questions or you have an authentication method that is not listed here and you don’t know how to proceed, please, contact us and we will try to help you: https://zappysys.com/support/.

The post How to migrate Postman API call to SSIS / ODBC PowerPack appeared first on ZappySys Blog.

Often, REST API documentation uses example syntax for the curl command-line tool because it’s one of the most popular tools for making API calls. However, suppose you are an SSIS developer using ZappySys API Drivers/Connectors from either the SSIS PowerPack or the ODBC PowerPack. In that case, this blog post will help you translate the curl command line syntax to similar options available in the ZappySys Product. For SSIS PowerPack products, you can refer to Connectors/Tasks such as ZappySys REST API Task / JSON Source Connector / XML Source. To make this article short and simple, we will show many screenshots from SSIS PowerPack UI, but the concepts are the same when you use other products, such as ODBC PowerPack JSON Driver / REST  or XML Driver.

If you are using Postman to call the API, then refer to this article

If you are using Fiddler to call an API, then refer to this article

CheatSheet – Curl to SSIS PowerPack / ODBC PowerPack

Before we dig down more. Let’s look at how each command-line parameter from CURL maps to SSIS PowerPack settings.

Convert Curl Syntax to SSIS PowerPack – REST API Task / JSON / XML Connector

Take a look at the following example of CURL syntax

curl POST -u myusername:mypassword -H "Accept: application/json" -H "AppVersion:1.0" "https://mysite/v1/api/customers/" -d "customerid=AAA&OrderDate=2016-01-01"

Where :

-u

--user

-H

--header

-d

--data

For step-by-step information, check Article Learn how to POST data to a URL using SSIS

Here is the screenshot of HTTP POST in JSON format using the ZappySys REST API Task

Convert CURL Command Line Syntax to SSIS – Perform HTTP POST operation using SSIS REST API Task – Send data in JSON content type

If you wish to POST data and parse the JSON response into rows, you can use the SSIS JSON Source. JSON Source has a powerful JSON Parser that parses large JSON (stored in a file, an API URL, or a Direct string) into Rows and Columns. This is useful if you wish to save the response into a target such as SQL Server or a CSV file.

JSON Source example

HTTP Headers – Convert Curl Syntax to SSIS

Set up HTTP headers in ZappySys Task/Connect, or click on Raw Edit or Add/Edit items in Grid.

HTTP Credentials – Convert Curl Syntax to SSIS

Here is how you pass credentials in the curl command line.

curl.exe https://myserver.com/api -u myusername:mypassword

To setup HTTP credentials in SSIS for Basic / NTFS or Kerberos use HTTP Connection Manager (Access Mode must be changed to Url from Connection on ZappySys REST API Task and for JSON Source Connector or XML Source  check Use Connection Option)

If you have OAuth 2.0 Credentials (Application ID, Application Secret) then use SSIS OAuth Connection Manager rather than HTTP Connection

Check this article to learn about how to pass HTTP Basic Credentials in SSIS PowerPack

Proxy Setting – Convert Curl Syntax to SSIS

Here is how you pass Proxy server info in cUrl command line (

-x

curl.exe -x 192.168.2.1:8888 https://myserver.com/api

Convert Curl Syntax to SSIS – Client Certificate Settings

The post Convert CURL to SSIS PowerPack / ODBC for API Call appeared first on ZappySys Blog.