Pega provides a rich set of REST API to perform various tasks. These APIs are commonly known as Pega Digital Experience (DX) API. But before we can call these APIs, we need to perform some settings in DX API. Without these settings, you will not be able to call the DX API and call will return some errors like - Insufficient Privilege error etc.
In this blog we will talk about these settings in detail
Authentication for DX API
DX API supports three types of authentication, Basic, OAuth and Custom. Based on business requirement you need to setup one of these authentication type. Disabling Authentication will not work with DX API, you at least need to select Basic Authentication type to use DX API.
For example you want to configure the Basic Authentication for Case Creation and Case detail APIs.
Open the REST Service Rule and go to Service Tab.
Scroll to the bottom of Service tab, you will the service package the REST service is part of.
Open the service package rule change authentication type to Basic.
Note - Because authentication setting is configured on Service Package rule, so changes will be applied to all the services which are part of the service package.
Privilege setting
Each DX API end point is secured with a privilege. You can assign a privilege to user for a particular DX API end point or you can assign a role which has all the privileges for all DX API end points. The second way is a kind of giving all API access to a user and it is good for only for testing purpose. In real use case, you can assign privilege based on what a user really needs.
For example if a user just want to create case in Pega through API then just give pxCreateCase privilege to user. The OOTB Pega role which gives all privileges to user is called - PegaRULES:PegaAPI. In this blog we will how how to assign PegaRULES:PegaAPI to a user.
Open Operator ID record.
Open Default Access Group of the operator ID record.
Under the Definition tab of the Operator ID rule, assign role - PegaRULES:PegaAPI and save the operator id record.
Log off and login again to apply the changes to operator Id.
Environment Detail this blog is based on
Pega Version - 8.8
If you like this blog or you want others also read this, then please share this blog. If you want blog on other Pega topic then please do comment below, our team will research and post a blog to help you.
Comments