API integrations flow

This flow demonstrates how your applications can integrate with ALM Octane using the REST API.

Caution: Certain specifications are a technical preview, and subject to change until declared public. You have access to all non-public resources, but only at a technical preview level.

Select an image to learn more.

Set up API access

Shared space admin permissions are required.

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

To get started, in the top banner, click Settings . Click Shared Space, and in the API Access tab, click +.

For details, see the information about setting up API access in the ALM Octane User Guide.

Back to top

Authenticate and sign in

APIs must be authenticated to work with ALM Octane.

To work with the ALM Octane, the API must sign in. For details, see Authenticate and sign_in.

Back to top

Perform actions

Once signed in, your APIs can work with ALM Octane entities and relations. ALM Octane is an entity-relationship application and supports the basic CRUD operations (Create, Read, Update, Delete).

Some of the actions your APIs can perform are: 

To get started, see Interactive API client.

For the ALM Octane REST API specification reference, see REST API reference.

Back to top

Sign out

The sign_in resource logs the user out of the session and cancels (expires) the cookies returned by sign_in.

For details, see sign_out.

Next steps: