Connecting to the REST API

Before you can start making requests using the REST API, make sure you can successfully connect to it. You may want to use a utility like Postman to make a simple request to learn how to connect. See Exploring the REST API.

Perform the following steps to connect to the API.

1. Figure out the base URL needed to make calls. This is used in all calls and is appended with an endpoint. The base URL is in the following format:

https://server:port/helix-alm/v#

For example, https://localhost:8443/helix-alm/api/v0/

2. After you successfully connect, get a list of projects from the Helix ALM Server. You will use a project ID or name in all subsequent requests. Use to return a list of projects. You must authenticate using a Helix ALM username and password.

3. Get an access token, which is required authorize the user for subseqent requests. See Authentication for information. Use the project ID for the project you want a token for.

4. Start making requests.