Skip to main content

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

Pega APIs and services

Updated on May 27, 2021

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

  • Creating a REST integration

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

  • Creating a data object and connecting it to a system of record using REST

    Add data objects to your application to define and store data, for example, customer addresses, then integrate them with data from an external source using REST.

  • Connecting existing data objects to a system of record using REST

    To integrate your application with data from an external source, you connect data objects to a system of record using REST.

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

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