Date: Tue, 19 Mar 2024 09:18:27 +0000 (UTC) Message-ID: <1581864537.21.1710839907033@128d5d481ad3> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_20_250863929.1710839907033" ------=_Part_20_250863929.1710839907033 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Zephyr for Jira is now Zephyr Squad= ! Read more about this. = th> |
---|
Zephyr for Jira Cloud exposes its data via a REST API which allows you t= o access the data programmatically and build your own integrations. You can= use the API to:
Integrate with test automation tools.
Integrate with continuous integration tools.
Create extensive custom reports for testing.
Integrate with business intelligence tools.
Use the testing data for other purposes.
For example, you could build an integration that would create a test in = a separate tool/system and add it to Zephyr for Jira Cloud or create an tes= t execution cycle and update the status of a test execution run after its h= as been executed in an automation tool.
To create, run, and manage Test Automation jobs, use the Test Automation = API instead.
Previously, to access Zephyr for Jira Cloud REST API you had to install = an additional plugin (ZAPI). As of August 2020, the API is available out-of= -the-box, and the ZAPI plugin is no longer needed.
Interactive API documentation is available at the following link, along = with code examples for cURL, C#, JavaScript, Python, and other languag= es.
https://zfjcloud.docs.apiary.io
The API provides the following capabilities:
Get information about users, projects, releases, tests, execution cycles= .
Create new tests and test execution cycles.
Update tests, test execution status.
Add attachments to existing execution cycles.
Run ZQL queries and retrieve search results.
The base URL for API calls is:
https:/= /prod-api.zephyr4jiracloud.com/connect
For example, POST /public/rest/api/1.0/attachment
means a P=
OST request to https://prod-api.zephyr4jiracloud.com/connect/public/r=
est/api/1.0/attachment
.
The API uses JWT tokens for authentication. All requests must inc= lude the following headers:
zapiAcc= essKey: YOUR_ACCESS_KEY Authorization: JWT GENERATED_JWT_TOKEN
where:
YOUR_ACCESS_KEY
is the access key found in the API =
Keys section of Zephyr for Jira Cloud.
GENERATED_JWT_TOKEN
is the JWT token generated for this spe=
cific request. To learn how to generate JWT tokens, see this page.=
p>
JWT tokens are generated using several pieces of information, including = the API endpoint you want to call, and query parameters (if any). This mean= s that to call multiple different endpoints or call the same endpoint but w= ith different query parameters you must generate a new JWT token for each A= PI call.
Most operations that accept a request body expect it in the JSON format.=
POST and PUT request containing a JSON request body must include the&nbs=
p;Content-Type
header:
Content= -Type: application/json
1,000 requests per hour.
24,000 requests per day.
There are pagination limits.
Encoding affects status character counts.
Ask your questions in the Zephyr for J= ira Cloud community, or contact Support for assistance.