Chapter 13. The Remote API

Table of Contents

13.1. Overview
13.2. REST Clients
13.3. Documentation

13.1. Overview

Klaros-Test­management Enterprise Edition comes with a REST-based interface which can be used to retrieve data like test cases, results or information about users. The data can be retrieved either in XML or JSON format. The API is accessible from the URL http://{host}:{port}/klaros-web/api/v1/resources/.

JSON Output after Searching for a User by its Name.

Figure 13.1. JSON Output after Searching for a User by its Name.


13.2. REST Clients

There are numerous ways to connect to the remote API. The following lists give an overview of some freely available clients.

Browser Plugins

13.3. Documentation

Klaros-Test­management comes with an interactive documentation for the Remote API which can be accessed from a browser at http:/{host}:{port}/klaros-web/api-doc/resources/.

Remote API Documentation

Figure 13.2. Remote API Documentation