how to generate an api-key for RESTful API

Wednesday, March 2, 2016 7:58:40 AM
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:
http://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 5:31:48 PM
Avatar
re: chris.li on Wednesday, March 2, 2016 7:58:40 AM
Hi Chris

You can get the API Key (also known as the RSS Token) (which is a simple GUID) by following these steps:
  1. Click on the User Profile menu in the application header
  2. Click on 'My Profile'
  3. The GUID listed in the RSS Token text box is the one to use.
  4. If you don't see an RSS Token in that box, then click on 'Enable RSS Feeds' so that it is checked
  5. Click the button 'Generate New' to get a new RSS token
  6. Click [Update] to save your changes
Regards

Sarah
Friday, March 4, 2016 9:35:35 AM
Avatar
re: inflectra.sarahx on 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
Statistics
  • Started: Wednesday, March 2, 2016 7:58:40 AM
  • Last Reply: Friday, March 4, 2016 9:35:35 AM
  • Replies: 2
  • Views: 1147