Skip to main content
All CollectionsAutomation & API
Automate with API using TestCollab SDK
Automate with API using TestCollab SDK

TestCollab SDK allows users to call API endpoints, build custom workflows, reports, integrations with CI/CD pipelines and more.

Abhimanyu Grover avatar
Written by Abhimanyu Grover
Updated over a week ago

Installation

To install the library, use npm:

npm install testcollab-sdk

Usage Example

You'll need to authenticate the client before you can use any methods.

There are 2 possible authentication methods:

  1. API key: To generate API key: login to your TestCollab account and go to 'My Profile Settings' and switch to API Token tab. Click on "Generate new API token".

  2. Access token: This requires logging into API programmatically with this SDK using login method which will provide a auth token.

For the purpose of this documentation, we'll stick to the API key based authorization.

Authentication

API Key method:

import { Configuration, TestPlansApi, TestPlanTestCasesApi, TestPlansAssignmentApi } from 'testcollab-sdk';

let apiKey = '123456-abc';

let config = new Configuration({
fetchApi: (url, options) => {
// append the token to the url if no query string is present
if (!url.includes('?')) {
url = url + '?token=' + apiKey;
}
else {
url = url + '&token=' + apiKey;
}
return fetch(url, options)
},

})
const testPlansApi = new TestPlansApi(config);

Test Plan Add

        const response = await testPlansApi.addTestPlan({
testPlanPayload: {
project: 1234,
title: 'From SDK',
description: 'This is a test plan is created using the Node.js SDK',
status: 1,
priority: 1,
testPlanFolder: null,
customFields: []

}
});

// get the test plan id
const testPlanId = response.id;
console.log('Test Plan ID: ' + testPlanId)

Add New Test Cases to Test Plan

        const testPlanCases = new TestPlanTestCasesApi(config);

const res2 = await testPlanCases.bulkAddTestPlanTestCases({
testPlanTestCaseBulkAddPayload:
{
testplan: testPlanId,
"testCaseCollection": {
testCases: [1, 2, 3],
selector: []
}
}
});
//console.log(res2)

Assign test cases to a tester in test plan

        const testPlanAssignment = new TestPlansAssignmentApi(config);
const res3 = await testPlanAssignment.assignTestPlan({
project: 1234,
testplan: testPlanId,
testPlanAssignmentPayload: {
"executor": "me",
"assignmentCriteria": "testCase",
"assignmentMethod": "automatic",
"assignment": {
"user": [2],
"testCases": {
"testCases": [],
"selector": []
},
"configuration": null
},
"project": 1234,
"testplan": testPlanId
}
})
console.log(res3)

API Documentation

Detailed API documentation is available at Test Collab OpenAPI specs.

Did this answer your question?