Setting Up Postman for Jira Align REST API

Summary

Users who want to interact with the Jira Align REST API often need to use Postman to test and automate API calls. However, many encounter difficulties configuring Postman correctly for Jira Align, including issues with authentication (such as generating and using API tokens), setting the correct request headers, and constructing valid API requests. These challenges can prevent successful connection and data retrieval or updates via the API, resulting in errors like authentication failures, 401 Unauthorized, or unexpected response formats.

Solution

Download Postman

1. Download Postman from https://www.postman.com/downloads/

2. Run Postman.

Create a new environment

1. Click New, or type Ctrl + N (Windows/Linux) or Cmd + N (MacOS).

2. Select “Environment”.

3. Name the environment “Jira Align Environment”.

4. Set up the following variables:

Note that Postman variables are case-sensitive.

1. Click Save towards the top right corner.

Create a new collection

1. Click New, or type Ctrl + N (Windows/Linux) or Cmd + N (MacOS).

2. Select “Collection”.

3. Name the collection “Jira Align Collection”.

4. Click the “Authorization” tab.

5. Change Type to “Bearer token”.

6. Specify {{apiToken}} as the Token. The text should be coloured blue, indicating that Postman has recognized a variable has been specified. This can be confirmed by hovering over the variable name.

7. Click Save towards the top right corner.

Create a new request

1. Click the + sign next to “Jira Align Collection“ to add a new request

2. Go to https://<yoursite>.jiraalign.com/rest/align/api/docs/index.html to find the list of available resources

3. Click the drop-down to select the HTTP method (e.g.: GET, POST, and so on)

4. In the URL box, type {{cloudUrl}}/<endpoint name> (e.g.: {{cloudUrl}}/Portfolios to get the list of Portfolios)

5. Click Send button to get the result

Related resource

https://help.jiraalign.com/hc/en-us/articles/360045371954-Getting-started-with-the-REST-API-2-0