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.
Once you receive the QMetry REST API documentation link from QMetry Support Team, follow the this document.
Open the QMetry REST API documentation link to view and try all APIs.
The main page of API documentation is divided into two sections:
A. Authentication
B. Grouping of APIs
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.
QMetry authenticates all the REST API requests using api key. API Key can be generated from QMetry Test Management, go to Integration > Open API.
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.
The Example panel displays corresponding details of the selected API.
Additional Body Parameters
To see additional parameters to be passed in request body click on 'SHOW JSON SCHEMA'.
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.
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.