API Version 1

NOTE: API V1 is depreciated, please use API -V2 methods instead.

Rest API

This document describes the REST API and resources provided by PractiTest. The REST APIs are for developers who want to integrate PractiTest into their application, synchronize issue trackers or develop any other tool integration with PractiTest. The API also enables organizations to update their automated test results into PractiTest.

 

PractiTest’s REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP(s) request and parse the response. Currently, the only supported response format is JSON. Your methods will be the standard HTTP(s) methods like GET, PUT, POST and DELETE (see API descriptions details for which methods are available for each resource).

Because the REST API is based on open standards, you can use any web development language to access the API.

REST URIs Structure

URIs for PractiTest’s REST API resource have the following structure:
https://api.practitest.com/api/v1/resource-name
(for v2 use: https://api.practitest.com/api/v2/resource-name)

Authentication

Use the api_token as a parameter in each of the requests. The value of the api_token can be found in the Account Settings.

So a GET request, can be something like this:
https://api.practitest.com/api/v1/resource-name.json?api_token=your_api_token, but we do recommend to put the api_token in the Header, within an “Authorization” key:

{Authorization => custom api_token=YOUR_API_TOKEN}

Best Practice

Since you can create as many api_tokens as needed, rename them, disable and enable them, it is a best practice to give different api_tokens to different (code) purposes / business needs. Once you may have different business needs, or you’ll need to disable one of the functionality, it will be easier for your to just disable one API_Token at a time.

 

Api Resources

and here is an example for a post request, to update automated test results:

Here’s a POST request example in C#


For example, in Java, this is what needs to be add to the request:
An example of the authentication in PHP:

Here is the full Get request In ruby:

See more example in the specific resources (code examples).

 

<< Previous Next >>
Shift your testing Forward