REST API Connector for Informatica

Introduction

JSON / REST API is becoming more and more popular each day as everyone embrace cloud-centric services. This article is primarily focused on Informatica users who want to access REST API data or may be other API Integration in Informatica. However many tips and techniques described in this article will help you to understand how to integrate REST API / XML SOAP / JSON / REST API in other ETL / Reporting apps such as Tableau, Power BI, SSRS, Talend, Excel and many more.

After going through this article you will learn how to Read REST API / JSON / REST API data in Informatica and understand the concept of JSON / REST API. We will go through many screenshots and step-by-step examples to demonstrate  REST API or REST API integration in Informatica PowerCenter.

XML / JSON can come from a local file or REST API service (internal or public) so we will include both examples in this article (i.e. Read JSON files in Informatica,  Import REST API in Informatica). So let’s get started. Next article will focus on how to write data to API in Informatica (POST / PUT data)

Requirements

This article assumes that you have full filled following basic requirements.

1. Download Install ZappySys ODBC PowerPack (API Driver for REST API included)
2. Install Informatica PowerCenter Client Tools (e.g. Workflow and Mapping Designers)
3. Access to a Relational database such as SQL Server (or use any of your choice e.g. Oracle, MySQL, DB2 ). If nothing available then you can use flat file target.

High level Steps for Import REST API data using Informatica (Read REST API API data)

Before we dive deep to learn how to load REST API data in Informatica (i.e. REST API to SQL Table), Here the summary of high-level steps you need to perform to import REST API in Informatica (same steps for Import JSON / XML / REST API).

1. Download and Install ZappySys API Driver (for connecting to REST API)
2. Create ODBC DSN using ZappySys API driver and choose REST API Connector during Wizard
3. Create Relational > ODBC Connection in Informatica Workflow designer (Point to DSN we created in the previous step)
4. Import REST API Source Definition in the Informatica Mapping Designer > Sources Tab
5. Import Target Table Definition in the Informatica Mapping Designer > Targets Tab
6. Create source to target mapping in Mappings tab
7. Save mapping (name m_API_to_SQL_Load )
8. Create Session using the mapping we created in the previous step
9. Save Workflow and execute to load REST API data into SQL Table. Verify your data and log.
   

   Loading REST API data to SQL Table in Informatica (Import REST API or JSON Files)

Video Tutorial – Read any API / JSON data in Informatica (Load REST API to SQL Table)

Getting Started – Import REST API to SQL Server in Informatica

Now let’s get started. For example purpose, we will read data from REST API and load data into SQL Server Table using Informatica Workflow.

Create ODBC Data Source (DSN) based on ZappySys JSON Driver

If your API is JSON Type and responding the json string response, in that case using ZappySys JSON Driver we can make the JSON API call and parse the json string. Let's configure the API call in the JSON Driver

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys JSON Driver

   
   
   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

4. Select Url or File and paste the following Url for this example OR you can load existing connection string as per this article.
   

   NOTE: Here for demo, We are using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type

   https://services.odata.org/V3/Northwind/Northwind.svc/Customers?$format=json

5. Now enter JSONPath expression in Array Filter textbox to extract only specific part of JSON file as below ($.value[*] will get content of value attribute from JSON document. Value attribute is array of JSON documents so we have to use [*] to indicate we want all records of that array)
   

   NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.

   
   Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.
   $.value[*]
   

6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
   

7. Click OK to finish creating the data source

8. That's it; we are done. In a few clicks we configured the call to JSON API using ZappySys JSON Connector.

Create ODBC Data Source (DSN) based on ZappySys XML Driver

In upper section we check how to make the JSON API call using JSON Driver and parse the json string response. Same way if your API is XML/SOAP Type and responding the xml string response, in that case using ZappySys XML Driver we can make the XML/SOAP API call and parse the xml string. Let's configure the API call in the XML Driver.

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys XML Driver

   
   
   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

4. Select Url or File and paste the following Url for this example OR you can load existing connection string as per this article.
   

   NOTE: Here for demo, We are using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type

   https://services.odata.org/V3/Northwind/Northwind.svc/Customers

5. Now enter Path expression in Array Filter textbox to extract only specific part of XML file as below ($.feed.entry[*] will get content of entry attribute from XML document. Entry attribute is array of XML documents so we have to use [*] to indicate we want all records of that array)
   

   NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.

   
   Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.
   $.feed.entry[*]
   

6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
   

7. Click OK to finish creating the data source.

8. That's it; we are done. In a few clicks we configured the call to XML API using ZappySys XML Connector.

Create ODBC Data Source (DSN) based on ZappySys CSV Driver

In upper section we check how to make the XML/Soap API call using XML Driver and parse the xml string response. Same way if your API is CSV Type or want to parse the CSV file data, in that case using ZappySys CSV Driver we can make the API call or read the CSV file data.

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys CSV Driver

   ZappySys CSV Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

4. Select Url or File.
   

   Read CSV API in Informatica

   • Paste the following Url. In this example, We are using Zip format CSV File URL, but you need to refer your CSV File/URL.

     https://zappysys.com/downloads/files/test/cust-1.csv.zip
     Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.

   Read CSV File in Informatica

   • You can use pass single file or multiple file path using wildcard pattern in path and you can use select single file by clicking [...] path button or multiple file using wildcard pattern in path.
     

     Note: If you want to operation with multiple files then use wild card pattern as below
     (when you use wild card pattern in source path then system will treat target path as folder regardless you end with slash)
     
     C:\SSIS\Test\reponse.csv (will read only single reponse.csv file)
     C:\SSIS\Test\j*.csv (all files starting with file name j)
     C:\SSIS\Test\*.csv (all files with .csv Extension and located under folder subfolder)
     

     Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.

5. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
   

6. Click OK to finish creating the data source

7. That's it; we are done. In a few clicks we configured the read the CSV data using ZappySys CSV Connector.

Create Connection in Informatica Workflow Designer

Once you create DSN using API Driver our next step is to define a connection for REST API source in Informatica PowerCenter Workflow designer.

1. Open Workflow designer [W] icon
2. Goto Connections > Relational
   

   Create a new connection for REST API in Informatica

3. Click New and select ODBC
   

   Select ODBC connection type in Informatica (Using ZappySys API ODBC DSN)

4. Now on the ODBC connection setup enter connection name, some fake userid / password (this is a required field but its ignored by JSON Driver)
5. In the Connection String field enter the exact same name of DSN (Open ODBC Data Sources UI to confirm)
   

   Configure REST API connection in Informatica for REST API – Using ZappySys API Driver

6. Click OK to close the connection properties.

That’s it. Now we ready to move to next step (define source and target in Mapping Designer).

Import REST API Source Definition in Informatica Mapping Designer

Now let’s look at steps to import REST API table definition.

1. Open Informatica Mapping Designer (Click [D] icon)
2. Click on Source Icon to switch to Sources designer
3. From the top menu > Click on Sources > Import from Database …
   

   Import REST API Source definition in Informatica Mapping Designer (JSON file or REST API)

4. Select ODBC data source from the dropdown (Find out DSN we created earlier to use as JSON Source)
5. Click Connect button to get a list of tables. Any array node is listed as a table. Also, you will see array node with parent columns (e.g. value_with_parent). You may get some warning like below but they are harmless so just ignore by clicking OK.
   
   DLL name entry missing from C:\Informatica\PowerCenter8.6.1\client\bin\powrmart.ini Section = ODBCDLL Entry = ZappySys JSON Driver
   —————————————————-
   Using EXTODBC.DLL to support ZappySys JSON Driver. For native support of ZappySys JSON Driver make an entry in the .ini file.
   

   Select REST API Source Table in Informatica Mapping Designer (JSON file or REST API)

6. Select Table you wish to get (You can filter rows by custom SQL query. We will see later in this article how to do)
7. Optionally once table structure is imported you can rename it
   

   Rename imported table definition in Informatica Source Designer

8. That’s it, we are now ready to perform similar steps to import Target table structure in the next section.

Import SQL Server Target Definition in Informatica Mapping Designer

Now let’s look at steps to import Target table definition (very similar to the previous section, the only difference is this time we will select DSN which points to SQL Server or any other Target Server).