API integration flow

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

Set up API access for applications

An administrator must grant API access to each application that will authenticate with an API access key or token. The application then uses its assigned key or token to authenticate. 

For details, see API access.

Authenticate

Clients must authenticate before making REST API requests. For example, JSON authentication uses the sign_in resource to establish a session, while Basic authentication sends credentials with each request. For details, see Authentication.

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).

To get started, see Interactive API client and REST API calls.

Sign out

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

For details, see Sign out.

Next steps