Skip Navigation LinksHome Page > Forums > SpiraTeam Forums > SpiraTeam Issues & Qu... > how to generate an api-ke...

how to generate an api-key for RESTful API

Wednesday, March 2, 2016

Hi:

We have an on-premise installation of Spirateam, and we are making some efforts to utilize its RESTful api for integration purpose.

In the manual:

https://www.inflectra.com/SpiraDemo3/Services/v4_0/RestService.aspx

It says:

Pass in the username application API-Key using the username and api-key HTTP headers:

                            username: fredbloggs
                            api-key: {XXXXXXXXXXXXXXXX}

I have a very simple problem here, how can this api-key be generated?

Thanks in advance.

2 Replies

Wednesday, March 2, 2016

~~inflectra.sarahx~~

re: chris.li Wednesday, March 2, 2016

Hi Chris

You can get the API Key (also known as the RSS Token) (which is a simple GUID) by following these steps:

Click on the User Profile menu in the application header
Click on 'My Profile'
The GUID listed in the RSS Token text box is the one to use.
If you don't see an RSS Token in that box, then click on 'Enable RSS Feeds' so that it is checked
Click the button 'Generate New' to get a new RSS token
Click [Update] to save your changes

Regards

Sarah

Friday, March 4, 2016

re: inflectra.sarahx Wednesday, March 2, 2016

It works, Thank you very much for your help.

"API Key (also known as the RSS Token)"

If you had put this "Also known" part into your documentation, hours of frustration could be saved, could you suggestion is to add this to your RESTful api documentation? to avoid confusing more new-users like me.

Thank you

Spira Helps You Deliver Quality Software, Faster and With Lower Risk

And if you have any questions, please email or call us at +1 (202) 558-6885

Statistics

Started: Wednesday, March 2, 2016
Last Reply: Friday, March 4, 2016
Replies: 2
Views: 11097