API Reference > Introduction > How to call a Data Marketplace API
  

How to call a Data Marketplace API

To call a Data Marketplace API, you typically use an Application Integration system service action.
What is Application Integration?
Application Integration is an event-driven and service-oriented Informatica Intelligent Cloud Services offering that encompasses event processing, service orchestration, and process management.
How to use Application Integration to call a Data Marketplace API
The following image shows the overall process of using Application Integration to call a Data Marketplace API:
Image depicting the overall process of using Application Integration to call a Data Marketplace API.
To call a Data Marketplace API via Application Integration, perform the following steps:
  1. 1In Application Integration, create an Execute Data Marketplace API type system service action.
  2. 2Invoke the system service action that you created to call the Data Marketplace API.
Note: You require Informatica Processing Units (IPUs) to use Application Integration. For more information about how to calculate your IPU usage, see https://network.informatica.com/docs/DOC-19140.
How can I retrieve the base URL?
In the following URL:
https://{{CDMP_URL}}/api/v1/integration/provisioning/deliveryTemplates?status=ACTIVE
https://{{CDMP_URL}}/ is the base URL and /api/v1/integration/provisioning/deliveryTemplates is the API endpoint.
The base URL varies based on your region. The following table shows the regions and their corresponding base URLs:
Region
Base URL when using Application Integration
Base URL when using JWT authentication
United States of America
https://cdgc-api.dm-us.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-us.informaticacloud.com/data360/marketplace/
United Kingdom
https://cdgc-api.dm-uk.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-uk.informaticacloud.com/data360/marketplace/
Canada
https://cdgc-api.dm-na.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-na.informaticacloud.com/data360/marketplace/
Europe, Middle East, Africa (EMEA)
https://cdgc-api.dm-em.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-em.informaticacloud.com/data360/marketplace/
Asia, Pacific
https://cdgc-api.dm-ap.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-ap.informaticacloud.com/data360/marketplace/
Japan
https://cdgc-api.dm-apne.informaticacloud.com/cdmp-marketplace/
https://idmc-api.dm-apne.informaticacloud.com/data360/marketplace/
Typically, you can call Data Marketplace APIs only via Application Integration. However, you can also utilize JWT authentication to invoke a GET API. For more information, see Using JWT Authentication.

Create a system service action

Before you can call a Data Marketplace API, you must design an Execute Data Marketplace API type system service action in Application Integration.
For more information about how you can design system service action, see the Execute Data Marketplace API topic in the Design help in Application Integration.

Download templates to design a system service action

Informatica provides templates that you can use to design a system service action. For more information, see the Knowledge Base article 000198575.

Start properties

In Application Integration, define the binding type and access details for the system service action that you want to create.
The following table describes how to configure the Start properties for a system service action to call a Data Marketplace API:
Property
Description
Binding
If you want to run the process by using a service URL, select REST/SOAP as the binding type
Allowed Groups
Specify the user groups that should have access to the process service URL at run time.
Allowed Users
Specify the users that should have access to the process service URL at run time.
Allow anonymous access
Ensure that you do not select the Allow anonymous access property.
If you select Allow anonymous access, you cannot call Data Marketplace APIs.
For more information about the Start properties, see the Start Properties topic in the Design help in Application Integration.

Input Field properties

In Application Integration, define the service properties and input properties for the system service action that you want to create.
The following table describes how to configure the Service properties for a system service action to call a Data Marketplace API:
Property
Description
Service Type
Select System Service as the service type.
Action
Select Execute Data Marketplace API as the action.
The following table describes how to configure the Input Field properties for a system service action to call a Data Marketplace API:
Property
Description
HTTP Method
Enter one of the following methods to invoke the Data Marketplace API:
  • - GET
  • - PUT
  • - PATCH
  • - POST
Relative Path
Enter the relative path of the API that you want to invoke.
You can use an API endpoint to discover the relative path. Consider the following examples:
  • - For the API endpoint /api/v1/integration/categories, the relative path is categories.
  • - For the API endpoint /api/v1/integration/provisioning/deliveryFormats, the relative path is provisioning/deliveryFormats.
  • - For the API endpoint /api/v1/integration/orders/<orderId>/fulfill, the relative path is orders/<orderId>/fulfill.
Query parameter
If the Data Marketplace API that you want to invoke requires you to specify query parameters, you can enter the query parameters in XML format.
The following example shows how you must enter the query parameters:

<DataMarketplaceQueryParameters>
<queryParams>
<name>deliveryTargetId</name>
<value>6ddc722a-a4e3-4738-8880-913af86204b2</value>
</queryParams>
<queryParams>
<name>comment</name>
<value><p>Fulfilled</p></value>
</queryParams>
</DataMarketplaceQueryParameters>
Path variables
If the Data Marketplace API that you want to invoke requires you to specify path variables, you can enter the path variables in XML format.
The following example shows how you must enter the path variables:

<DataMarketplacePathVariables>
<pathVariables>
<name>orderId</name>
<value>6ddc722a-a4e3-4738-8880-913af86204b2</value>
</pathVariables>
</DataMarketplacePathVariables>
Payload
If an API call requires a payload, enter the payload information within single quotations.
The following example shows how you must enter the payload information for an API call:

‘{
"items": [
{
"refId": "3d0af52d-4ed1-44e2-9e09-ea9e3a77baaa",
"name": "CreateUsageContext1",
"description": "desc",
"status": "ACTIVE"
},
{
"refId": "3d0-jsnbj-52d-4ed1-44e2-9e09-ea9e3a77a",
"name": "CreateUsageContext2",
"description": "desc",
"status": "INACTIVE"
}
]
}’
For more information about the Input Field properties, see the Input Field Properties topic in the Design help in Application Integration.

Output Field properties

In the Start step of a new process in Application Integration, you can define the properties of the output fields.
The following table describes how to configure the Output Field properties for a system service action to call a Data Marketplace API:
Property
Description
Output Format
Specify whether you want the output field to represent one or more fields of the response, or the entire contents of the response.
Select on of the following output formats:
  • - If you want the output field to represent one or more fields of the response, select the Fields output format.
  • - If you want the output field to represent the entire contents of the response, select the Whole Payload output format.
To call a Data Marketplace, Informatica recommends that you select the Fields output format.
Name
Enter the name of the output field.
Type
Specify the type of the output field.
Select on of the following field types:
  • - Date
  • - Date Time
  • - Time
  • - Integer
  • - Text
If the preceding types don't meet your requirements, select the More types option to reveal additional field types. In the Edit Type dialog box, you can select a field type that is listed under one of the following category:
  • - Simple Types
  • - Custom Types
  • - Connection defined Types
Description
Enter the description for the output field.
Initial Value
Enter the initial value for the output field.
For more information about the Output Field properties, see the Output Field Properties topic in the Design help in Application Integration.
Before you can configure the API response in an Assignment step or a Decision step, ensure that you have defined the output field properties of the process in the Start step. For more information about an Assignment step or a Decision step, see Adding Process Steps topic in the Design help in Application Integration.

Invoke a system service action

To make a REST API call, invoke the Execute Data Marketplace API system service action that you designed for the Data Marketplace API.
For more information, see the Invoke help in Application Integration.

Using JWT Authentication

You can authenticate yourself with JSON Web token authentication to invoke an API that utilizes the GET method. This allows you to invoke a GET API without using Application Integration.

Authentication

Before you make REST API calls, you must authenticate yourself with JWT authentication. First, use the Login API with your organization user name and password to receive the session ID and org ID. Then, use the session ID and org ID to generate a JSON Web (JW) token. Subsequently, you use the session ID and JW token to secure your API calls without having to authenticate yourself for each call.

Obtain the session ID

To get a session ID, use the Login API V1. The Login API is also available with SAML. For more information about logging in using SAML, see the REST API Reference in the Administrator help. Ensure that you have your Informatica Intelligent Cloud Services user name and password.
Send the POST request with the following URI, header, and request body:
URI
<LoginURL>/identity-service/api/v1/Login
Note that <LoginURL> is the Informatica Intelligent Cloud Services login URL based on the region, such as https://dm-us.informaticacloud.com, https://dm-em.informaticacloud.com, https://dm-ap.informaticacloud.com, https://dm-uk.informaticacloud.com, and so on.
Header
Content-Type: application/json
Request Body
{
"username": "<your_IICS_user>",
"password": "<your_IICS_password>",
}
The response generates the session ID and the org ID. Note the value of the sessionId field to include in the subsequent API call.

Generate a JW Access Token

Use the value from the sessionId field that you obtained from the previous Login API response, and send the POST request with the following URL and headers to generate a JW access token:
URI
<LoginURL>/identity-service/api/v1/jwt/Token?client_id=idmc_api&nonce=1234
Note that <LoginURL> is the Informatica Intelligent Cloud Services login URL based on the region, such as https://dm-us.informaticacloud.com, https://dm-em.informaticacloud.com, https://dm-ap.informaticacloud.com, https://dm-uk.informaticacloud.com, and so on.
Headers
IDS-SESSION-ID: <sessionId value>
The response generates the JW access token that you include in the authorization header for all subsequent API calls. The access token expires after 30 minutes from the initial grant of the token. You must regenerate the access token after every 30 minutes to authenticate your API calls.

Send Requests

When you make an API call in the REST client, the request is sent in JSON format. Depending on the request, the REST client receives a response in JSON format that contains the information for the request that was sent.
To make an API call, enter the URL to access the API, header requests, methods, and request parameters.

URL

Here's the URL structure for requests:
<CDMP_URL><endpoint>
For more information about how you can retrieve the applicable CDMP_URL, see How to call a Data Marketplace API.

Headers

The following table describes the header request that you should use to send the Data Marketplace API requests:
Header
Description
Authorization:Bearer <jwt_token>
This header is required to secure all your API requests.
X-INFA-ORG-ID:<Org ID>
Indicates the user's organization to which the API requests is sent.
The org ID is obtained from the Login API.
IDS-SESSION-ID
This header is required for the GET method..