Pega Digital Experience (DX) API Version 1 Overview
Pega Digital Experience (DX) API Version 1 (v1) is a set of model-driven REST API endpoints that enable you to programmatically view, create, and update cases and assignments. DX APIs are best used in web self-service use cases where it is important to align your user experience with your digital strategy while continuing to enable your business users to define and modify your application cases and user interface within Pega’s no-code model.
DX APIs provide UI metadata that helps you develop a seamless user experience within your chosen front-end framework, while using the power of Pega’s case management capability. If the custom front end is correctly built by using the DX API responses, it can automatically adjust to changes in Pega Platform. As a result, a single model can supply a interface that is rendered through standard Pega UI, mobile, mashup, or a custom front end.
The difference between a DX API and a traditional API is that the case or assignment UX information in the DX API’s response includes information on UI elements, layout, actions, and styling. DX API leverages Pega’s user interface rules together with Pega’s business rules to return JSON-equivalent structures that you can render with your native interface.
The DX API responses can be used to construct a custom front end. The Angular, Vue, and React starter packs on the Pega marketplace include an interpreter that can automatically process the response and initialize appropriate front-end components in the design system of your choice. The starter packs are packaged with a Pega application but they can be altered to point to your own applications. The code can be used as-is or can be updated to match your coding practices or design system components.
The starter packs can be accessed at the following links:
You can use DX APIs to create cases, display case-related information, and obtain and submit assignments.
The following scenarios are typical use cases for DX API:
- If you have your own user interface and want to display case information using external resources, you can use DX APIs to render the case information within your UI.
- If you do not have your own user interface and perform case processing in the backend, you can call DX APIs to create cases, and retrieve and submit assignments.
For more details about using DX APIs to create cases, see Creating custom screens with the digital experience APIs.