Apps documentation
Requirements and Test Management for Jira
Cloud Server/Data Center
Requirements and Test Management for Jira

Cloud

Server/Data Center

Documentation
FAQ
Release notes
Articles & Videos
Last updated Aug 4, 2021

Authentication

The API URL is:

  • https://rtm-api.hexygen.com/api for US and Global data residency
  • https://rtm-eu-api.hexygen.com/api for EU data residency
Tip

If you’re not sure what your API URL is, navigate to Data residency.

Warning

In the Jira Cloud environment it IS NOT the same as your Jira base URL.

To authenticate, use your internal API TOKEN mechanism provided by Requirements and Test Management for Jira Cloud.

Steps

  1. Click Generate Token.
    Generate token to use REST API from Requirements and Test Management for Jira app
    Generate token to use REST API from Requirements and Test Management for Jira app
  2. Select the specific user for whom you want to generate a token.
  3. Use a label to give it a name.
  4. Click Generate.
  5. Copy your token, because after closing the window you will not be able to see the token anymore.
    Generate token to use REST API from Requirements and Test Management for Jira app
    Generate token to use REST API from Requirements and Test Management for Jira app

Result

After generating a token, this is how your API Tokens list should look like:

List of generated tokens to use REST API from Requirements and Test Management for Jira app
List of generated tokens to use REST API from Requirements and Test Management for Jira app

To use the generated key, in Postman tool choose the Authorization type called Bearer Token. In the Token field on the right side of the screen, type in the token generated before. You can also assign the request parameters to the token variable and type it in the field like it’s shown on the screen below.

Using REST API from Requirements and Test Management for Jira app in Postman
Using REST API from Requirements and Test Management for Jira app in Postman

Data residency

Depending on your location you will be using different base REST API URL. To check, what is your current data residency location and what is your REST API URL do as follows:

  1. Open the RTM app.
  2. Click three-dot menu.
  3. Click Rest API authentication.
    REST API in Requirements and Test Management for Jira app
    REST API in Requirements and Test Management for Jira app

This brings the REST API authentication window:

REST API in Requirements and Test Management for Jira app
REST API in Requirements and Test Management for Jira app

Need help?

If you can’t find the answer you need in our documentation, raise a support request*.
*Include as much information as possible to help our support team resolve your issue faster.