Authenticate yourself with JSON Web token authentication to call an API.
Note: When you use JWT authentication to call an API, consider the following:
•The number of items that you can create or modify per API call depends on the cloud provider where the Informatica Intelligent Cloud Services POD is hosted. The following table shows the number of items that you can create or modify per API call on each cloud provider:
Cloud provider
Number of items
Amazon Web Services
30
Microsoft Azure
10
•You can call a maximum of 120 APIs per minute and 10,000 APIs per day.
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 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.
The response generates the session ID and the org ID. Note the value of the sessionId field to include in the subsequent API call.
In Administrator, session ID is specified as the default authentication method. This authentication involves generating a session ID and then using the session ID value to generate the JW token. The organization administrator can switch from session ID-based authentication to JW token-based authentication.
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:
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.
Note: If the administrator configures JW token-based authentication in Administrator, the login API response includes the JW token value in the session ID field.
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
To call a Data Marketplace API, use the following format:
<CDMP_URL><endpoint>
For example, consider the following URL:
https://{{CDMP_URL}}/api/v2/delivery-targets
Here, https://{{CDMP_URL}}/ is the base URL and /api/v2/delivery-targets is the API endpoint.
The base URL varies based on your region. The following table shows the regions and their corresponding base URLs:
If you want to use Application Integration to call a Data Marketplace API, you must use a different base URL. For more information, see Authenticate using Application Integration.
Headers
The following table describes the header request that you should use to send the Data Marketplace API requests:
Header
Description
Content-Type:application/json
This header is required for the POST and PATCH methods. It indicates that the client is sending a JSON request.
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
Optionally, you can use this header for the GET method.