Test CPQ APIs

Prev Next

Zilliant CPQ APIs help you manage and retrieve your data in CPQ. For more details, read CPQ API reference .

You can test our APIs directly in the CPQ API reference by following these steps:

  1. Authorize your requests.
  2. Send a request to test the API.

Authorize

CPQ APIs support the OAuth 2.0 username-password flow to authorize test requests. You must provide your login credentials to obtain an OAuth 2.0 authorization token.

To authorize test requests:

  1. In the CPQ API reference , select an API.

  2. On the leftmost panel, under the API name and description, select the URL of your test system from the Servers dropdown.

  3. Under your server URL, select Authorize.

  4. In the Available authorizations dialog, enter information or make selections:

    • username—Enter your username.
    • password—Enter your password.
    • Client credentials location—Select Authorization header.
    • client_id—Enter your client ID of the connected app.
    • client_secret—Enter your client secret of the connected app.
    • Scopes—Select a level of the connected app's access to your data.
    Tip

    Contact your Zilliant representative to get your username, password, client ID, and client secret.

  5. Select Authorize.

Send a test request

After successful authorization, send a request to test the API:

  1. On the leftmost panel, on a request you want to send, select Open dropdown menu to expand the request details.
  2. Select Try it out.
  3. Enter parameter values, then select Execute.
  4. View the request response.