Informatica Cloud (Version Winter 2016)

REST API Connector Guide

Informatica Cloud REST API Connector Guide

Version Winter 2016

March 2016

Copyright (c) 1993-2016 Informatica LLC. All rights reserved.

This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use
and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in
any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. This Software may be protected by U.S.
and/or international Patents and other Patents Pending.

Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as
provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013©(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14
(ALT III), as applicable.

The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us
in writing.
Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange,
PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica
On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and
Informatica Master Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world.
All other company and product names may be trade names or trademarks of their respective owners.

Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights
reserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rights
reserved.Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © Meta
Integration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems
Incorporated. All rights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All
rights reserved. Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights
reserved. Copyright © Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights
reserved. Copyright © Information Builders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved.
Copyright Cleo Communications, Inc. All rights reserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ej-
technologies GmbH. All rights reserved. Copyright © Jaspersoft Corporation. All rights reserved. Copyright © International Business Machines Corporation. All rights
reserved. Copyright © yWorks GmbH. All rights reserved. Copyright © Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved.
Copyright © Daniel Veillard. All rights reserved. Copyright © Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright © MicroQuill Software Publishing, Inc. All
rights reserved. Copyright © PassMark Software Pty Ltd. All rights reserved. Copyright © LogiXML, Inc. All rights reserved. Copyright © 2003-2010 Lorenzi Davide, All
rights reserved. Copyright © Red Hat, Inc. All rights reserved. Copyright © The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright
© EMC Corporation. All rights reserved. Copyright © Flexera Software. All rights reserved. Copyright © Jinfonet Software. All rights reserved. Copyright © Apple Inc. All
rights reserved. Copyright © Telerik Inc. All rights reserved. Copyright © BEA Systems. All rights reserved. Copyright © PDFlib GmbH. All rights reserved. Copyright ©
Orientation in Objects GmbH. All rights reserved. Copyright © Tanuki Software, Ltd. All rights reserved. Copyright © Ricebridge. All rights reserved. Copyright © Sencha,
Inc. All rights reserved. Copyright © Scalable Systems, Inc. All rights reserved. Copyright © jQWidgets. All rights reserved.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and/or other software which is licensed under various versions
of the Apache License (the "License"). You may obtain a copy of these Licenses at http://www.apache.org/licenses/. Unless required by applicable law or agreed to in
writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.

This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software
copyright © 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License
Agreement, which may be found at http:// www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any
kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.

The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California,
Irvine, and Vanderbilt University, Copyright (©) 1993-2006, all rights reserved.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and
redistribution of this software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html.

This product includes Curl software which is Copyright 1996-2013, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this
software are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or
without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

The product includes software copyright 2001-2005 (©) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms
available at http://www.dom4j.org/ license.html.

The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to
terms available at http://dojotoolkit.org/license.

This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations
regarding this software are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html.

This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at
http:// www.gnu.org/software/ kawa/Software-License.html.

This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & Wireless
Deutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.

This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are
subject to terms available at http:/ /www.boost.org/LICENSE_1_0.txt.

This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at
http:// www.pcre.org/license.txt.

This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms
available at http:// www.eclipse.org/org/documents/epl-v10.php and at http://www.eclipse.org/org/documents/edl-v10.php.

This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http://
www.stlport.org/doc/ license.html, http://asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html, http://
httpunit.sourceforge.net/doc/ license.html, http://jung.sourceforge.net/license.txt , http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/
license.html, http://www.libssh2.org, http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/license-
agreements/fuse-message-broker-v-5-3- license-agreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html;
http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt; http://jotm.objectweb.org/bsd_license.html; . http://www.w3.org/Consortium/Legal/
2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http://
forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http://
www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, http://www.slf4j.org/license.html; http://www.iodbc.org/dataspace/iodbc/wiki/iODBC/License; http://
www.keplerproject.org/md5/license.html; http://www.toedter.com/en/jcalendar/license.html; http://www.edankert.com/bounce/index.html; http://www.net-snmp.org/about/
license.html; http://www.openmdx.org/#FAQ; http://www.php.net/license/3_01.txt; http://srp.stanford.edu/license.txt; http://www.schneier.com/blowfish.html; http://
www.jmock.org/license.html; http://xsom.java.net; http://benalman.com/about/license/; https://github.com/CreateJS/EaselJS/blob/master/src/easeljs/display/Bitmap.js;
http://www.h2database.com/html/license.html#summary; http://jsoncpp.sourceforge.net/LICENSE; http://jdbc.postgresql.org/license.html; http://
protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; https://github.com/rantav/hector/blob/master/LICENSE; http://web.mit.edu/Kerberos/krb5-
current/doc/mitK5license.html; http://jibx.sourceforge.net/jibx-license.html; https://github.com/lyokato/libgeohash/blob/master/LICENSE; https://github.com/hjiang/jsonxx/
blob/master/LICENSE; https://code.google.com/p/lz4/; https://github.com/jedisct1/libsodium/blob/master/LICENSE; http://one-jar.sourceforge.net/index.php?
page=documents&file=license; https://github.com/EsotericSoftware/kryo/blob/master/license.txt; http://www.scala-lang.org/license.html; https://github.com/tinkerpop/
blueprints/blob/master/LICENSE.txt; and http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html.

This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and Distribution
License (http://www.opensource.org/licenses/cddl1.php) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code License
Agreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php), the new BSD License (http://opensource.org/
licenses/BSD-3-Clause), the MIT License (http://www.opensource.org/licenses/mit-license.php), the Artistic License (http://www.opensource.org/licenses/artistic-
license-1.0) and the Initial Developer’s Public License Version 1.0 (http://www.firebirdsql.org/en/initial-developer-s-public-license-version-1-0/).

This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this
software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab.
For further information please visit http://www.extreme.indiana.edu/.

This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject
to terms of the MIT license.

This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775;
6,640,226; 6,789,096; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,243,110; 7,254,590; 7,281,001; 7,421,458; 7,496,588; 7,523,121; 7,584,422;
7,676,516; 7,720,842; 7,721,270; 7,774,791; 8,065,266; 8,150,803; 8,166,048; 8,166,071; 8,200,622; 8,224,873; 8,271,477; 8,327,419; 8,386,435; 8,392,460;
8,453,159; 8,458,230; 8,707,336; 8,886,617 and RE44,478, International Patents and other Patents Pending.

DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the
implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is
error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and
documentation is subject to change at any time without notice.

NOTICES

This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software
Corporation ("DataDirect") which are subject to the following terms and conditions:

1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT
INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT
LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.

Part Number: IC-RAG-24000-0001

Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Cloud Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Cloud Communities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Cloud Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Cloud Connector Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Cloud Trust Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 1: Introduction to REST API Connector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

REST API Connector Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
REST API Connector Task Operation and Object Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Administration of ReST API Connector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2: REST API Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

REST API Connections Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
REST API Connection Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Creating a REST API Connection (Source connector). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Creating a ReST Connection (Target connector). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 3: Data Synchronization Tasks with REST API. . . . . . . . . . . . . . . . . . . . . . . . 14

REST API Sources in Data Synchronization Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
REST API Source Data Synchronization Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
REST API Targets in Data Synchronization Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
REST API Target Data Synchronization Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 4: Custom Authentication for REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Implementing the Java Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Deploying the CusthomAuth JAR File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Retaining the CustomAuth File after Secure Agent Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 5: Proxy Feature for Rest Connector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Proxy Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4 Table of Contents
Preface
The Informatica Cloud REST API Connector Guide contains information about how to set up and use REST
API Connector. The guide explains how organization administrators and business users can use REST API
Connector to read data from and write data to a REST API.

Informatica Resources

Informatica Documentation
The Informatica Documentation team makes every effort to create accurate, usable documentation. If you
have questions, comments, or ideas about this documentation, contact the Informatica Documentation team
through email at [email protected]. We will use your feedback to improve our
documentation. Let us know if we can contact you regarding your comments.

The Documentation team updates documentation as needed. To get the latest documentation for your
product, navigate to Product Documentation from http://mysupport.informatica.com.

Informatica Web Site

You can access the Informatica corporate web site at http://www.informatica.com. The site contains
information about Informatica, its background, upcoming events, and sales offices. You will also find product
and partner information. The services area of the site includes important information about technical support,
training and education, and implementation services.

Informatica Cloud Web Site

You can access the Informatica Cloud web site at http://www.informaticacloud.com. This site contains
information about Informatica Cloud editions and applications. It also provides information about partners,
customers, and upcoming events.

Informatica Cloud Communities

Use the Informatica Cloud Community to discuss and resolve technical issues in Informatica Cloud. You can
also find technical tips, documentation updates, and answers to frequently asked questions.

Access the Informatica Cloud Community at:

http://www.informaticacloud.com/community

Developers can learn more and share tips at the Cloud Developer community:

5
 http://www.informaticacloud.com/devcomm

Informatica Cloud Marketplace

Visit the Informatica Marketplace to try and buy Informatica Cloud Connectors, Informatica Cloud integration
templates, and Data Quality mapplets.

Cloud Connectors Mall:

https://community.informatica.com/community/marketplace/informatica_cloud_mall

Cloud Integration Templates Mall:

https://community.informatica.com/community/marketplace/cloud_integration_templates_mall

Data Quality Solution Blocks:

https://community.informatica.com/solutions/cloud_data_quality_crm_plugin

Informatica Cloud Connector Documentation

You can access documentation for Informatica Cloud Connectors at the Informatica Cloud Community:
https://community.informatica.com/docs/DOC-2687.

Informatica Knowledge Base

As an Informatica customer, you can access the Informatica Knowledge Base at
http://mysupport.informatica.com. Use the Knowledge Base to search for documented solutions to known
technical issues about Informatica products. You can also find answers to frequently asked questions,
technical white papers, and technical tips. If you have questions, comments, or ideas about the Knowledge
Base, contact the Informatica Knowledge Base team through email at [email protected].

Informatica Cloud Trust Site

You can access the Informatica Cloud trust site at http://trust.informaticacloud.com. This site provides real
time information about Informatica Cloud system availability, current and historical data about system
performance, and details about Informatica Cloud security policies.

Informatica Global Customer Support

You can contact a Customer Support Center by telephone or online.

For online support, click Submit Support Request in the Informatica Cloud application. You can also use
Online Support to log a case. Online Support requires a login. You can request a login at
https://mysupport.informatica.com.

The telephone numbers for Informatica Global Customer Support are available from the Informatica web site
at http://www.informatica.com/us/services-and-training/support-services/global-support-centers/.

6 Preface
CHAPTER 1

Introduction to REST API

Connector
This chapter includes the following topics:

• REST API Connector Overview, 7

• REST API Connector Task Operation and Object Types, 8
• Administration of ReST API Connector, 8

REST API Connector Overview

Use REST API Connector to integrate data with REST based web services applications that are either
internal to an organization or external applications.

Use REST API Connector to read data from REST APIs and integrate data with other applications,
databases, and flat files. You can also read data from REST APIs or other applications, transform the data,
and write data to a REST API. You can use REST API objects as sources and targets in Data
Synchronization tasks, mappings, and Mapping Configuration tasks.

The REST API Connector supports Web Services that conform to REST methods.

REST API Connector supports following Media-Type:

• application/xml
• application/json

REST API Connector supports following Request-Type:

• GET
• POST
• PUT
• DELETE

REST API Connector supports following Authentication-Type:

• NO_AUTH
• BASIC_AUTH
• DIGEST_AUTH
• OAUTH

7
 • CUSTOM_AUTH

REST API Connector Task Operation and Object

Types
The following table lists the objects and task operations that REST API Connector supports:

Objects Read Insert Update Upsert Delete Data Preview Lookup

ReST Entity Yes Yes No No No Yes No

Administration of ReST API Connector

• You need REST API access that is user credentials to create a REST Connection in the Informatica
Cloud.
• Provide the base url request and authentication parameters to create a connection.
• Mention Auth Type and Media Type.

8 Chapter 1: Introduction to REST API Connector

CHAPTER 2

REST API Connections

This chapter includes the following topics:

• REST API Connections Overview, 9

• REST API Connection Properties, 9
• Creating a REST API Connection (Source connector), 11
• Creating a ReST Connection (Target connector), 12

REST API Connections Overview

Create a REST API connection to connect to REST API so that the Secure Agent can read data from and
write data to a REST API. You can specify the REST API source and target in mappings, Mapping
Configuration tasks, or Data Synchronization tasks.

You create a REST API connection on the Connections page. Use the connection when you create a Data
Synchronization task or a Mapping Configuration task.

REST API Connection Properties

When you set up a REST API connection, you must configure the connection properties.

The following table describes the REST API connection properties:

Connection Property Description

Connection Name Name of the REST API connection. Enter a unique name for the connection.

Description Description of the connection. The description cannot exceed 765 characters.

Type Type of connection. Select REST from the list

Runtime Environment The name of the runtime environment where you want to run the tasks.

Base URL Endpoint url of ReST (without the Query parameters)

Is Base Url Dynamic Select the checkbox if the base url for each request is different and dynamic.

9
 Connection Property Description

Url Request Parameters Mention the request that is url query parameters.
Parameters separated by semicolon (;).
The Property and value is separated by ‘equals’ (=).

Form Request Parameters Mention the request that is form query parameters.
Parameters separated by semi-colon (;).
The Property and value is separated by ‘equals’ (=).

Header Request Parameters Mention the request that is Header query parameters.
Parameters separated by semi-colon(;).
The Property and value is separated by ‘equals’ (=).

Media Type Select required media type from the list.

HTTP Mime Type is supported.

Request Type Select the required Request Type from the list.
HTTP Request type.

Authentication Type Select the required authentication type such as Basic, Digest or OAuth.

Auth UserId Mention the UserId for Basic and Form based authentication.

Auth Password Provide the password for Basic and Form based authentication.

OAuth Consumer Key Provide the Consumer key for OAuth authentication.

OAuth Consumer Secret Provide the Consumer secret for OAuth authentication

OAuth Token Mention the token key for OAuth authentication

OAuth Token Secret Mention the Token Secret for OAuth authentication

Additional Custom OAuth Provide additional Custom Auth parameter.

Parameters

Sample Response XML or Provide full file path of the xml.

JSON File Path You can also mention the xml or JSON path of the Response.

Response Folder Path Mention the folder path (in secure agent machine) where you want to generate
the response file.

Url Input Parameters Config Mention The URL Input Parameter File name with the path.
File Name

Form Input Parameters Config Mention the Form Input Parameter File name with Path.
File Name

Header Input Parameters Mention the Header Input Parameter File name with Path.
Config File Name

Create the config csv file Select Yes and then click Test for testing the connection.
After successfully testing the connection, select No.

10 Chapter 2: REST API Connections

Creating a REST API Connection (Source connector)
To use REST API connector as the source in a data synchronization task, you must create a connection in
Informatica Cloud.

1. On the Informatica Cloud home page, click Configure > Connections.

2. Click New to create a connection.
The New Connection page appears.
3. Specify the following details:

Connection Property Description

Connection Name Enter a unique name for the connection.

Description Provide a relevant description for the connection.

Type Select REST from the list.

Secure Agent Select the appropriate secure agent from the list.

Base URL Enter End point URL. For example,

https://<End point URL>/

Is Base Url Dynamic NA

Url Request Parameters NA

Form Request Parameters NA

Header Request Parameters Enter login credentials in the following format:

- tenanted=<ID>
- username=<username>
- password=<password>
- encoding=UTF-16 or UTF-8

Media Type Select JSON

Request Type Select POST

Authentication Type NA

Auth UserId NA

Auth Password NA

OAuth Consumer Key NA

OAuth Consumer Secret NA

OAuth Token NA

OAuth Token Secret NA

Creating a REST API Connection (Source connector) 11

 Connection Property Description

Additional Custom OAuth Parameters Enter additional custom OAUTH Parameters.

Config File or Private Key File Name NA

Sample Response XML or JSON File NA

Path

Response Folder Path Enter the folder path where you want to generate the signature
file.

Url Input Parameters Config File Name NA

Form Input Parameters Config File Name NA

Header Input Parameters Config File Enter the folder path which contains the header input
Name parameters config file with file name.
Note: Use the config file to modify the user credentials.

Create the config csv file Select Yes and then click Test for testing the connection.
After successfully testing the connection, select No.

Note: The Url request parameter, Form request parameter, and Header request parameter key must not
contain Semicolon (;) and parameter value must not contain equals (=) sign.
4. Click Ok to save the connection.

Creating a ReST Connection (Target connector)

You must create a connection in Informatica Cloud to use REST API Connector as target in data
synchronization task.

1. In Informatica Cloud home page, click Configure > Connections.

2. Click New to create a connection.
The New Connection page appears.
3. Specify the following details:

Connection Property Description

Connection Name Enter a unique name for the connection.

Description Provide a relevant description for the connection.

Type Select ReST from the list.

Secure Agent Select the appropriate secure agent from the list.

12 Chapter 2: REST API Connections

 Connection Property Description

Base URL Enter End point URL in the following format:

https://< End point URL>/

Is Base Url Dynamic NA

Url Request Parameters NA

Form Request Parameters Select JSON

Header Request Parameters Select POST

Media Type NA

Request Type NA

Authentication Type NA

Auth UserId NA

Auth Password NA

OAuth Consumer Key NA

OAuth Consumer Secret NA

OAuth Token Enter the file path generated in the DSS task.

OAuth Token Secret NA

Additional Custom Auth Parameters Enter Additional custom OAUTH Parameters.

Sample Response XML or JSON File Path NA

Response Folder Path Enter the folder path where you want to generate the
signature file.

Url Input Parameters Config File Name NA

Form Input Parameters Config File Name NA

Header Input Parameters Config File Name NA

Create the config csv file Select Yes and click Test for testing the connection.
After successfully testing the connection, select No.

Note: The Url, Form, and Header request parameter key must not contain a semicolon (;) and parameter
value must not contain equals (=) sign.
4. Click Ok to save the connection.

Creating a ReST Connection (Target connector) 13

CHAPTER 3

Data Synchronization Tasks with

REST API
This chapter includes the following topics:

• REST API Sources in Data Synchronization Tasks, 14

• REST API Targets in Data Synchronization Tasks, 15

REST API Sources in Data Synchronization Tasks

You can use a REST API object as a single source in a Data Synchronization task.

You configure REST API source properties on the Source page of the Data Synchronization Task wizard.

The following table describes the REST API source properties:

Property Description

Connection Name of the source connection.

Source Type Select Single.

Source Object Name of the source object.

REST API Source Data Synchronization Example

Let us consider the task operation Insert to generate token to run the Data synchronization task.

1. In Informatica Cloud home page, click Task Wizard > Data SynchronizationApps.
The Data Synchronization page appears.
2. Click New to create a data synchronization task.
The Definition tab appears.
3. Specify the Task Name, provide a Description and select the Task Operation Insert.
4. Click Next.
The Source tab appears.
5. Select the source Connection, Source Type and Source Object required for the task.

14
 6. Click Next.
The Target tab appears.
7. Select the target Connection and Target Object required for the task.

8. Click Next.
9. On the Data Filters tab by default, Process all rows is chosen. Assign filters to fetch specific data.
10. Click Next.
11. In Field Mapping tab, map source fields to target fields accordingly.

12. Click Next.

The Schedule tab appears.
13. Click Save and Run If you do not want to schedule the task.
14. Click Ok to save the connection.

REST API Targets in Data Synchronization Tasks

When you run a Data Synchronization task, specify the operation and the source that you want the Secure
Agent to write to the target. The Secure Agent inserts, updates, upserts, or deletes source rows that you
specify into the target based on the configured operation for the target object.

The task operations depend on the target object that you select. You can configure the target properties
when you schedule the Data Synchronization task. You configure REST API target properties on the Target
page of the Data Synchronization Task wizard. Provide the name of the target connection and specify the
target object to write data to REST API.

REST API Targets in Data Synchronization Tasks 15

 REST API Target Data Synchronization Example
Creating a ReST Data Synchronization Task to integrate with User’s end point System

Let us consider the task operation Insert to perform the Data synchronization task.

1. On the Informatica Cloud home page, click Task Wizard > Data SynchronizationApps.
The Data Synchronization page appears.
2. Click New to create a data synchronization task.
The Definition tab appears.
3. Specify the Task Name, provide a Description and select the Task Operation Insert.
4. Click Next.
The Source tab appears.
5. Select the source Connection, Source Type and Source Object required for the task.
6. Click Next.
The Target tab appears.
7. Select the target Connection and Target Object required for the task.

8. Click Next.
9. On the Data Filters tab by default, Process all rows is chosen.
10. Click Next.
11. On the Field Mapping tab, map source fields to target fields accordingly.
12. Click Next.
13. The Schedule tab appears.
14. Click Save and Run If you do not want to schedule the task.

16 Chapter 3: Data Synchronization Tasks with REST API

CHAPTER 4

Custom Authentication for REST

API
This chapter includes the following topics:

• Overview, 17
• Implementing the Java Template, 18
• Deploying the CusthomAuth JAR File, 18
• Retaining the CustomAuth File after Secure Agent Upgrade, 18

Overview
You can use other authentication types at the REST API endpoint and server, such as OAuth, Basic, Digest,
and other custom authentication.

To implement your own authentication logic use the Custom Authentication function. You can also use the
pre-defined java template to implement your authentication logic.

The java template consists of a method, an Inner Class and an Enum.

Method
Method signature is: String GetCustomAuthParams(RequestInfo,Ilogger)

RequestInfo
A bean class that captures all the connection UI parameters.

Inner Class
CustomParams is the inner class. The return value is always a vector of CustomParams Objects.

Enum
Defines the types of parameter present in Custom Authentication. enumParamType is the enum in the
template.

Note: If you want Informatica to create the custom authentication for you, then contact Sales team or
Informatica Cloud API Response Team or Customer Service.

17
Implementing the Java Template
You need to implement the CustomAuth.java file to customize an authentication type.

1. Include new Form, Url or Header parameters.

2. Implement the GetCustomAuthParams() method with the following method signature: String response
GetCustomAuthParams(RequestInfo,Ilogger)
3. Define custom parameters for the inner class.
4. Set all the bean method values to use the Custom Parameter.

Deploying the CusthomAuth JAR File

You need to deploy the CustomAuth JAR File to customize an authentication type.

1. Create a copy of the CustomAuth.java file.

2. Name the file in the following format: CustomAuth_<UserCompanyName/EndpointName >.jar
3. Stop the Informatica Cloud Secure Agent Service.
4. Copy the created jar file in the following Informatica Secure Agent paths:
• C:\Program Files\Informatica Cloud Secure Agent\main\bin\rdtm\javalib\<Plugin-Id>
• C:\Program Files\Informatica Cloud Secure Agent\main\tomcat\plugins\<Plugin-Id>

Retaining the CustomAuth File after Secure Agent

Upgrade
During the secure agent upgrade the CustomAuth file gets deleted from the secure agent. In case you want
to use the CustomAuth Feature, you must do the following:

1. Before the upgrade, copy the file in the informatica Secure Agent rdtm folder. The sample folder path is
C:\Program Files (x86)\Informatica Cloud Secure Agent\main\bin\rdtm\javalib\PluginID
2. Test the Rest Connection
3. After you test the connection, the connector copies the file in the extra folder. The sample path of this
location is C:\Program Files (x86)\Informatica Cloud Secure Agent\main\bin\rdtm-extra
\510600
4. After the upgrade the File is deleted from the C:\Program Files (x86)\Informatica Cloud Secure
Agent\main\bin\rdtm\javalib\PluginID location, Now the connector by itself takes loads the file
from the extra RDTM folder i.e C:\Program Files (x86)\Informatica Cloud Secure Agent\main
\bin\rdtm-extra\510600

18 Chapter 4: Custom Authentication for REST API

The figure given below displays the code discussed the section.

Retaining the CustomAuth File after Secure Agent Upgrade 19

CHAPTER 5

Proxy Feature for Rest Connector

This chapter includes the following topic:

• Proxy Feature, 20

Proxy Feature
Unlike other connectors which allows agent level proxy setting, you can enable or disable proxy for REST API
Connector irrespective of the Secure Agent proxy.

Use the proxySettings.ini in the Secure Agent directory to change the proxy settings. You need to set the
value of setProxy attribute to either true or false to enable or disable the proxy.

The following figure shows an example of proxysettings.ini file.

20
Index

C Informatica Cloud web site

URL 5
Cloud Developer community Informatica Global Customer Support
URL 5 contact information 6

I T
Informatica Cloud Community trust site
URL 5 description 6

21