Zephyr for
JIRAJira Server is now open for integration
ZAPI exposes Zephyr for JIRA Jira data via REST APIs which allows you to build your own integration with Zephyr for JIRAJira. This guide is intended for developers and testers.
| Child pages (Children Display) |
|---|
What is ZAPI?
ZAPI (or Zephyr API) is an Add-on to Zephyr for JIRAJira that allows access to its testing data including the ability to view and upload information programaticallyprogrammatically.
Using ZAPI's capabilities, Zephyr for JIRA 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 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 Jira Server versions 2 and higher
- A valid license of Zephyr for JIRA Jira Server is needed for ZAPI to work
- ZAPI is only available for Zephyr for JIRA 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 Jira (which in turn uses JIRAJira's security model)
To get started, you need to be a JIRA Jira Admin. First confirm that you have a valid installation of Zephyr for JIRA Jira in your JIRA Jira instance. From JIRAJira's UPM, search for "ZAPI" and install it. This is a quick process and once installed, Zephyr for JIRAJira'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 curlcURL, C#, javascriptJavaScript, nodeNode.js, Python, pythonPHP, php and rubyRuby.
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.