Versions Compared

Old Version 7

changes.mady.by.user Kevin Pham

Saved on

compared with

New Version 8

changes.mady.by.user Helen Kosova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Zephyr for JIRA Cloud is now open for integration

ZAPI Cloud exposes Zephyr for JIRA Cloud data via

Zephyr for Jira Cloud exposes its data via a REST APIs which allows you to access the data programmatically and build your own

integration with Zephyr for JIRA Cloud. This guide is intended for developers and testers.
Child pages (Children Display)
 

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 pro-grammatically.

Using ZAPI Cloud's capabilities, Zephyr for JIRA Cloud users can

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
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

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

...

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)

...

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

...

Community

...

  • .

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 test execution cycle and update the status of a test execution run after its has been executed in an automation tool.


Reference

Interactive API documentation is available at the following link, along with code examples in cURL, C#, JavaScript, Python, and other languages.

https://zfjcloud.docs.apiary.io

Rate Limits

  • 1,000 requests per hour.
  • 24,000 requests per day.

Authentication

All API calls require authentication using JWT access tokens. For details, see Generate a JWT Authentication Token and Execute APIs in ZAPI Cloud.

Remarks

  • There are pagination limits.
  • Encoding affects status character counts.

Got Questions?

Ask your questions in the Zephyr for Jira Cloud community, or contact Supportfor assistance.

See Also

Test Automation API