0. Disclaimer
⚠️ Warning: API Support Limitations
Unlike some other integrations, the QA Touch API currently has specific limitations. Please find the list below:
BDD Support: BDD-style (Behavior Driven Development) test cases are currently not supported by the QA Touch API.
Deletion Handling: Test case deletion is not supported by the QA Touch API, so it will not work through the SQAI platform. Any test cases generated must be deleted manually within the QA Touch interface.
1. How does SQAI Suite Leverage This Integration?
Connecting to QA Touch allows SQAI to integrate directly into your testing management workflow:
Centralized Test Creation: Allows SQAI to generate new test cases directly within your designated QA Touch Project and Module.
View Test Cases: Retrieve and display your QA Touch test cases with full details, including test steps and preconditions, directly in SQAI.
Traceability: Access test cases in QA Touch via direct links from the platform for a seamless transition between tools.
2. Information Required from Your QA Touch Account
To establish a secure connection, you will need the following five pieces of information from your QA Touch domain and project settings.
Required Detail | Explanation | How to Find It |
API Key | A unique, private key used for authentication. | Found in your QA Touch account's Developer or API settings. |
Expiration Date | (Optional) A reminder date for when your credentials expire. | User-defined. |
Domain | The subdomain part of your QA Touch URL. | If your URL is |
Project ID | The unique ID of the Project where test cases are managed. | Found within the Project settings in QA Touch. |
Module ID | The ID of the specific folder (module) for organizing test cases. | Found within your QA Touch project structure. |
3. Entering Details in SQAI Suite
Once you have 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 QA Touch configuration.
Step 2: Enter Details
Insert the following details into the corresponding fields:
API Key (Click "Show" to verify the characters).
Expiration Date (Optional).
Domain (The subdomain only).
Project ID.
Module ID.
Step 3: Save and Confirm
Click "Save Configuration." Ensure the "Enable configuration" toggle is switched on.
4. Important: Linking Test Cases in SQAI
When you want to add or link a specific test case manually within the SQAI Data Table, it is crucial to use the correct identifier.
💡 Tech Tip: Do not use the standard Test Case ID you might expect. Instead, you must use the Case Key - API
To find this, open the Test Case Details in QA Touch and look for the field labeled "Case Key - API" (e.g., 68BBm5). Use this value when referencing the case within SQAI Suite to ensure the integration functions correctly.
5. Troubleshooting QA Touch Integration
Problem | Cause | Solution |
Connection Failed | Invalid API Key or Domain. | Re-check that the Domain is only the subdomain (e.g., "company") and that the API key has the necessary permissions. |
Cannot find Module | Incorrect Module ID. | Verify the Module ID within QA Touch; ensure it is the specific folder ID where you want cases to land. |
BDD Cases not syncing | API Limitation. | Remember that BDD-style cases cannot be synced via the current QA Touch API. |