Forums for the Business Analyst

 
  Modern Analyst Forums  Business and Sy...  Requirements  Requirements to develop an API
Previous Previous
 
Next Next
New Post 2/12/2015 8:06 PM
User is offline Seema
1 posts
No Ranking


Requirements to develop an API 

Hi Friends,

I am going to work on a project that involves developing APIs. I have never written requirements for this. Can anyone help in to how to write requirements for an API. What all should be included. We are expected to write user stories.

Thanks.

 

 

 
New Post 2/13/2015 2:13 PM
User is offline NitWitNick
259 posts
5th Level Poster


Re: Requirements to develop an API 
Modified By NitWitNick  on 2/13/2015 5:14:04 PM)

"As an Api Developer ..." Is Not a User Story

API - "A particular set of rules and specifications that a software program can follow to access and make use of the services and resources provided by another software program or set of resources".

Simplicity - A business needs to display the balance of any customer calling them on the phone, in any department to see if they have a credit or are behind on their bills. 

So, instead of writing code in each departments program to go and calculate the user balance, you write an API (or sub-program) for all the display stations in all departments to call (passing a customer id) and the API will return the balance (credit / debit) ... this is better than putting calculation code in each display station program ... there is only 1 program to maintain instead of possibly dozens.

Here is something I found quickly ...

http://ridb-dev.nsitellc.com/docs/api/v1/RIDB_API_Requirements_20150113.pdf

 

It will give you some sections that you can use ... or at least an Idea.

 

 

 

 


 
Previous Previous
 
Next Next
  Modern Analyst Forums  Business and Sy...  Requirements  Requirements to develop an API

Community Blog - Latest Posts

Nick Stowers
Nick Stowers
Introduction   When I was introduced to scrum, the burndown chart was a tool that was highly emphasised however I feel the purpose has changed from it being a tool to predict (to a certain level) timescales for delivery to a tool that measures a team’s productivity…..in other words, the focus is on the number of points cleared w...
0 Responses
Jason White
Jason White
New technology is in trend every day and striving to make its mark to be the best. It is not optional to stay exceptional, technology has made lives easy and uncluttered in so many ways that cannot be comprehended. With the latest technologies in the headlines every day, it is Artificial intelligence that is leading the race and being incorporated ...
0 Responses
Digvijaybook
Digvijaybook
The role of a business analyst is to manufacture a piece of art; the piece of art varies depending upon the methodology and techniques being used. Business analyst serves the project all through the beginning until the end and comes up with different pieces of art. It all depends on the case, the business analyst gets involved from the beginning of...
0 Responses






Latest Articles

Do your processes S.U.C.K…?
May 17, 2020
0 Comments
No-one (in their right mind anyway!) ever sets out to design processes that qualify in the above categories, so why then do we end up with them? ...
Copyright 2006-2020 by Modern Analyst Media LLC