API integration flow

The following flow demonstrates how your applications can be integrated using the REST API.

Caution: Some resources are technical preview, and subject to change until declared public. You have access to them, but only at a technical preview level.

Set up API access

Set up API access once for each application that will communicate as a client. This grants the application registered access keys to use for authentication. Two keys are created: Client ID and Client secret.

To get started, open the Settings menu , click Spaces, and select a shared space. In the API Access tab, click the API Access button .

For details, see API access.

Back to top

Authenticate and sign in

APIs must be authenticated to work with OpenText Core Software Delivery Platform, and the API must sign in. For details, see Authentication.

Back to top

Perform actions

When signed in, your APIs can work with entities and relations. OpenText Core Software Delivery Platform is an entity-relationship application and supports the basic CRUD operations (Create, Read, Update, Delete).

Some of the actions your APIs can perform are: 

  • Creating items, such as defects, application modules, and pipelines.

  • Deleting items.

  • Updating items.

  • Querying items.

To get started, see Interactive API client and Work with the REST API.

Back to top

Sign out

The sign_out resource logs the user out of the session and cancels (expires) cookies.

For details, see sign_out.

Next steps: