Public API

The API enables developers to perform actions such as logging in and running tests. The public API is HTTP-based and RESTful. All API responses are returned in JSON format.

At the end of each test run, a report is sent by email.

In this topic:

Access the public API help

To access the public API, perform the following steps:

1. Click Public API Help to access the full online documentation.

   Note: You must log in to a valid tenant in the same browser to access the API through this link.

2. Enter your OpenText Core Performance Engineering client ID and client secret. For details, see Create access keys.

   Note: For tenants created in version 24.3 or earlier, username and password authentication continues to work, although this method has been deprecated and will no longer be valid once enforcement begins in a future release.

3. Click an operation to expand its full details.

4. For each operation, click Try it out to perform the operation using the parameters you’ve specified.

Integrate an application

This section describes how to integrate an application with OpenText Core Performance Engineering.

To integrate an application:

Invoke the /v1/auth-client API call with a client ID and client secret. The API call returns an OAuth token. Set the Bearer authentication header with the token value, for example: Authorization: Bearer <token>.