From Theory to Practice: Utilizing SpiraPlan's REST API
Download as PPTX, PDF0 likes127 views
The document outlines a webinar focused on utilizing Spiraplan's REST API, covering setup, Postman configuration, and executing API requests. It features presentations from experts at Mverve and Inflectra, detailing key functionalities and use cases for the API. The session concludes with resources for further assistance and an invitation for future engagement.
From Theory to Practice: Utilizing SpiraPlan's REST API
- 1. ® 1 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra mVerve <> Inflectra - Webinar From Theory to Practice: Utilizing SpiraPlan's REST API 14th May, 2024
- 2. ® 2 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra ● Introduction: Presenters, mVerve & Inflectra ● Section 1: Spira REST API setup ● Section 2: Postman setup for API access ● Section 3: Executing API requests ● Conclusion ● Q&A Session ● Closing Remarks Agenda
- 3. ® 3 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Meet the Presenters CTO & Chief Software Architect at mVerve Abhijit Nandy Global Lead on Training & Agile Transformation at Inflectra Dr. Sriram Rajagopalan Co-founder and Delivery Head at mVerve Kriti Agarwal Founder and Head of Business Development at mVerve Harsha Marigowda
- 4. ® 4 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Who are we? Inflectra Helps You Deliver Quality Software, Faster and with Lower Risk
- 5. ® 5 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra The Inflectra Platform
- 6. ® 6 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra mVerve empowers businesses with cutting-edge tech, accelerating digital success through its transformative solutions! About mVerve:
- 7. ® 7 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra mVerve Portfolio
- 8. ® 8 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Approach for Spira REST APIs ● Spira REST API setup ● Postman setup for API access ● Executing API requests
- 9. ® 9 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Section 1: Spira REST API setup ● Base URL for accessing SpiraPlan's REST API ● Specify Data Format in headers ● Authentication in SpiraPlan API ● SpiraPlan CORS Configuration
- 10. ® 10 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra ● API key can be generated from Edit users menu under cog wheel ● Enable the RSS feed toggle button to generate the RSS/API key Generating the API key from SpiraPlan
- 11. ® 11 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra ● Start Postman ● Create a new collection with a name ● Set collection variables ● Enter variables like baseurl, username and api-key and click on add a request ● Username is your spira username ● Enter the baseurl which is the application URL Section 2: Postman setup for API access
- 12. ® 12 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra
- 13. ® 13 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra REST API Use Cases ● Create a Requirement ● Create a User Story ● Create an Incident
- 14. ® 14 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra ● GET method- retrieves information or data from a specified resource ● POST method - submits data to create a new resource ● PUT method - updates a specified resource with new data ● DELETE method - deletes a specified resource Section 3: Executing API requests
- 15. ® 15 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra POST Request (Postman)
- 16. ® 16 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra POST Result (Spira)
- 17. ® 17 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra DELETE Request (Postman)
- 18. ® 18 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra DELETE Result (Spira)
- 19. ® 19 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Delete (SQL Query) ● Create a custom query
- 20. ® 20 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Conclusion Key Points covered ● SpiraPlan REST APIs ● Spira API Demo via Postman
- 21. ® 21 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra mVerve Spira Capabilities ● Implementation & Customization ● 3rd party Integration: Service Desk, Tableau, SAP & Salesforce ● Spira Apps ● Spira certified Dev’s and QA’s
- 22. ® 22 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra ● mVerve Website - https://mverve.com/ ● How to access the APIs - https://api.inflectra.com/Spira/Services/v5_0/RestService.aspx ● Postman Docs - https://learning.postman.com/ ● Postman API collections - https://drive.google.com/file/d/1TzBs9O8Lxx1a0eKI7ojvLfTp2Fsk2EhY/view Sriram: [email protected], Harsha: [email protected], Kriti: [email protected], Abhijit: [email protected] Additional Resources
- 23. ® 23 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Questions?
- 24. ® 24 | © Copyright 2006-2024 Inflectra Corporation – Confidential, Do Not Share Outside Inflectra Closing Remarks ● Thank attendees for participating ● What’s coming next? ○ Utilizing Spira APIs to demonstrate Integration with Tableau Thank You…!
Editor's Notes
- #7: mVerve, Established in 2013, develops Software for Enterprises across the globe across various industry verticals. We are a solution partner of Inflectra solutions.
- #8: mVerve offers full cycle services in UX Design, App Development, QA Engineering, ERP and ALM. We are a gold certified implementation partner of Inflectra.
- #9: Question for audience
- #12: Guidelines for setting up Postman for SpiraPlan APIs - Generating the API key from SpiraPlan Launch the application Create a new collection Enter the collection name - Spira Api Click on Edit collection to add the variables Enter variables like baseurl, username and api-key and click on add a request Application URL is available on - https://api.inflectra.com/Spira/Services/v5_0/RestService.aspx
- #16: Creating a new requirement as a user story ‘HR Details’ via POST method Add a new request Select the request type - add baseurl and the path of the method from the Spira API document Enter username, api-key variables and content type in the headers Add a name of a new requirement as in this example, we are creating a new requirement Click on send request and it will create a new requirement
- #22: As a gold-certified Partner of Inflectra, mVerve has a team of Spira certified developers and QA Engineers; we offer implementation and integration services to Spira Customers.