How to integrate REST API using Informatica PowerCenter
Learn how to quickly and efficiently connect REST API with Informatica PowerCenter for smooth data access.
Read and write REST API data effortlessly. Streamline, manage, and automate JSON, XML, and CSV from web URLs for analytics, reporting, and data pipelines — almost no coding required. You can do it all using the high-performance REST API ODBC Driver for Informatica PowerCenter (often referred to as the REST API Connector). We'll walk you through the entire setup.
Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.
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)
If you need to consume API which is not listed on connector library page then please refer to the below article links. It talks about how to read / write pretty much any API and not just REST API API. It explains various API tips / tricks using our other Universal Drivers not mentioned in this article (i.e. ZappySys JSON / XML and CSV Drivers).
Requirements
This article assumes that you have full filled following basic requirements.
- Download Install ZappySys ODBC PowerPack (API Driver for REST API included)
- Install Informatica PowerCenter Client Tools (e.g. Workflow and Mapping Designers)
- 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).
- Download and Install ZappySys API Driver (for connecting to REST API)
- Create ODBC DSN using ZappySys API driver and choose REST API Connector during Wizard
- Create Relational > ODBC Connection in Informatica Workflow designer (Point to DSN we created in the previous step)
- Import REST API Source Definition in the Informatica Mapping Designer > Sources Tab
- Import Target Table Definition in the Informatica Mapping Designer > Targets Tab
- Create source to target mapping in Mappings tab
- Save mapping (name m_API_to_SQL_Load )
- Create Session using the mapping we created in the previous step
- Save Workflow and execute to load REST API data into SQL Table. Verify your data and log.
Video Tutorial – Read any API / JSON data in Informatica (Load REST API to SQL Table)
Below video is not about REST API API but its showing API access in general (for any API). By watching following ~5 min video can learn steps listed in this article to load JSON API data into SQL Server Table using ZappySys JSON Driver. You can go though full article to learn many useful details not covered in this video.
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
ZappySys provides specialized ODBC drivers to connect to various API formats. Depending on your API's response type, follow the relevant configuration section below:
-
JSON Driver
Best for REST APIs responding with JSON data.
-
XML Driver
Designed for SOAP services or APIs returning XML strings.
-
CSV Driver
Use this for APIs returning CSV data or for parsing flat files.
Using JSON Driver
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys JSON Driver driver:
ZappySys JSON Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
-
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
-
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[*]
-
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source
-
That's it; we are done. In a few clicks we configured the call to JSON API using ZappySys JSON Connector.
Using XML Driver
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys XML Driver driver:
ZappySys XML Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
-
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
-
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[*]
-
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source.
-
That's it; we are done. In a few clicks we configured the call to XML API using ZappySys XML Connector.
Using CSV Driver
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys CSV Driver driver:
ZappySys CSV Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
-
Select Url or File.
Read CSV API in Informatica PowerCenter
-
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.zipClick on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.
Read CSV File in Informatica PowerCenter
-
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.
-
-
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source
-
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.
- Open Workflow designer [W] icon
- Goto Connections > Relational
- Click New and select ODBC
- Now on the ODBC connection setup enter connection name, some fake userid / password (this is a required field but its ignored by JSON Driver)
-
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
- 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.
-
Open Informatica Mapping Designer (Click [D] icon)
-
Click on Source Icon to switch to Sources designer
-
From the top menu > Click on Sources > Import from Database …
-
Select ODBC data source from the dropdown (Find out DSN we created earlier to use as JSON Source)
-
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 Table you wish to get (You can filter rows by custom SQL query. We will see later in this article how to do)
- Optionally once table structure is imported you can rename it
- 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).
Now lets look at steps to import target table definition in Informatica mapping designer.
- In the Mapping Designer, Click on Target Icon to switch to Target designer
- From the top menu > Click on Targets > Import from Database …
- Select DSN for your Target server (if DSN doesn’t exist then create one by opening ODBC Sources just like we created one for JSON API source (see the previous section about creating DSN).
- Enter your userid , password and Schema name and click Connect to see tables
- Select Table name to and click OK import definition.
Create Source to Target Mapping in Informatica (Import JSON to SQL Server)
Once you have imported source and target table definition, we can create mapping and transformation to load data from JSON to SQL Table.
- First open Mapping Designer (Click [D] icon)
- Drag JSON Source from sources folder
- Drag SQL Table from Targets folder
- Map desired columns from Source to target
-
For certain columns you may have to do datatype conversion. For example to convert OrderDate form nstring to DataTime you have to use Expression Transform like below and map it to target. In below example, our JSON has date format (e.g. 2018-01-31 12:00:00 AM ). To import this to DateTime field in SQL server we need to convert it using TO_DATE function. Use double quotes around T to make this format working.
TO_DATE(OrderDate,'YYYY-MM-DD H12:MI:SS AM') --For ISO use below way TO_DATE(OrderDate,'YYYY-MM-DD"T"HH24:MI:SS') - Once you done with mapping save your mapping and name it (i.e. m_Api_To_SQL)
- Now lets move to next section to create workflow.
Create Workflow and Session in Informatica
Now the final step is to create a new workflow. Perform following steps to create workflow which with a session task to import JSON data into SQL table.
- Open workflow designer by click [W] icon.
-
Launch new workflow creation wizard by click Workflow top menu > Wizard
name your workflow (e.g. wf_Api_Tp_Sql_Table_Import) - Finish the wizard and double-click the Session to edit some default properties.
- First change Error settings so we fail session on error (By default its always green)
- Select JSON connection for Source
- Change default Source query if needed. You can pass parameters to this query to make it dynamic.
- Select Target connection of SQL Target Table
- Save workflow
- That’s it. We ready to run our first workflow to load JSON data to SQL.
Execute Workflow and Validate Log in Informatica
Now once you are done with your workflow, execute it to see the log.
POST data to REST API in Informatica
There will be a time when you like to send Source data to REST API or SOAP Web Service. You can use below Query for example. For detailed explanation on how to POST data in Informatica check this article .
Video Tutorial – How to POST data to REST API in Informatica
Here is detailed step by step video on REST API POST in informatica PowerCenter
Keywords
how to import REST API in informatica | how to read REST API data in informatica powercenter | how to test json from informatica | how to use REST API data as source in informatica power center | how to connect REST API in informatica 10 | informatica how to import data from REST API | informatica jtx to import REST API (use of java transformation) | informatica plugin for restful api using json | informatica power center and REST API support | informatica read REST API | informatica rest api | informatica REST API connector | json parser import informatica
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide REST API data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.
This configuration provides two primary advantages:
-
Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
-
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
| Data Gateway |
Local ODBC
data source
|
|
|---|---|---|
| Simple configuration | ||
| Installation | Single machine | Per machine |
| Connectivity | Local and remote | Local only |
| Connections limit | Limited by License | Unlimited |
| Central data access | ||
| Central access control | ||
| More flexible cost |
To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in Informatica PowerCenter (client-side) to connect to it.
Let's not wait and get going!
Create REST API data source in the gateway
In this section we will create a data source for REST API in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
Go to the Users tab and follow these steps to add a Data Gateway user:
- Click the Add button
-
In the Login field enter a username, e.g.,
john - Then enter a Password
- Check the Is Administrator checkbox
- Click OK to save
-
Now we are ready to add a data source:
- Click the Add button
- Give the Data source a name (have it handy for later)
- Then select Native - ZappySys JSON, XML or CSV Driver
- Finally, click OK
RestApiDSNZappySys JSON, XML or CSV Driver
-
When the ZappySys JSON, XML or CSV Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the REST API ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:
-
Open ODBC data source configuration and click Copy settings:
ZappySys JSON, XML or CSV Driver - REST APIRead and write REST API data effortlessly. Streamline, manage, and automate JSON, XML, and CSV from web URLs for analytics, reporting, and data pipelines — almost no coding required.RestApiDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then go to Data Gateway configuration and in data source configuration window click Load settings:
RestApiDSN
ZappySys JSON, XML or CSV Driver - Configuration [Version: 2.0.1.10418]ZappySys JSON, XML or CSV Driver - REST APIRead and write REST API data effortlessly. Streamline, manage, and automate JSON, XML, and CSV from web URLs for analytics, reporting, and data pipelines — almost no coding required.RestApiDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:
- This will initially allow all inbound traffic.
- Click Edit IP filters to restrict access to specific IP addresses or ranges.
-
Crucial Step: After creating or modifying the data source, you must:
- Click the Save button to persist your changes.
- Hit Yes when prompted to restart the Data Gateway service.
This ensures all changes are properly applied:
Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.
Create ODBC data source to connect to the gateway
In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from Informatica PowerCenter. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:
ODBC Driver 17 for SQL Server
If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
Proceed with the authentication part:
- Select SQL Server authentication
-
In the Login ID field enter the user name you created in the Data Gateway, e.g.,
john - Set Password to the one you configured in the Data Gateway
-
Then set the default database property to
RestApiDSN(the one we used in the Data Gateway):RestApiDSNRestApiDSN
Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in Informatica PowerCenter via the gateway
Finally, we are ready to read data from REST API in Informatica PowerCenter via the Data Gateway. Follow these final steps:
-
Go back to Informatica PowerCenter.
-
Open Informatica Mapping Designer (Click [D] icon)
-
Click on Source Icon to switch to Sources designer
-
From the top menu > Click on Sources > Import from Database …
-
Select ODBC data source from the dropdown (Find out DSN we created earlier to use as JSON Source)
-
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. -
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to REST API data in Informatica PowerCenter via the Data Gateway.
john and your password.
Configuring pagination in the REST API Driver
ZappySys REST API Driver equips users with powerful tools for seamless data extraction and management from REST APIs, leveraging advanced pagination methods for enhanced efficiency. These options are designed to handle various types of pagination structures commonly used in APIs. Below are the detailed descriptions of these options:
Page-based Pagination: This method works by retrieving data in fixed-size pages from the Rest API. It allows you to specify the page size and navigate through the results by requesting different page numbers, ensuring that you can access all the data in a structured manner.
Offset-based Pagination: With this approach, you can extract data by specifying the starting point or offset from which to begin retrieving data. It allows you to define the number of records to skip and fetch subsequent data accordingly, providing precise control over the data extraction process.
Cursor-based Pagination: This technique involves using a cursor or a marker that points to a specific position in the dataset. It enables you to retrieve data starting from the position indicated by the cursor and proceed to subsequent segments, ensuring that you capture all the relevant information without missing any records.
Token-based Pagination: In this method, a token serves as a unique identifier for a specific data segment. It allows you to access the next set of data by using the token provided in the response from the previous request. This ensures that you can systematically retrieve all the data segments without duplication or omission.
Utilizing these comprehensive pagination features in the ZappySys REST API Driver facilitates efficient data management and extraction from REST APIs, optimizing the integration and analysis of extensive datasets.
For more detailed steps, please refer to this link: How to do REST API Pagination in SSIS / ODBC Drivers
Authentication
ZappySys offers various authentication methods to securely access data from various sources. These authentication methods include OAuth, Basic Authentication, Token-based Authentication, and more, allowing users to connect to a wide range of data sources securely.
ZappySys Authentication is a robust system that facilitates secure access to data from a diverse range of sources. It includes a variety of authentication methods tailored to meet the specific requirements of different data platforms and services. These authentication methods may involve:
OAuth: ZappySys supports OAuth for authentication, which allows users to grant limited access to their data without revealing their credentials. It's commonly used for applications that require access to user account information.
Basic Authentication: This method involves sending a username and password with every request. ZappySys allows users to securely access data using this traditional authentication approach.
Token-based Authentication: ZappySys enables users to utilize tokens for authentication. This method involves exchanging a unique token with each request to authenticate the user's identity without revealing sensitive information.
By implementing these authentication methods, ZappySys ensures the secure and reliable retrieval of data from various sources, providing users with the necessary tools to access and integrate data securely and efficiently. For more comprehensive details on the authentication process, please refer to the official ZappySys documentation or reach out to their support team for further assistance.
For more details, please refer to this link: ZappySys Connections
Conclusion
In this article we showed you how to connect to REST API in Informatica PowerCenter and integrate data without writing complex code — all of this was powered by REST API ODBC Driver.
Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):