What is ZAPI exactly?

[goossen visscher]

Hello All,

I am pretty new to this so forgive me if my question is too basic. I have this burning question.

What are ZAPI calls exactly? For example, I read:

'ZAPI exposes Zephyr for JIRA data via REST APIs ' source: https://zephyrdocs.atlassian.net/wiki/spaces/DEVELOPER/pages/33095703/ZAPI+Server

On other pages I read that ZAPI is RESTful. RESTful means any API that meets the requirements of REST API. 

I was explained that ZAPI is a different technology from REST API. I was explained that this is a different protocol. You would either use ZAPI or REST but they are not the same. 

I am a little confused now and would like to get some more information on what exactly ZAPI is and if it is, or uses REST API.

[Naveen K S · Accepted solution]

ZAPI is a full functionality free plugin that allows you to access Zephyr for Jira and its functionality programmatically. It uses REST API’s to achieve the same. There are many use cases where you would want to either push or extract data into Zephyr for Jira programmatically, ZAPI is the only way you can do it.

A typical use case would be weekend maintenance, as part of which you would want to restart and re-index Jira and consequently you would want to re-index Zephyr as well, all this can be done via a script which can programmatically perform the steps and such a script can be schedule to run at a predefined time.

There are other much more powerful automations possible since ZAPI is a fully functional API that can help you automate most Zephyr workflows.

[Pete Singleton · Accepted solution]

Zephyr is a 3rd party app for Jira, for Test Management:

https://marketplace.atlassian.com/apps/1014681/zephyr-for-jira-test-management

ZAPI is an additional app that exposes Zephyr data via a REST API:

https://marketplace.atlassian.com/apps/1211674/zapi

If you just want to access Jira data (without Zephyr) via the REST API, this is standard and requires no apps:

https://developer.atlassian.com/server/jira/platform/rest-apis/

[Manish Upadhyay]

Hi Pete, ZAPI is currently not available in that URL https://marketplace.atlassian.com/apps/1211674/zapi. Can you please help me to find ZAPI?

Thanks,

Manish

[larry_lowe]

Previously, to access Zephyr for Jira Server REST API, you had to install an additional plugin (ZAPI). As of October 2020, the API is available out-of-the-box, and the ZAPI plugin is no longer needed.

Source: https://zephyrdocs.atlassian.net/wiki/spaces/DEVELOPER/pages/33095703/REST+API

[Manish Upadhyay]

So in place of ZAPI what can we used? 

[goossen visscher]

Thank you for that.