Getting Started with Cloud Data Profiling REST API

Getting Started with Cloud Data Profiling REST API

Log in to Informatica Intelligent Cloud Services

Log in to Informatica Intelligent Cloud Services

You can log in to Informatica Intelligent Cloud Services using the platform REST API version 2 or version 3 login resource. The version of any subsequent resource that you use does not need to match the version of the login resource that you use to log in.
You can use the v2 resource to log in to the organization using your Informatica Intelligent Cloud Services user account.
POST request
To log in using version 2 of the Informatica Intelligent Cloud Services API, use the following URL:
https://dm-{POD_region}.informaticacloud.com/ma/api/v2/user/login.
Before you make REST API calls, you must authenticate yourself with your username and password.
Enter the following parameters in the REST API client to connect to the Data Profiling host and receive a session ID and Server URL:
Property
Value
URL
Enter a URL to log in to Informatica Intelligent Cloud Services. Use the following format: https://dm-us.informaticacloud.com/ma/api/v2/user/login
Method
POST
username
Data Profiling username. For example,
Jsmith
password
Data Profiling password. For example,
YourPassword@123
The following image displays a sample login section:
A sample User Login API image is displayed with parameters, request and response sections.
POST response
The login response includes the session ID and base URL that you need to include in subsequent REST API calls.
After you enter the login parameter values and make the API call, the response includes the following information that you need to include in the header of subsequent REST API calls:
  • serverUrl
    . The base URL that you use in all version 2 resource URIs except for login, for example: /api/v2/job
  • icSessionId
    . A REST API session ID that you include in the header for version 2 REST API calls. The session ID expires after 30 minutes of inactivity. If the session ID expires, log in again to continue working with the REST API. For information on retrieving session status details, see Session IDs.
The following image displays the
serverUrl
and
icSessionId
:
An image is displayed where the serverUrl and the icSessionId are highlighted in the API response.
Submit URL Parameter
Modify the URL and pass the URL to all the APIs.
  1. Copy the "serverUrl" from your login response as shown in the following image:
    An image is displayed with a serverUrl selected in the API response.
  2. Modify the URL to include "dqprofile" in the URL and exclude "https://" and "/saas" from the URL. For example, if the login response is "https://usw3.dm-us.informaticacloud.com/saas", modify "use3.dm-us.informaticacloud.com" to "use3-
    dqprofile
    .dm-us.informaticacloud.com"
  3. Paste the modified URL in the text box as shown in the following image:
    Submit URL Parameter API is shown with a red highlight on the modified URL.
  4. Click
    Submit
    to pass the parameter to all the Profiling APIs.
If you do not use the Developer Portal to submit the Server URL, use the Server URL as the prefix in the API calls in the third-party API portals.

0 COMMENTS

We’d like to hear from you!