Skip to main content

Rest API

info

Some of the endpoints use URL parameters. Make sure you are familiar with how to use it with POSTMAN. Use REST APIs Using Postman.

The Reporter provides you with a Rest API that gives you direct access to the test data and statistics. some of these commands can be done in the reporter web portal. 

The user performing the Rest Operation is authorized by the 'Authorization' header of type 'Bearer' by Access Key.

For more information see How To Execute Rest API.

The following sections provide details in the usage of these APIs.

Concepts

  • Keys - Key and value construct a tag. Each test has a subset of available tags with various values that describe the test specifics. Example: date.
  • Projects - Concept derived from the cloud. Each project has it's own resources (users, devices) and can be used to created a separation of testing efforts.
  • Tests - Single test execution instance

Authentication​

If the Reporter server is configured to be secured, you need to authenticate all the requests to the server.

We support these authentication methods:

Basic Authentication​

Add the authentication headers as follows:

Authentication: Basic < Base64 encoded <username>:<password> >
ReporterProject: <project name>

Access Key

Generate access from Continuous Testing Cloud.

This key identifies the user and its project.

For additional information about generating access keys in Continuous Testing Cloud, see Rest API - Keys.

Add the token to your request as follows:

Authentication: Bearer <access key>

The examples use the Unirest HTTP library.  To compile and run them, use the following Maven dependency:

Maven Dependency

<dependency>
    <groupId>com.mashape.unirest</groupId>
    <artifactId>unirest-java</artifactId>
    <version>1.4.9</version>
</dependency>
Last updated on