TestLink

TestLink REST API Guide

Contents hide
1 Overview
2 Pre-requisites
3 CRUD Operations
4 Manual API Test Tool
5 API Versions
6 Anatomy of API Request
7 Execute a Sample API call
8 Advantages
9 Debugging REST API errors
10 Sample REST API calls

Overview

In this tutorial guide, we will learn how to execute TestLink Rest API requests and some sample API endpoints. REST stands for Representational State Transfer. REST allows interaction with systems that are built on HTTP standard protocol. REST is an alternative to legacy systems that are built on SOAP(Simple Object Access Protocol).

Pre-requisites

  • TestLink instance up and running

To execute TestLink Rest API calls, we need to have Testlink Web application up and running without any issues. Log in as the API user into the TestLink web application.

  • Install Slim Framework on TestLink instance

https://www.testingdocs.com/install-slim-framework-on-windows/

CRUD Operations

CRUD stands for Create, Read, Update, and Delete. These are the major operations that API calls perform on the server-side resources.

The analogous REST verbs for these operations are as follows:

  • Create -> POST method.
  • Read -> GET method.
  • Update -> PUT method.
  • Delete -> DELETE method.

 

 

CRUD Operations

Manual API Test Tool

We use Postman for testing and executing the REST API calls. A quick overview and download steps can be found at:

https://www.testingdocs.com/postman-api-tool/

API Versions

There are multiple versions for the TestLink REST API endpoints, like.

  • v1
  • v2
  • v3

We can specify the version in the REST endpoint URL.

http://<server_testlink_home>/lib/api/rest/v1/who

http://<server_testlink_home>/lib/api/rest/v2/who

 

TestLink REST API Versions

Anatomy of API Request

Below is a TestLink REST API request executed to get the project’s information. Let’s understand the API request shown.

TestLink API Request

1- API endpoint. The server listens to the API request on this endpoint. Testlink might have many exposed endpoints each for a specific purpose.

2- HTTP method for the request. The shown call is a GET call.

3- Authorization – We need to specify the APIKEY

4- Request Headers for the API request.

5 – Response code – 200 OK means Success.

6 – Response Body received from the TestLink server.

Execute a Sample API call

https://www.testingdocs.com/how-to-execute-rest-api-call-using-postman/

Advantages

Rest API allows us to interact with TestLink interaction in an automated fashion.

API opens doors to the integration with other components like Mantis BTS, Jira, etc.

Debugging REST API errors

https://www.testingdocs.com/questions/how-to-fix-slim-application-error-in-testlink/

https://www.testingdocs.com/questions/how-to-fix-400-bad-request-error-in-testlink-api/

Sample REST API calls

Related Posts