Skip to main content

Testmo Test Management (Cloud)

This guide provides the necessary details to quickly and securely connect your Testmo Cloud instance to SQAI Suite, enabling the generation and linkage of test cases.

Updated over 2 months ago

⚠️Note on API Users: Standard Users can use any existing user account to generate an API key. Business/Enterprise Users have the option to create separate API Users (sometimes called "service accounts") under Admin > Users & roles. This is recommended for creating separate users for integrations and assigning custom, restricted roles.

1. How does SQAI Suite Leverage This Integration?

Connecting to Testmo allows SQAI to integrate directly into your testing management workflow:

  • Centralized Test Creation: Allows SQAI to generate new, high-quality test cases directly within your designated Testmo project.

  • Streamlined Workflow: Eliminates the manual effort of transferring generated test assets into your Test Management Tool (TMT).

  • Traceability: Enables the efficient management and tracking of AI-generated test assets alongside your existing test suite.

2. Information Required from Your Testmo Account

To establish a secure, plug-and-play connection, we require two pieces of information: the Instance URL and the API Key.

Required Detail

Explanation

Authentication Method

Instance URL

The base URL of your Testmo instance.

https://<your-name>.testmo.net

API Key (Bearer Token)

A secure, long-lived token generated in your user profile for programmatic access.

See Section 3.

3. Setting up the API Key (Bearer Token)

Testmo uses simple Bearer Tokens to authenticate against the API. This key must be generated from a user profile and is only visible once.

Step 1: Navigate to User Profile

  1. Click your Avatar Image in the top right corner of the Testmo application.

  2. Select the User Profile section.

    users-profile-index-api.png

Step 2: Access API Keys Section

  1. On your user profile page, look for the API access section (usually in the left column).

  2. Click the change link next to the API access section to add a new API key.

Step 3: Generate and Secure the Key

  1. Click the option to generate a new API key.

  2. Provide a clear name (e.g., "SQAI Integration") so you can track its usage.

  3. Crucially: Copy the generated API Key immediately. It will only be displayed once.

Authentication Method

SQAI Suite uses this token in the format required by the Testmo API: submitting the token as a Bearer Token in the Authorization HTTP header.

Here is a full example on how to authenticate against and call the Testmo API to retrieve basic information about the authenticated user:

$ TESTMO_TOKEN=********
$ curl -H "Authorization: Bearer $TESTMO_TOKEN" \
https://<your-name>.testmo.net/api/v1/user

4. Entering Details in SQAI Suite

Once you have secured your API Key, you can complete the setup in the SQAI Suite platform.

Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the Testmo configuration.

Step 2: Enter Details Insert the following details into the corresponding fields shown on the configuration page:

Configuration Field Name

Value to Enter

Notes

API key

The API Key (Bearer Token) generated in Section 3.

Your token for programmatic access.

Expiration Date

Optional. Date the key expires. SQAI will use this for reminder alerts.

Base URL

The Instance URL of your Testmo account (e.g., https://your-company.testmo.net).

Project ID*

The numerical ID of the Testmo project where test cases will be managed.

Folder ID*

The folder ID within the Testmo project for organizing test cases.

Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your integration.

5. Troubleshooting Testmo Integration

If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to access.

Problem

Cause

Solution

Connection Failed: "Unauthorized" (401 Error)

A. Invalid API Key: The key was copied incorrectly, or the token was revoked.

Generate New Key: Since the key is only displayed once, the easiest solution is to generate a new API key from the User Profile page (Section 3) and update the configuration in SQAI Suite.

Connection Failed (403 Forbidden)

B. User Permissions: The user account associated with the API key does not have the necessary permissions (role) to create or read test cases in the targeted project.

Check User Role: Ensure the API key is associated with a user role that has Write permissions for the relevant Testmo projects.

Cannot Find Content

C. Incorrect Instance URL: The base URL for the Testmo instance contains a typo.

Verify URL: Ensure the URL is entered correctly (e.g., https://<your-name>.testmo.net).

Key Management

D. Key Overload: You have too many active keys, making management difficult.

Clean Up: Use the User Profile or Admin panel to revoke old, unused API keys to improve security and clarity.

Did this answer your question?