REST API Connector for Informatica

In this article you will learn how to integrate REST API data in Informatica without coding in just a few clicks (live / bi-directional connection to REST API). REST API Connector can be used to extract and output JSON/XML/CSV/String data coming from REST API web service calls (Web URL)..

Using REST API Connector you will be able to connect, read, and write data from within Informatica. Follow the steps below to see how we would accomplish that.

Download  Help File 

NOTE: 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).
How to read API data in Informatica (Call JSON / XML SOAP Service)
How to write data to API (POST) in Informatica (Call JSON / XML SOAP Service)

Read/Write REST API data in Informatica

Introduction

Informatica PowerCenter LogoJSON / 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 JSON data to SQL Table in Informatica (Import REST API / REST API / JSON Files)

    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)

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 (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):
    Open ODBC Data Source

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

    Create new User DSN for REST API

    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

  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[*]
    ZappySys ODBC Driver - Configure JSON Driver
  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ZappySys ODBC Driver - Preview JSON Driver

  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):
    Open ODBC Data Source

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

    Create new User DSN for REST API

    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

  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[*]
    ZappySys ODBC Driver - Configure XML Driver
  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ZappySys ODBC Driver - Preview XML Driver

  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):
    Open ODBC Data Source

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

    ZappySys CSV Driver
    Create new System DSN for REST API
    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. ZappySys ODBC Driver - Configure CSV Driver

    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. ZappySys ODBC Driver - Configure CSV Driver

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

  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 new connection for JSON in Informatica

    Create a new connection for REST API in Informatica

  3. Click New and select ODBC
    Select ODBC connection type in Informatica (Using ZappySys JSON ODBC DSN)

    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 ODBC Driver

    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 JSON Source definition in Informatica Mapping Designer (JSON file or REST API)

    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 JSON Source Table in Informatica Mapping Designer (JSON file or REST API)

    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

    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).

Now lets look at steps to import target table definition in Informatica mapping designer.

  1. In the Mapping Designer, Click on Target Icon to switch to Target designer
  2. From the top menu > Click on Targets > Import from Database
  3. 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).
    Import target Table Definition in informatica

    Import target Table Definition in informatica

  4. Enter your userid , password and Schema name and click Connect to see tables
  5. Select Table name to and click OK import definition.
    Import Target SQL Table Definition in Informatica - Select table from the list

    Import Target SQL Table Definition in Informatica – Select table from the list

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.

  1. First open Mapping Designer (Click [D] icon)
  2. Drag JSON Source from sources folder
  3. Drag SQL Table from Targets folder
  4. Map desired columns from Source to target
    Define Source to Target mapping for JSON to SQL Table load in Informatica

    Define Source to Target mapping for REST API to SQL Table load in Informatica

  5. 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')
    Informatica JSON to SQL Table Mapping - Datatype conversion (nstring to datetime)

    Informatica REST API to SQL Table Mapping – Datatype conversion (nstring to datetime)

  6. Once you done with mapping save your mapping and name it (i.e. m_Api_To_SQL)
  7. 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.

  1. Open workflow designer by click [W] icon.
  2. Launch new workflow creation wizard by click Workflow top menuWizard
    name your workflow (e.g. wf_Api_Tp_Sql_Table_Import)

    Creating Informatica Workflow - Wizard UI (Import JSON data to SQL Table)

    Creating Informatica Workflow – Wizard UI (Import REST API data to SQL Table)

  3. Finish the wizard and double-click the Session to edit some default properties.
  4. First change Error settings so we fail session on error (By default its always green)
    Fail Informatica Session on error (JSON to SQL Load)

    Fail Informatica Session on error (REST API data to SQL Load)

  5. Select JSON connection for Source
    Select JSON Source Connection in Informatica - JSON File / REST API Load to SQL Table

    Select REST API Source Connection in Informatica – Load REST API data to SQL Table

  6. Change default Source query if needed. You can pass parameters to this query to make it dynamic.
    Modify JSON Source SQL query - Pass parameters, change URL, set filter etc

    Modify REST API Source SQL query – Pass parameters, change URL, set filter etc

  7. Select Target connection of SQL Target Table
    Select SQL Target Connection in Informatica - JSON File / REST API Load to SQL Table

    Select SQL Target Connection in Informatica – Load REST API data to SQL Table

  8. Save workflow
  9. 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.

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

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

 

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

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:

  1. 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.

  2. 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.

  3. 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.

  4. 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

ZappySys 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:

  1. 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.

  2. 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.

  3. 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

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Store Procedure

  5. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to REST API in Informatica and integrate data without any coding. Click here to Download REST API Connector for Informatica and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download REST API Connector for Informatica Documentation 


Other App Integration scenarios for REST API

Other Connectors for Informatica


Download REST API Connector for Informatica Documentation 

  • How to connect REST API in Informatica?

  • How to get REST API data in Informatica?

  • How to read REST API data in Informatica?

  • How to load REST API data in Informatica?

  • How to import REST API data in Informatica?

  • How to pull REST API data in Informatica?

  • How to push data to REST API in Informatica?

  • How to write data to REST API in Informatica?

  • How to POST data to REST API in Informatica?

  • Call REST API API in Informatica

  • Consume REST API API in Informatica

  • REST API Informatica Automate

  • REST API Informatica Integration

  • Integration REST API in Informatica

  • Consume real-time REST API data in Informatica

  • Consume realtime REST API API data in Informatica

  • REST API ODBC Driver | ODBC Driver for REST API | ODBC REST API Driver | SSIS REST API Source | SSIS REST API Destination

  • Connect REST API in Informatica

  • Load REST API in Informatica

  • Load REST API data in Informatica

  • Read REST API data in Informatica

  • REST API API Call in Informatica