How to access Zephyr test cycles using Rest API

[prag kalra]

Want to access Test Cycles created in a particular project . How we can access the test cycles using REST API

[Nic Brough -Adaptavist-]

How are you storing these test cycles in JIRA?

[Sam Hall]

You need to use ZAPI. See: https://www.getzephyr.com/buzz/press-releases/zephyr-announces-zapi-add-cloud-enable-continuous-software-testing

[Sam Hall]

p.s. your screenshot gives away user and company data, so you should probably block out the personal details or delete it from this question.

[prag kalra]

Hi @Sam Hall

We already installed a Zephyr in JIRA . 

Do we need to install another plugin ZAPI to communicate using rest APIs or this was a part of Zephyr. ?

[Nic Brough -Adaptavist-]

You do need to install the ZAPI add-on as well as Zephyr.

[prag kalra]

Hi @Nic Brough [Adaptavist] / @Sam Hall

Already installed both Zypher / ZAPI add-on. [Screenshot 1-3]

But still not able to connect ZAPI api . [Screenshot 4]

http://JIRA Server URL /jira/rest/zapi/latest/util/project-list

Correct us if we need to enable something or something wrong on url ?

1.png

2.png

3.png

4.png

[Sam Hall]

I think you are using the wrong endpoint. 

Have a look here: https://support.getzephyr.com/hc/en-us/articles/115000412763-Getting-Started-with-ZAPI-Cloud

This mentions the base URI for Zapi API calls is: https://prod-api.zephyr4jiracloud.com/connect/

See also: https://zephyrdocs.atlassian.net/wiki/display/DEVELOPER/ZAPI+Cloud

If you have more questions or need help, you should probably raise requests directly with the vendors of Zephyr/ZAPI at: https://support.getzephyr.com

[prag kalra]

HI @Sam Hall

Used this reference link to fetch the test data , but not able to . Receving 404 when trying to hit for 

https:/xxxxxxxxxx Server url /connect/public/rest/api/1.0/teststep/48938

Is this API is correct ? 

I am currently using a trial version of ZAPI . Is it allows me to connect to API ?

https://bitbucket.org/ErnestChristley/zfj-importer/src/cf11cd383fc3f9c07f299687e570c4348bb07c5b/src/main/C%23/Reporting.cs?fileviewer=file-view-default

[prag kalra]

Also when tried to fetch the project list using following :

https://XXXXXX/jira/rest/zapi/latest/util/project-list

Receiving 401 - is the below syntax is correct ?

401.png

[Sam Hall]

I don't know, I'm afraid.

Did you have a look on the Zepyhr/Zapi support pages? There is plenty of info there.

The API documentation gives the details of how to get test steps here: http://docs.zfjcloud.apiary.io/#reference/teststep/get-update-and-delete-teststep/get-teststep. 

And there is this about the 401: https://support.getzephyr.com/hc/en-us/articles/115000308283-401-error-while-making-ZAPI-Cloud-API-requests

Maybe someone on here will give you better answers but, as said in my comment above, it is probably better if you send questions directly to Zephyr.

Why not follow the "Have more questions? Submit a case" link in their getting started guide?:

zapi-submit-a-case.png

This takes you to a page where you can sign-up and raise support case/questions with the people who built the add-ons. I'm sure they will be much more knowledgable than me:

zephyr-sign-up.png

[Sam Hall]

p.s. just to double check:

I think you should be using a url starting with https://prod-api.zephyr4jiracloud.com/connect/, not your JIRA url.

[vivek nighojkar]

@prag kalra

Can you please try to use https://XXXXXX/rest/zapi/latest/util/project-list

this URL. You need to remove "jira" keyword from url, this workes for me.

I was also using the wrong URL.

[test12018]

Hi , can some one help if they have done integration with zephyr for test automation , like able to access BDD test cases from the provided test cycle and download them to local feature file , execute using automation and update back the results ? Any leads will be highly appreciated and thank you much in advance.