Rest API
Changes from previous authentication
After implementing the new API Tokens, please be aware that you will need to make a few changes to make your scripts or requests work. You can find more details with exact steps and use the list below as a simple checklist.
Every endpoint now has a prefix: “/api”. For example, “/testCycles” becomes “/api/testCycles".
The authentication token is now passed as a request header instead of being passed as a request param. Please look into Rest API | How to use Api Token for details.
Authentication
QAlity Plus clients have access to our REST API for custom integrations and automation. All requests made to the API are authenticated using a personal API Token. Each API token impersonates the user who generated it, inheriting their exact Jira access permissions, so please exercise caution and keep it secure.
Root URL
All API endpoints described in this documentation are relative to the following base URL:
https://apps-qalityplus.soldevelo.com/apiGenerate an Api Token:
To generate your required API token, visit our QAlity API Token generation page available on the QAlity Plus Dashboard.
The QAlity Plus API Tokens button will appear on the Dashboard only after at least one Jira project has been configured to work with QAlity Plus (i.e., at least one project must have the QAlity Test work type enabled). If you don't see the button, please complete the project configuration first.
Click the "Create token" button.
Provide a descriptive name for your token (up to 255 characters).
Choose when the token should expire (you can set this up to 1 year in advance).
After you are done, you can click “Create“ (It will move you to another modal)
Now you can copy your token
Token expiration date
Api Tokens have a maximum lifespan of 1 year. After that time passes, they will no longer work. To avoid any interruption in your work, please generate a new token ahead of time.
How to use Api Token
To use the api token, simply provide it in your request in the following way:
Postman
Select Authorization → Type: Bearer Token → Paste your token
Curl
curl -X GET "https://apps-qalityplus-staging.soldevelo.com/api/testCycles" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Accept: application/json"Swagger
Follow the instructions on a dedicated page [REST API Documentation]
Endpoints
For a complete list of QAlity Plus endpoints and data models, please explore our
[REST API Documentation]
Integration with Jira
QAlity Plus is integrated with Jira. Because of that, you will sometimes need to integrate your scripts not only with our API, but also with the Jira API. Below, you can find a quick guide on how to get the most commonly used data out of Jira.
Get Jira work item ID
QAlity test cases are integrated with Jira. This means test cases are represented as Work items of “QAlity test“ type. Often, you will need their ID to make a request.
You need an Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens
Make a GET request with authorization:
username= your emailpassword= API token from step 1https://<your_instance>.atlassian.net/rest/api/3/issue/<Work item KEY or ID>Copy the
idproperty from the response.
Get Jira Space ID
You need an Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens
Make a GET request with authorization:
username= your emailpassword= API token from step 1https://<your_instance>.atlassian.net/rest/api/3/project/<SPACE KEY or ID>Copy the
idproperty from the response.
Token Security
To guarantee your data remains safe, our API tokens are protected using the latest industry-standard hashing and security libraries.
The API Token Authentication method is developed in strict compliance with Atlassian's official "User impersonation for Connect apps" guidelines to ensure a fully compliant and secure integration. https://developer.atlassian.com/cloud/jira/platform/user-impersonation-for-connect-apps/