QA Touch API

Before you start using our API, your first step is to obtain an api-token from your QA Touch site. Once you obtain the token, then you are ready to go.

To Obtain api-token follow the steps below Go to User->Edit profile Under General settings, Click 'Generate API Key' to generate the API key.

(Note: QA Touch API is a Professional and Enterprise Plan feature)

Requirements

All the API endpoints require a couple of headers so that we can authenticate you before processing the request.

Required Headers

1. domain
2. api-token

Pagination

By default, all the endpoints which return more than 50 rows are paginated. You can move to another page by adding parameters to the request.

For example : https://api.qatouch.com/api/v1/getAllProjects?page=2

The above example will return the data which are available in the second page of the request.

GitHUB Repository

git clone git@github.com:gitdckap/QATouchAPIDemo.git

Projects

List Projects

Provides the list of projects created for your domain.

API - PHP Code

API code support PHP CURL function.

Github - 
https://github.com/gitdckap/QATouchAPIDemo

https://github.com/gitdckap/QATouchAPIDemo/blob/master/allprojects.php

Javascript Github
https://github.com/gitdckap/QATouchAPIDemo/tree/master/JavascriptAPI

GET https://api.qatouch.com/api/v1/getAllProjects

Example - PHP Code

<?php
include('config.php');

function getAllProjects($apiToken,$domain,$url) {
   $curl = curl_init();
    // Set some options - we are passing url and necessary headers
    curl_setopt_array($curl, array(
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => array(
            'api-token:'.$apiToken,
            'domain:'.$domain
        )
    ));
    // Send the request & save response to $resp
    $resp = curl_exec($curl);
    // Close request to clear up some resources
    curl_close($curl);
    // return the response
    return $resp;
    
}

/* Provides the list of projects created for your domain */
$allprojecturl  = $url.'getAllProjects';
$allproject    = getAllProjects($apiToken,$domain,$allprojecturl);
echo $allproject;

?>

Example - Javascript Code

var myHeaders = new Headers({
    'Access-Control-Allow-Origin':'*',
    'Content-Type': 'multipart/form-data'
});
myHeaders.append("domain", "apidemo");
myHeaders.append("api-token", "***********************API TOKEN***********************");

var requestOptions = {
  method: 'GET',
  mode: 'cors',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.qatouch.com/api/v1/getAllProjects", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Project - Test Case / Milestone / Defect Counts

Provides the particular project detail with Test Case / Milestone / Defect Counts

GET https://api.qatouch.com/api/v1/getAllProjects/{projectKey}

Note: Replace Curly braces with your ID / Value

{projectKey} => your ID / Value

Example : https://api.qatouch.com/api/v1/getAllProjects/ProjectKeyvalue

Return - Test Case / Milestone / Defect Counts

{ "message": "Project Detail", "project_name": "****", "project_key": "****", "testcase_count": xx, "testrun_count": xx, "defect_count": xx, "milestone_count": x }

Count Projects

Count of the total projects available.

GET https://api.qatouch.com/api/v1/count/allProjects

https://github.com/gitdckap/QATouchAPIDemo/blob/master/allprojects.php

Create Project

Create a new project in your domain.

<?php
include('config.php');

function getAllProjects($apiToken,$domain,$url) {
   $curl = curl_init();

    curl_setopt_array($curl, array(
      CURLOPT_URL => $url,
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_ENCODING => "",
      CURLOPT_MAXREDIRS => 10,
      CURLOPT_TIMEOUT => 0,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_HTTPHEADER => array(
                'api-token:'.$apiToken,
                'domain:'.$domain
            )
    ));
    $response = curl_exec($curl);
    return $response;
}


$projectname = "XXXXX"; /*Project Name*/
/* Provides the list of projects created for your domain */
$projecturl  = $url.'project?name='.$projectname;
$allproject    = getAllProjects($apiToken,$domain,$projecturl);
echo $allproject;

?>

POST https://api.qatouch.com/api/v1/project

Test Cases

List Test Cases

Provides the list of test cases available for the project.

GET https://api.qatouch.com/api/v1/getAllTestCases/{projectKey}

Note: Replace Curly braces with your ID / Value

{projectKey} => your ID / Value

Example : https://api.qatouch.com/api/v1/getAllTestCases/ProjectKeyvalue

List Test Cases - Pagination

Provides the list of test cases available for the project.

GET https://api.qatouch.com/api/v1/getAllTestCases/{projectKey}?page=1

Note: Replace Curly braces with your ID / Value

{projectKey} => your ID / Project Key / Value

Example : https://api.qatouch.com/api/v1/getAllTestCases/ProjectKeyvalue?page=1

Return sample result

"link": {
        "first": "https://api.qatouch.com/api/v1/getAllTestCases/X1Gz?page=-1",
        "last": "https://api.qatouch.com/api/v1/getAllTestCases/X1Gz?page=123",
        "prev": null,
        "next": "https://api.qatouch.com/api/v1/getAllTestCases/X1Gz?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 0,
        "last_page": 1,
        "per_page": 50,
        "total": 6140
    },

Note: The above parameters can be used only one at a time and can't be requested with multiple parameters.

The view parameter can only be used with mode parameter.

Count Test Cases

Count of the total test cases available for the project.

GET https://api.qatouch.com/api/v1/count/allTestCases/{projectKey}

Note: Replace Curly braces with your ID / Value

{projectKey} => your ID / Project Key / Value

Example : https://api.qatouch.com/api/v1/count/allTestCases/ProjectKeyvalue

Test Cases - Custom Fields

Test Cases detail with mapped custom fields information

GET https://api.qatouch.com/api/v1/getTestCasesDetail/{projectKey}/{caseID}

Note: Replace Curly braces with your ID / Value

{projectKey}/{caseID} => your ID / Project Key / Value

Example : https://api.qatouch.com/api/v1/getTestCasesDetail/ProjectKeyvalue/CaseID

Test Cases - Steps Template

Test Cases detail with Steps detail

GET https://api.qatouch.com/api/v1/getTestCasesSteps/{caseID}

Note: Replace Curly braces with your ID / Value

{caseID} => your ID / Project Key / Value

Example : https://api.qatouch.com/api/v1/getTestCasesSteps/CaseID

List all Modules

Provides the list of Modules available for the project.

GET https://api.qatouch.com/api/v1/getAllModules/{projectKey}

Create Module

Create a new module in your project for Test Case.

POST https://api.qatouch.com/api/v1/module?projectKey={projectKey}&moduleName={moduleName}

<?php
include('config.php');

function getAllProjects($apiToken,$domain,$url) {
   $curl = curl_init();

    curl_setopt_array($curl, array(
      CURLOPT_URL => $url,
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_ENCODING => "",
      CURLOPT_MAXREDIRS => 10,
      CURLOPT_TIMEOUT => 0,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_HTTPHEADER => array(
                'api-token:'.$apiToken,
                'domain:'.$domain
            )
    ));
    $response = curl_exec($curl);
    return $response;
}


/*"project_name":"API Application","project_key":"BJaX" */
$projectkey = "BJaX";
$modulename = "New Module name33"; /*Module Name*/

/* Provides the list of projects created for your domain */
$projecturl  = $url.'module?projectKey='.$projectkey.'&moduleName='.$modulename;
$allproject  = getAllProjects($apiToken,$domain,$projecturl);
echo $allproject;

?>

Create Test Cases

Create a new Test Cases in your project.

POST https://api.qatouch.com/api/v1/testCase?projectKey={projectKey}&sectionKey={sectionKey}&caseTitle={caseTitle}

Releases

List Releases

Provides the list of Releases available for the project.

GET https://api.qatouch.com/api/v1/getAllMilestones/{projectKey}

Count Releases

Count of the total Releases available for the project.

GET https://api.qatouch.com/api/v1/count/allMilestones/{projectKey}

Create Release

Create a new Release in your project.

POST https://api.qatouch.com/api/v1/milestone

Test Plans

List of Test plans available for the project.

GET https://api.qatouch.com/api/v1/getAllTestPlan/{projectKey}

Count Test Plans

Count of the total Test Plans available for the project.

GET https://api.qatouch.com/api/v1/countTestPlan/{projectKey}

Test Runs

List Test Runs

Provides the list of Test Runs available for the project.

GET https://api.qatouch.com/api/v1/getAllTestRuns/{projectKey}

List Test Runs with filters

Provides the list of Test Runs the project by filtering the name of Test Runs.

GET https://api.qatouch.com/api/v1/getAllTestRuns/{projectKey}?name={name of testrun}

List Test Runs detail

Test Run detail

GET https://api.qatouch.com/api/v1/getTestRundetails/{projectKey}/{testrunkey}

Count Test Runs

Count of the total Test Runs available for the project.

GET https://api.qatouch.com/api/v1/count/allTestRuns/{projectKey}

List Test Run Results

Provides the list of Test Runs Results available for a Test Run.

GET https://api.qatouch.com/api/v1/testRunResults/{projectKey}/{testRunKey}

Test Runs & Results mapped with the Test case API

Provides the list of Test Runs Results mapped with test cases.

GET https://api.qatouch.com/api/v1/getTestRunlist/{caseID}

List Test Run Results for Release

Provides the list of Test Run Results available for a particular release.

GET https://api.qatouch.com/api/v1/testRunResults/{projectKey}/{releaseKey}

List Test Run Results History

Provides the list of History(s) available of Test Runs Results.

GET https://api.qatouch.com/api/v1/testRunResults/history/{projectKey}/{testRunKey}/{resultKey}

List Statuses for Test Run

Provides the list of available statuses for Test Runs.

GET https://api.qatouch.com/api/v1/testRuns/getAvailableStatuses

Update Test Run Status

Update the status for the test run.

PATCH https://api.qatouch.com/api/v1/testRunResults/status?status={status}&project={projectKey}&test_run={testRunKey}&run_result={resultKey}&comments={comments}

Bulk Update Status for test run

The test run's all test cases status will be updated at once.

PATCH https://api.qatouch.com/api/v1/bulkupdate?status={status}&project={projectKey}&test_run={testRunKey}

List all available Users for Testing

Provides the list of Users in the project available for Testing.

GET https://api.qatouch.com/api/v1/testRun/availableUsers/{projectKey}

Create Test Run (all test cases)

Create a new Test Run in your project.

POST https://api.qatouch.com/api/v1/testRun

Add Test Run Results - Comments and Attachment

Add the result to a specific test run result with comments, time spent and attachments

POST https://api.qatouch.com/api/v1/testRunResults/add/
      results?status={status}&project={projectKey}
      &test_run={testRunKey}
      &run_result[]={resultKey}
      &run_result[]={resultKey}
      &comments={comments}
      &time_spent={timeSpent}

Headers

Form-Data

Parameters

Create Test Run (specific test cases)

Create a new Test Run in your project by selecting specific test cases.

POST https://api.qatouch.com/api/v1/testRun/specific?projectKey={projectKey}&assignTo={assignTo}&milestoneKey={milestoneKey}&testRun={testRun}&caseId[]={caseId} &caseId[]={caseId}&caseId[]={caseId}&tags={tagsName}

Provides the list of steps in the Test Run Cases

GET https://api.qatouch.com/api/v1/getTestCasesSteps/{caseID}

Provides the list of steps in the Test Cases

GET https://api.qatouch.com/api/v1/getTestCasesSteps/{caseID}

Update the status for steps in the Test Run

PATCH https://api.qatouch.com/api/v1/testRunResults/steps/status?project={projectKey}
        &test_run={testRunKey}&status={status}&result_step[]={stepResultKey}
        &result_step[]={stepResultKey}&comments={comments}

Defects

List Defects

Provides the list of Defects available for the project.

GET https://api.qatouch.com/api/v1/getAllDefects/{projectKey}

List Defects Statuses

Provides the list of available defect statuses.

GET https://api.qatouch.com/api/v1/defects/status

List Defects Severity

Provides the list of available defect severity.

GET https://api.qatouch.com/api/v1/defects/severity

List Defects Issue Type

Provides the list of available defect Issue Type.

GET https://api.qatouch.com/api/v1/defects/issueType

List Defects Environments

Provides the list of available defect environments.

GET https://api.qatouch.com/api/v1/defects/environment

List Defects Priority

Provides the list of available defect priority.

GET https://api.qatouch.com/api/v1/defects/priority

Count Defects

Count of the total Defects available for the project.

GET https://api.qatouch.com/api/v1/count/allDefects/{projectKey}

Create Defect

Create a new Defect in your project.

POST https://api.qatouch.com/api/v1/defects?projectKey={projectKey}&priority={priority}&issueSummary={issueSummary}

Create Defect - Multi File Attachment

Create a new Defect in your project.

POST https://api.qatouch.com/api/v1/defects?projectKey={projectKey}&priority={priority}&issueSummary={issueSummary}

Headers

Form-Data

Parameters

Requirements

List Requirements

Provides the list of Requirements available for the project.

GET https://api.qatouch.com/api/v1/getAllRequirements/{projectKey}

Count Requirements

Count of the total Requirements available for the project.

GET https://api.qatouch.com/api/v1/count/allRequirements/{projectKey}

List Requirement Documents

Provides the list of Requirement Documents created for your domain.

POST https://api.qatouch.com/api/v1/getAllRequirementDocuments/{projectKey}

Create Requirement Document

Create a new Requirement Document in your project.

POST https://api.qatouch.com/api/v1/requirement/document

Create Requirement

Create a new Requirement Document in your project.

POST https://api.qatouch.com/api/v1/requirement