1. How does SQAI Suite Leverage This Integration?
Connecting to Redmine allows SQAI to integrate directly into your issue tracking and project management workflow:
Contextual Analysis: SQAI reads issues, requirements, and project details from Redmine to gain the necessary business context for accurate generation.
Traceability: Allows SQAI to reference or link generated test cases and automation scripts back to the original Redmine issue.
Efficient Prompting: Uses the existing issue data to enhance the accuracy and relevance of the context provided to the SQAI Agents.
2. Information Required from Your Redmine Account
To establish a secure, plug-and-play connection, we require the Instance URL and the authentication details, depending on your chosen method.
Required Detail | Explanation | Authentication Method |
Instance URL | The full domain of your Redmine instance. | API Key or Basic Auth |
API Key | A unique, private access token generated on your "My Account" page. | API Key (Recommended) |
Basic Auth Username | The username (login) for the account accessing the API. | Basic Auth (Alternative) |
Basic Auth Password | The password for the account accessing the API. | Basic Auth (Alternative) |
3. Setting up the Integration (REST API & Authentication)
⚠️ Warning: This integration requires the REST API to be explicitly enabled on your Redmine instance. This applies to both EasyRedmine cloud instances and self-hosted deployments.
❌ You must have user permissions to access or generate an API key. Contact your administrator in case your account does not comply.
Before gathering the authentication credentials, an administrator must enable the REST API.
Step 1: Enable the REST API (Admin Required)
Log into Redmine as an administrator.
Navigate to Administration > Settings.
Click the API tab. 4. Check the box for Enable REST web service.
Click Save.
Step 2: Retrieve API Key (Recommended Method)
If the REST API is enabled, individual users can retrieve their unique API key for authentication:
Click "My Account" in the top right corner of the application (or navigate to
/my/account).On your account page, you will find the API access key on the right-hand pane of the default layout.
Step 3: Basic Authentication (Additional)
If your instance requires or prefers additional Basic Authentication (username/password in addition to an API Key), you must additionally use the standard login credentials of the service account.
4. Entering Details in SQAI Suite
Once the REST API is enabled and you have your credentials, 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 Redmine configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Instance URL
API Key
Basic Authentication Username/Password (Only fill these in if your instance requires Basic Authentication in addition to the API key)
Expiration Date (Optional in case you would like to receive notifications)
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 Redmine integration.
5. Troubleshooting Redmine Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues.
Problem | Cause | Solution |
Connection Failed: "401 Unauthorized" | A. API Key/Credentials Incorrect: The API Key or Basic Auth credentials were entered incorrectly. | Verify Key/Password: Re-check the API Key from the "My Account" page or verify the username/password. |
"API Not Available" / Connection Refused | B. REST API Not Enabled: The prerequisite step of enabling the REST web service in the Admin settings was skipped or reversed. | Enable API: An administrator must navigate to Administration > Settings > API and check Enable REST web service (Section 3, Step 1). |
API Key Missing | C. User Permissions: The user attempting to find the API Key does not have the necessary permissions. | Check User Role: Ensure the user has the role required to access or generate an API key on the "My Account" page. |
Generic Connection Error | D. Incorrect Instance URL/Firewall: The Instance URL is incorrect, or a local firewall is blocking the connection. | Check URL & Network: Verify the exact Instance URL and ensure the network allows outbound communication to the Redmine instance. |