This page provides information about the API authentication process for the following scenario:
Data engineers want to understand the complexities of the CDP REST API to create efficient integrations within the business architecture through self-service integration tools. They also want to develop and execute data integration tasks to enhance autonomy and reduce dependency on specialized technical knowledge.
The following are the ways to achieve this scenario:
To create a user role:
Click Add Instance.
The system displays the Create Instance page.
360 Profiles to pull downstream payloads from CDP to a source system.
Click Save.
The system creates the instance and auto-populates values in the following fields:
Take a backup of these credentials at a secure location as you cannot view them in the system again.
These credentials are used when creating a user role through Postman.
Complete the following tasks to create a user role through Postman for the given scenario:
Click Create Collection.
Click the Ellipsis icon, click Rename, and then rename the folder collection to CDP Authentication.
Postman displays the CDP Authentication collection.
In the CDP Authentication collection, click Add a request.
Change the request to POST
.
In Enter URL or paste text, enter the credentials that you generated while creating a user role through self-service UI.
Ensure the URL matches your cloud region and tenant type as saved earlier.
https://auth.agilone.com/authentication?action=login
.Cloud Region | URL Endpoint | Parameter Description |
---|---|---|
AWS | auth.agilone.com |
|
Postman auto-populates the value on the Params tab.
If you cannot set up variables, delete the sensitive information and re-enter the credentials each time you need, so that you can conduct tests to avoid security risks.
Click the Headers tab.
Add Key as Content-Type and Value as application/json.
Click Save and click Send.
For successful requests, Postman displays Status: 200 OK and access_token.
You can initiate the user authentication step only after creating a token. You can use the token until it expires. You must not resend the request for continued testing with the generated token.
When you use the REST API Authentication mechanism, you perform the request daily to retrieve the token until it expires.
To retrieve a token:
Click the Ellipsis icon and click Duplicate to make a copy of the Step 1 - Authenticate with Username and Password (One Time) authentication request.
Change the request to GET
.
Enter the Authentication mechanism endpoint URL as https://auth.agilone.com/token?scheme=a1user
.
The following are the URL parameters:
Cloud Region | URL Endpoint | Parameter Description |
---|---|---|
AWS | auth.agilone.com |
|
Postman auto-populates the value on the Params tab.
Click Save and click Send.
For successful requests, Postman displays Status: 200 OK and access_token.
Ensure to check the expiration date of the token on a regular cadence through GET request calls. The expires_in
field in the response body indicates the lifespan of the token. By default, tokens last 90 days in Customer Sandbox (CS) and 180 days in UAT and Production (PROD) environments.
The response body consists of the following parameters:
Parameter | Description |
---|---|
access_token | A unique string that serves as a token for accessing protected resources. In this case, "f265e508-c599-44e3-ab60-60a040a9154a" is the token that the API returns. You must include this token in the header of subsequent requests to access authorized resources. |
token_type | The type of token that is issued by the server. In this example, the token type is "bearer" , which means that the bearer of this token has the authorization to access the resources. Bearer tokens are a common method used in OAuth 2.0 for accessing resources. |
expires_in | The lifetime of the access token in seconds. Once this time elapses, the token expires and no longer grants access. In this case, 15600000 seconds means the token has a significant duration before expiration. |
tenantId | The identifier for the tenant or account that you want to access. |
username | The username of the user. In this case, the username is "tracker_XXXXXX" . |
userType | The role or type of the user within the system. "CLIENT" indicates that the user has client-level access. |
passwordExpiryDate | The expiry date of the user's password, necessitating a password change. Postman displays it in ISO 8601 format. For example, "2025-01-06T00:00:00" indicates that the expiry date is January 6, 2025. |
If a token is about to expire, you can extend it for the next 180 days. Acquia recommends you to recycle the token by generating a new token. For more information, see Setting up the Token Create request. You may use the token for up to 1 year or longer as per your company's policies.
To extend the token:
Change the request to POST
.
Enter the Authentication mechanism endpoint URL as https://auth.agilone.com/token?scheme=a1user&action=extend
.
The following are the URL parameters:
Cloud | URL Endpoint | Description |
---|---|---|
AWS | auth.agilone.com |
|
Postman auto-populates the value on the Params tab.
Click the Authorization tab and select the Type as Bearer Token.
Perform Steps 7 and 8 from Setting up the Authentication request.
For successful requests, Postman displays Status: 200 OK and access_token.
Before Extend request:
After Extend request:
Use this procedure only if the existing token is about to expire.
To create a token:
POST.
Enter the Authentication mechanism endpoint URL as https://auth.agilone.com/token?scheme=a1user&action=create
.
The following are the URL parameters:
Cloud | URL Endpoint | Description |
---|---|---|
AWS | auth.agilone.com |
|
Postman auto-populates the value on the Params tab.
Perform Steps 7 and 8 from Setting up the Authentication request.
For successful requests, Postman displays Status: 200 OK and access_token.
To delete a token:
Change the request to DELETE
.
Enter the Authentication mechanism endpoint URL as https://auth.agilone.com/token?scheme=a1user
.
For more information, see the URL Parameter table in Setting up the Token Retrieve request.
Perform Steps 7 and 8 from Setting up the Authentication request.
Postman deletes the token.
To delete all tokens:
DELETE
.¶https://auth.agilone.com/token?scheme=a1user
.¶For more information, see the URL Parameter table in Setting up the Token Retrieve request.
Perform Steps 6 to 8 from Setting up the Authentication request.
Postman deletes all the tokens.
You can use the REST API authentication mechanism to construct upstream and downstream data payload samples for each user role:
Integration Users: Create near real-time, event-based, or batch delta integrations.
Webtag Service Users: Create near real-time front-end for your website using the tracking pixel integration.
360 Profile Users: Retrieve the post processed records that are cleansed, aggregated, and deduped to form unified customer records.
CDP provides the following resources:
A prebuilt library for advanced developers
Import the Postman guide library, which requires the following files:
The Product API Guide: Contains all clouds, environments, user roles, requests, and both upstream and downstream scenarios.
Environments Globals: Contains all prebuilt dynamic variables, enabling you to test across various clouds, environments, and user roles without the need to duplicate folders or requests.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Mon Oct 07 2024 23:42:26 GMT+0000 (Coordinated Universal Time)