Skip to main content

Connecting to REST and SOAP services

Suggest edit Updated on December 1, 2021

Use Pega Platform REST and SOAP connectors to integrate common web protocols with Pega Cloud services.

Enterprise roles required for this task

This task requires an integration developer with network administrative privileges that can set up a third-party or internal API node in your enterprise environment.

Pega project team members required for this task

This task requires an application developer role that integrates the source API URL with Pega Platform, and a system admin role that will troubleshoot API integration.

Before you begin:

  • Your application developer must have the required access roles for use of the integration wizard.
Integrating REST or SOAP in a Pega Cloud environment
A flowchart showing the stages of REST and SOAP integration

Stage 1

Before integrating your chosen REST or SOAP API with Pega Platform, your enterprise integration developer must perform the following tasks:

  1. Set up a third-party or internal API node.

    The source API node renders a source URL for REST API or WSDL file for SOAP API.

  2. Make the source URL available to your Pega Cloud virtual space.
    1. Add the host of the REST API to your Pega Cloud virtual space DNS resolution.

      For more information, see Pega Cloud Services networking details.

    2. Make the source URL for the REST API, or the URL for the WSDL file for the SOAP API, available to yourPega Cloud virtual space by using one of the following networking options:Note: You can also import WSDL files for SOAP integration manually, in which case you do not need to make its URL available to your virtual space.
      • Add the URL for the REST API or URL for the WSDL file to an allow list
      • Use the Pega VPN

      For more information about Pega Cloud connectivity, see the public and private connectivity articles.

Stage 2

After the REST or SOAP API URL has been made available to your Pega Cloud virtual space, your application developer uses the Pega Platform REST or SOAP integration wizard using the endpoint URL by performing the following tasks:
  1. In the header of Dev Studio, click Dev Studio IntegrationConnectorsCreate REST Integration or Create SOAP Integration to open the appropriate integration wizard to connect to a REST or SOAP service. For more information, see Creating REST integration and Creating SOAP integration for their respective processes.
    1. Ensure that you add the endpoint or WSDL file that you made available to your Pega Cloud virtual space during stage 1.

      To add the Endpoint URL to your REST connection, see step 2 in Configuring a REST connection.

      To add the Endpoint WSDL file to your SOAP integration, see step 1 in Selecting operations in SOAP integrations.

    2. Ensure that you authenticate your REST or SOAP integration using your enterprise business requirements.

      To authenticate your REST integration, see step 6 in Configuring a REST connection.

      To authenticate your SOAP integration, see step 2 in Adding a WSDL file for SOAP integration.

  2. After completing the REST or SOAP integration, you can test operations in your SOAP integration to confirm its integration.

    For more information, see Testing SOAP integration operations.

Stage 3

After completing your REST or SOAP integration, your system administrator can perform any necessary troubleshooting on your REST or SOAP API integration.

For more information about testing your REST integration, see Troubleshooting REST connectors.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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