Integrating with Pega APIs and services
You can use the Pega APIs to power client and mobile apps by using built-in Pega REST/JSON services. Pega APIs provide an extensive set of APIs to manage and interact with all aspects of your application, such as cases, assignments, and so on. The APIs are secured by user credentials and TLS/SSL. You must switch from App Studio to Dev Studio to configure security for the Pega API, which is the api service package.
To browse the Pega API, you must have the PegaRULES:PegaAPI role. In addition, some APIs require your access role to have specific privileges before you can use the API.
You can browse Pega APIs from Admin Studio, Dev Studio, and App Studio:
- In Admin Studio, click .
- In Dev Studio, click .
- In App Studio, click .
In the API, you can perform the following actions:
You can view detailed information about APIs by using the API channel. In the APIs, you can perform the following actions:
- List parameters
- View the JSON data model for each resource
- Test an API by clicking Try it out! to view the actual request URL, response body, response code, and response headers
- Pega API services
You can call any of the Pega API services by using standard HTTP methods (for example: GET, POST, or PUT). For detailed information about request and response data requirements, see the Pega API resources page in Dev Studio or Admin Studio. This documentation is also available in JSON format in the Docs API (GET/docs).
- Using the Pega API
Review the following topics to learn how to use the Pega API for your business needs.
- Service Packages
Use a Service Package data instance to define a package name, define access for listeners, and support deployment of services.
- Service REST rules
Representational State Transfer Protocol (REST) applications use HTTP instead of the more complex SOAP protocol to make calls between machines. The REST integration interface in the Pega Platform supports interactions with external systems through Web services.
- OpenAPI tab
Use the OpenAPI tab to view the auto-generated OpenAPI Specification (OAS) documentation that describes the REST services that are included in your service package. The OpenAPI tab displays the REST services in YAML and Swagger.
- Creating a REST integration by using the Create REST integration wizard
You can create data sources in your application by using standard methods to obtain data from external REST services. You can also configure the authentication for the data sources by using a basic, NTLM, or OAuth 2.0 authentication scheme. When you use the Create REST Integration wizard to create a data source, the system generates the records that are required to use the data source. These records include classes, properties, mapping rules, data transforms, a connector, a data page, and optionally, an authentication profile, an OAuth 2.0
- Connect REST rules
Connect REST rules support interactions between the Pega Platform and other systems over the Hypertext Transfer Protocol (HTTP).
- File attachment configuration in REST and SOAP integrations
You can configure REST and SOAP integrations in Pega Platform to upload or download file attachments directly in your application. REST and SOAP connectors in Pega Platform allow you to use REST or SOAP APIs that receive or return attachments.
- Creating a SOAP integration
You can create data sources in your application from the operations in external SOAP services. Many service providers make their assets available by using the SOAP standard, and you can use these assets in Pega Platform by creating a SOAP integration.
- Service SOAP rules
Pega Platform supports Web service interactions with external systems by using the SOAP messaging standard. Use SOAP service rules when your Pega Platform applications need to act as a web service.
- Connect SOAP rules
Using Simple Object Access Protocol (SOAP) over HTTP, the SOAP integration interface in Pega Platform supports interactions with external systems through Web services. Use SOAP connector rules when your Pega Platform applications need to call an external Web service. By using the SOAP integration interface, you optimize your business processes and avoid relying on an additional platform as a service to make calls.
- Parse XML rules
Use Parse XML rules with services and connectors to map data from an XML text message into clipboard property values. Each Parse XML rule contains an array of parsing instructions that Pega Platform uses to interpret an incoming XML document or message.
- XML Stream rules
Create an XML stream rule to define an XML template or skeleton message as part of an interface between the Pega Platform and an external system. XML stream rules can be used to assemble and send an XML document in an email message, a SOAP message, a file, or other types of messages.
- Using WS-Security to enhance SOAP messages
The WS-Security standard provides a set of enhancements to the SOAP messaging standard for the purpose of adding message-level security to web service transactions.
- Understanding WS-Trust in Pega Platform
Pega Platform provides WS-Trust support. WS-Trust extends the WS-Security specification to allow issuing, renewing, and validating security tokens. WS-Trust utilizes a Secure Token Service (STS) to acquire secure tokens used to communicate with external systems that provide data to your application via web services.
- Creating a SAP integration
You can create data sources in your application that are based on IDoc XSD documents or from the operations in external SAP services. Many service providers make their assets available by using SAP, and you can use these assets in Pega Platform by creating a SAP integration.
- Connect SAP rules
Connect SAP rules support interactions between Pega Platform and SAP R/3 (ECC) or NetWeaver systems over HTTP. Use Connect SAP rules in your application to connect to existing SAP Web services and create connectors of SOAP or IDoc types.
- Service SAP rules
Create Service SAP rules in your Pega Platform application when you want to allow an SAP system to connect to the Pega Platform using SOAP web service protocols. SAP service rules are designed for both traditional SAP R/3 (ECC) application integration and SAP NetWeaver application integration.
- Best practices for generating OpenAPI Specification documentation
OpenAPI Specification (OAS) documentation is automatically generated for every REST service rule. The OAS documentation for each REST service included in a service package is then combined into a single OAS document.
- Generating OpenAPI Specification documentation for application-specific REST APIs
You can list service packages that contain REST services in your application rule to include their OpenAPI Specification (OAS) documentation in your application's OAS documentation. All of the services that you list are documented together in a single application OAS landing page, which you can view in the application's API channel.
- Viewing application-specific REST APIs
View the OpenAPI Specification (OAS) documentation that describes your application's REST APIs in either App Studio or Dev Studio. You can also view the OAS documentation for individual REST services and for the REST services that are included in a service package.
- Invoking a REST service rule
Call a REST service rule from an external system to invoke an action in your application or retrieve data from Pega Platform. For example, you can call a REST service to get the details of a case or assignment. You can specify the application context in which to run the API by using the application alias URL.
- Using OAuth2 authentication with the Pega-provided Swagger UI
Authenticate with the Pega-provided Swagger UI so that you can test your Pega APIs, by creating an OAuth 2.0 client registration. Use the client ID and secret from your OAuth 2.0 client registration to define the scope of end-user access to the Swagger UI.