Develop Test Management Solutions Effectively

Zephyr APIs

Zephyr is open for integration

Zephyr exposes its data via Web Services Application Programming Interfaces (API) which allows you to build your own integrations with Zephyr. This guide is intended for developers.

Learn

API Overview
Getting Started
API Technical Documentation
Test Your Integration

API Overview

The Zephyr Web Services APIs provide the ability for you to integrate Zephyr services into your application. A typical example of the usage of Zephyr APIs is to create a testcase in a separate tool/system and add it to the Zephyr testcase repository or create an execution cycle and update the status of a testcase execution run.

The APIs provide the following capabilities:

Get information about users, projects, releases, testcase repositories and the underlying folders, testcases, custom fields, execution cycles
Create new testcase folders, testcases, execution cycles, execution phases
Add attachments and phases to existing execution cycles
Assign test execution schedules
Update testcases, testcase execution status

Getting Started

There are a few quick things to be aware of about the Zephyr APIs:

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 in the UI

Based on your development environment of choice, the following documentation will get you going quickly with setting up and developing your integration to Zephyr:

Getting Started with Zephyr API for JAVA [HTML] [PDF]
Getting Started with Zephyr API for Perl [HTML] [PDF]
Getting Started with Zephyr API for Python [HTML] [PDF]
Getting Started with Zephyr API for PHP [HTML] [PDF]

API Technical Documentation

The Zephyr API is published through a Web Services Description Language (WSDL). (It can also be accessed from http://your_zephyr_server_name_here/flex/services/soap/zephyrsoapservice-v1?wsdl). The Zephyr API Reference documentation provides all the details a developer would need for each of the API calls that are supported.

For Zephyr Enterprise and Community Editions 3.6:

For Zephyr Enterprise and Community Editions 3.5:

Test Your Integration

In order to test your integration, we suggest using a tool such as soapUI. You can download a version of that software, install it and try out the sample code shown here. This will first ensure that you can indeed connect to the Zephyr server and second, will give you a very good idea on how calls are made to it and what the response is. These sample scripts become a great starting point to build your own integration.

Samples

We've created a few sample scripts that, once loaded in a tool like soapUI, will allow you to run and watch the interaction with the Zephyr server. Download one of these XML files (as per your Zephyr version) and open it inside of your soapUI utility.

For Zephyr Enterprise and Community Editions 3.6: