⚠️ Warning: TestMonitor's external API is currently in a Beta state. SQAI Suite provides no warranties regarding the stability or availability of this connection and offers no Service Level Agreements on fixing issues caused by unversioned or unannounced API changes from the TestMonitor platform.
1. How does SQAI Suite Leverage This Integration?
Connecting to TestMonitor 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 TestMonitor Project and Test Suite.
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 TestMonitor Account
To establish a secure, plug-and-play connection, we require four specific pieces of information, all of which can be found within the TestMonitor interface.
Required Detail | Explanation | How to Find It |
Instance URL | The base URL of your TestMonitor cloud instance. | Found in your browser's address bar. |
Project ID | The numerical ID of the Project where test cases will be created. | Found in the URL when viewing a project. |
Test Suite ID | The numerical ID of the specific Test Suite within the Project where test cases will be placed. | Found in the URL when viewing the Test Suite. |
Personal Access Token | A unique, private token used for API authentication. | See Section 3. |
2.1 Retrieving the Project ID and Test Suite ID
Log into TestMonitor and navigate to the Design tab at the top of the interface.
Select or create the specific Test Suite (e.g., "AI-generated") you want to use as the output directory for SQAI
The Test Suite ID is the number visible at the end of the URL in your browser's address bar. The Project ID will also be visible earlier in the path.
3. Setting up the Personal Access Token
The Personal Access Token (PAT) is required to authorize SQAI Suite to communicate with your TestMonitor account.
Step 1: Access API Settings
Click your Profile Icon in the top right corner of the application.
2. Click My Account (or equivalent user settings).
In the resulting settings menu, find the option for API or Personal Access Tokens.
Click Create Token... (or equivalent button).
Provide a clear name (e.g., "SQAI Integration").
Set the necessary permissions (scopes) for the token to allow reading and writing test cases.
Copy the generated Personal Access Token. TestMonitor will not display this token again.
4. Entering Details in SQAI Suite
Once you have secured your PAT and gathered the necessary IDs, 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 TestMonitor configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
URL of the customer’s TestMonitor instance
Personal Access Token
Project ID
Test Suite ID
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 TestMonitor Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to the API, remembering the Beta status.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Forbidden" | A. Invalid PAT: The token was copied incorrectly or has been revoked. | Generate New Token: Re-copy or generate a new Personal Access Token from the TestMonitor API settings (Section 3). |
Invalid Resource: Cannot Find Suite/Project | B. Incorrect ID: The Project ID or Test Suite ID contains a typo or is outdated. | Double-Check URL: Verify the IDs by navigating back to the Test Suite URL in TestMonitor to confirm the exact numerical values (Section 2.1). |
SQAI Connects, But Cannot Write | C. Token Permissions: The PAT is missing the necessary Write/Create scopes for Test Suites/Cases. | Verify Token Scopes: Ensure the token was created with the required permissions to push new content. |
Frequent, Unexpected Errors (API Beta) | D. Unannounced API Change: Due to the API's Beta status, the connection may break without warning. | Contact Support: If all credentials are confirmed correct, please notify your SQAI Suite CSM. We will investigate the latest API changes with TestMonitor. |