Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Integrating with APIs and services

Updated on April 6, 2022

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 ResourcesAPIs.
  • In Dev Studio, click Application nameChannels and interfacesPega APIPega.
  • In App Studio, click InterfacesPega APIPega.

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

For information about Pega APIs that help you manage cases and assignments, see the Pega Digital Experience (DX) API landing page.

  • 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).

  • 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.

  • JSON data transforms

    A data transform defines how to convert data that is in one format and class (the source) into data of another format and class (the target). Use JSON data transforms when you need to integrate disparate data, for example, responses from external data sources, with the application data model.

  • OpenAPI Specification in Pega Platform

    You can view auto-generated OpenAPI Specification (OAS) documentation that describes the REST services that are included in your service package. The OpenAPI tab on REST service rule forms and service package rule forms 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.

  • 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.

  • Service Request Processor data instances

    When an EJB, HTTP, Java, JMS, MQ, or SOAP service rule is configured to process service requests asynchronously, or is configured to requeue failed service requests for a later execution attempt, service request information is stored as a persistent object in a request queue in the PegaRULES database.

  • 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.

  • 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.

  • Dynamic system settings for SOAP integrations

    Pega Platform provides dynamic system settings that you can use to modify SOAP integrations in your system. For example, you can modify the time and number of idle HTTP connections if a high system load negatively affects the performance of SOAP connectors.

  • About importing XSD files

    When you import an XSD file with the Connector and Metadata wizard, the wizard creates in Pega Platform the data model described in the XSD file. The wizard does the following:

  • 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. You can use XML stream rules to assemble and send an XML document in an email message, a SOAP message, a file, or other types of messages.

  • JMS Transport data instances

    Create a JMS Transport data instance to record the information used to connect to an external SOAP service using the JMS binding.

  • 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.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us