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




Latest Articles

Six Estimation Safety Tips
Oct 13, 2019
0 Comments
Estimation is a chronically thorny issue for software practitioners. Most people need to prepare estimates for the work they do, but in our industry w...
Copyright 2006-2019 by Modern Analyst Media LLC