You refactor an existing Pega service request to use the DX API. Complete the following prerequisites:
- Identify your framework or use the client UI.
- Add the Customer Service CME ruleset.
Add the CME ruleset to the Customer Service implementation application stack. For more information about CME rulesets, see Adding the appropriate ruleset to your application stack.
- Establish the connection.
Set the endpoints to establish the connection between the UI framework and the Pega instance. In the React Starter Pack, set the endpoints in the endpoints.js file, as shown in the following figure:
- Set the context for the service request.
For an external desktop agent to launch any service request, you set the context for the customer and account. For example, the following figure shows that account number details are passed in a JSON string when the React Starter Pack is used:
- Update authentication and authorization settings.
When using DX API, the api service package uses one of the following types of authentication:
Based on your requirement, update the api service package accordingly.
You can invoke the Pega API REST services by using HTTP or HTTPS. Although secure HTTPS is recommended for test and production environments, if you use an HTTP URL for testing, ensure that you clear the Require TLS/SSL (REST only) checkbox in the service package rule.
Ensure that you include the PegaRULES:PegaAPI ruleset in the operator's access group.
For information about security settings in DX API, see Security settings for DX API. For information about the supported capabilities of the DX API, see Supported UI capabilities.
- Select your design methodology: Parallel flow or Rebuild existing UI.
For more information about case type examples that are shipped out-of-the-box, see Implementing case types using Digital Experience APIs for Pega Customer Service Case Management Edition.