LinkedIn
Copied!

Table of Contents

Accessing and testing DX API v2

Familiarize yourself with Pega DX API Version 2 (V2) and learn to use it successfully by exploring what you can achieve with individual endpoints. 

Pega Platform™ provides categorized lists of all available API endpoints, which you can conveniently access and analyze. Each entry explains how a specific endpoint works and provides additional information, such as response data. You can also test every endpoint and simulate a response. By generating a sample response, you can better understand how the endpoint works and what types of responses to expect.

Create an OAuth 2.0 client registration data instance and save the credentials to be able to test individual endpoints. For more information, see Creating authorization for DX API tests.
  1. In the header of Dev Studio, click the Resources icon, and then click Pega API.
  2. In the Pega API Help window, in the Service package list, select V2 DX API.
    The Pega API Help window might appear as a new tab in your browser, depending on your setup.
  3. Click Authorize.
  4. In the Available autorizations window, in the Password (OAuth2, password) section, enter the required credentials:
    1. In the username: and password: fields, enter your Pega credentials.
    2. In the client_id: and client_secret: fields, enter the OAuth credentials that you saved in Creating authorization for DX API tests.
  5. Click Authorize, and then click Close.

    Result: You can now test the endpoints.

  6. Click the endpoint that you want to test.

    Result: The details of the endpoint appear, including a description, parameters, and sample responses.

  7. Test the endpoint:
    1. Click Try it out.
    2. If the endpoint requires additional parameters, enter the information in the required fields.
      If you want to test the GET /cases/{caseID}/attachments endpoint, which retrieves a list of attachments in a specific case, after you click Try it out, provide the case ID.
    3. Click Execute.

      Result: The system generates a response to the simulated query, as in the following example:

      A sample V2 DX API test response generated by the system.
      Sample JSON response

 

Did you find this content helpful?

Have a question? Get answers now.

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