How to use QMetry API tool

Detailed documentation on QMetry REST API provides all the details a developer would need for each of the API calls that are supported with code samples available in javascript, node.js, curl, C#, python, ruby and php.

The QMetry API tool is available to those QMetry users who has purchased QMetry Open API app and requested for the API tool to QMetry Support team. Once you receive the QMetry REST API documentation link from QMetry Support Team, follow this document.

Overview of QMetry Open API Documentation

Open the QMetry REST API documentation link to view and try all APIs.

The main page of API documentation shows Grouping of APIs.

Generate Open API Key

QMetry authenticates all the REST API requests using API Key. API Key can be generated from QMetry Test Management, go to Integration > Open API.

Benefits of using QMetry API tool

  • You get live instance to test your API, you do not need separate testing tool to test the APIs.

  • Headers and Parameters are predefined, just give API Key and trigger the testing.

  • You can get the output in your preferred multiple languages.

Grouping of APIs

You can see the groups of APIs listed on the panel at left. Just click on the section you want to view and use the APIs of. The section is expanded on the left as well as on the right panel showing APIs under it.

To access an example of a particular API, click on it in the right panel.

For example,

You want to use API of Create/Update Test Case.

  1. Expand the Test Case API group on the panel at left and select Create/Update API.
  2. On the right panel, again click on the Create API. It displays relevant Example on the third panel.

Understanding the Example

The Example panel displays corresponding details of the selected API.

  • Request Type: API request type.
  • URL: The URL will remain same for all the users of QMetry for Cloud.
  • Request: Make sure you select Production server and select the language you want to generate the code in.
    • Headers: Provide API Key here. Generate your API Key for authentication from QMetry > Integration > Open API as described above.
    • Body: The section displays mandatory parameters for the API. If you want to view more available parameters, then click on Show JSON Schema as shown in the Additional Body Parameters .
  • Response: You can view corresponding response for the request.

Additional Body Parameters

To see additional parameters to be passed in request body click on 'SHOW JSON SCHEMA'. 

Try Live Example

If you want to try a live example of API, click on the Try button for the API request.

The console view switches to Example.

  • URL: The URL will remain same for all the users of QMetry for Cloud.
  • apiKey: Enter apiKey that you generated in QMetry Test Management (Integration > Open API).

  • Body: The Request Body displays mandatory system parameters. You can define more parameters for the API as per requirement. Refer to Additional Body Parameters.

  • Run API : Click "Call Resource" to run the API.

As this is a live example, the API will run directly on your QMetry instance.

You can see the API Call response.

You can see the corresponding impact in the QMetry instance.

Here, we've tested Create Test Case API. A new test case is created in QMetry.