Page tree
Skip to end of metadata
Go to start of metadata

Zephyr for JIRA Cloud is now open for integration

ZAPI Cloud exposes Zephyr for JIRA Cloud data via REST APIs which allows you to build your own integration with Zephyr for JIRA Cloud. This guide is intended for developers and testers.
 

What is ZAPI Cloud?

ZAPI (or Zephyr API) Cloud is an Add-on to Zephyr for JIRA Cloud that allows access to its testing data including the ability to view and upload information programatically.


Using ZAPI Cloud's capabilities, Zephyr for JIRA Cloud 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 Cloud is to create a test in a separate tool/system and add it to Zephyr for JIRA Cloud 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 Cloud:
  • ZAPI Cloud works only with Zephyr for JIRA Cloud
  • A valid license of Zephyr for JIRA Cloud is needed for ZAPI Cloud to work
  • ZAPI Cloud is only available for Zephyr for JIRA Cloud
  • 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 Cloud (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 Cloud in your JIRA instance. From JIRA's UPM, search for "ZAPI Cloud" and install it. This is a quick process and once installed, Zephyr for JIRA Cloud's data is available to access via RESTful calls.

Usage Limits

Refer to ZAPI Cloud Usage Limits.

 

ZAPI Technical Documentation

Detailed and interactive ZAPI Cloud 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 developer community for the latest news, FAQs, samples and discussions.
  • No labels