Detailed documentation on QMetry REST APIprovides all the details a developer would need for each of the API calls that are supported with code samples. The Headers, Body and Response provided here are for your reference only. You can use tools like Postman to try these APIs.
...
(1) APIKeyAuth: Supply the apikey generated from the app from QMetry > Configuration > Open API.
...
(2) The authentication depends upon the settings of basic authenticationin Jira (Settings > System > Authentication Methods > Allow basic authentication on API calls). Administrators can enable/disable basic authentication.
Option 1: If the Allow basic authentication on API calls option is enabled in Jira, then BasicAuth is required for authentication.
BasicAuth: Authorization (Basic authentication with Jira's credentials)
This Automation REST API is protected by the restrictions provided by Jira. You need to log in to Jira using the Basic Auth header. Follow the below steps to generate basic Auth and pass it to the request header :
1. Build a string of the form username:password
2. Encode the string in Base64 format.
3.Pass Supply an "Authorization" header with content "Basic" followed by the encoded string. For example, the string "fred:fred" encodes to "ZnJlZDpmcmVk" in base64, so you would make the request as follows.
|
Option 2: If the Allow basic authentication on API calls option is disabled in Jira, then Personal Access Token is required for authentication.
Bearer Token: Authorization (Personal Access Token)
This Automation REST API is protected by the restrictions provided by Jira. You need to use the Bearer Token header to call the REST APIs.
To use personal access token, perform the following steps:
Go to User Profile.
Click on Personal Access Tokens and click on Create token.
Supply an "Authorization" header with content "Bearer" followed by generated token.
|
Grouping of APIs
You can see the groups of APIs listed on the panel at the 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.
...
Request Type: API request type.
URL: The base URL will be as per your Jira instance.
Request:
Headers: Provide headers.
Content-Type : application/json
apiKey : {generated-api-key from QMetry > Configuration > Open API}
Authorization :Basic ZnJlZDpmcmVk
...