ZAPI exposes Zephyr for Jira data via REST APIs which allows you to build your own integration with Zephyr for Jira. This guide is intended for developers and testers.
What is ZAPI?
ZAPI (or Zephyr API) is an Add-on to Zephyr for Jira that allows access to its testing data including the ability to view and upload information programmatically.
Using ZAPI's capabilities, Zephyr for Jira users can:
- 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
A typical example of the usage of ZAPI is to create a test in a separate tool/system and add it to Zephyr for Jira or create an test execution cycle and update the status of a test execution run after its has been executed in an automation tool.
The APIs provide 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 and retrieve search results
Getting Started
There are a few quick things to be aware of about ZAPI:
- ZAPI works only with Zephyr for Jira Server versions 2 and higher
- A valid license of Zephyr for Jira Server is needed for ZAPI to work
- ZAPI is only available for Zephyr for Jira Server
- The API is entirely HTTP-based
- Parameters have certain expectations
- There are pagination limits
- Encoding affects status character counts
- No anonymous access is allowed; the security model is the same as that of Zephyr for Jira (which in turn uses Jira's security model)
To get started, you need to be a Jira Admin. First confirm that you have a valid installation of Zephyr for Jira in your Jira instance. From Jira's UPM, search for "ZAPI" and install it. This is a quick process and once installed, Zephyr for Jira's data is available to access via RESTful calls.
ZAPI Technical Documentation
Detailed and interactive ZAPI Server documentation provides all the details a developer would need for each of the API calls that are supported with code samples available in cURL, C#, JavaScript, Node.js, Python, PHP, and Ruby.
FAQ
Check out the Knowledge Base developer section on the Support site to get your questions answered or to see samples.
Community
Check out the Zephyr ZAPI Server developer community for the latest news, FAQs, samples and discussions.