Accessing a Pega application using the Pega API

Archived

1 Task

10 mins

Visible to: All users

Intermediate

Pega Platform 8.5

Data Integration

English

Scenario

The IT department is adding the ability for users to work on an internal portal. They submitted a requirement to display open positions within TGB to portal users. You have been assigned to test the API calls to the HRApps application.

Use the Pega API landing page to query the data page D_PositionsList to return a list of all open positions.

Note: This exercise does not describe how you build the external application. The goal is to demonstrate the HTTP query needed to access your Pega application and the resulting JSON response.

The following table provides the credentials you need to complete the challenge.

Role	User name	Password
Senior System Architect	SSA@TGB	rules

Note: Your practice environment may support the completion of multiple challenges. As a result, the configuration shown in the challenge walkthrough may not match your environment exactly.

Challenge Walkthrough

Detailed Tasks

1 Access a Pega application using the Pega API

From the Dev Studio header, click the Info icon to open the Resources menu.
From the menu, select Pega API to open the Pega API landing page.

Note:
Pega APIs require TLS/SSL by default to enable secure access through Pega API services. The exercise environment disables TLS/SSL to eliminate the need to use the HTTPS protocol. TLS/SSL should be disabled only for non-production or training purposes.
In the Application category, in the data section, click /data/{ID} to query a data page.
In the Value field, enter D_PositionList to display a list of all open positions.
Click Try it out! to retrieve the data from the data page.
When prompted for credentials, enter the username ssa@tgb and password rules.
Observe the resulting JSON response in the Response Body section of the landing page. Below "pxResults", three positions are displayed as available.