Skip to main content


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

Integrating with Pega 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

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us