Skip to main content

Pega Digital Experience API

Pega Digital Experience (DX) provides a consistent, branded experience across Channels. Pega Digital Experience (DX) API is a set of model-driven REST API endpoints that enable the ability to view, create, and update Cases and Assignments programmatically. It enables developers to build a custom front-end experience for Pega Platform™ applications without encoding business logic into each Channel.

Pega Platform provides REST APIs that you can use to populate your non-Pega Platform UI. The response APIs include UI elements, layouts, Actions, and styling that differentiate them from the traditional non-DX API. DX APIs are best for web self-service use cases where aligning your UX with your digital strategy is important.

The digital experience APIs are REST APIs that combine Pega Platform UI Rules (harnesses and Sections) with Pega Platform business Rules to return JSON-equivalent structures that you can render with your native interface. For example, customers fill out an application about a vehicle when they purchase a Vehicle. The response API includes all the details of how the application captures this information and mimics it in the rendering UI.

There are two versions of the DX API: Constellation DX API and Traditional DX API. Constellation DX API focuses on View-based authoring; Traditional DX API focuses on Section-based authoring. It lets you manage data views to explore metadata and retrieve specific fields using data view endpoints.

As a Lead System Architect (LSA), ensure that your application is DX API compliant. The compliance ensures that developers build an appropriate front-end component in the UI system of choice and supports the principle of Center-out™ business architecture.

For more information about the Constellation and the Traditional DX APIs, see Pega Digital Experience (DX) API overview.

Security settings for DX API

Constellation DX API always uses OAuth 2.0 as the authentication type, when Pega Platform uses Constellation as the base application to better secure the endpoints. Otherwise, create an authentication service for the Constellation DX API by using a code flow with a Proof Key for Code Exchange (PKCE) enabled to avoid exposing the client secret in the browser. Unlike the Traditional APIs, there is no need to create privileges for the Constellation DX API.

For more information about security settings, see Security Settings for Constellation DX API.

Check your knowledge with the following interaction: 


This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice