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

Samuel02
Samuel02
With the advent of modern-day cloud infrastructure, many business-critical applications like databases, ERPs, Marketing applications have all moved to the cloud. With this, most of the business-critical data now reside in the cloud. Now that all the business data resides on the cloud, companies need a data warehouse that can seamlessly store the da...
0 Responses
BPM_online
BPM_online
Bpm'online, a global business software company leading in the space of low-code, process automation, and CRM, will be soon announcing their new company name. The new name will be launched in the sky via a breathtaking skydiving performance involving 160 bpm’online employees, including the CEO. The new name of bpm’online is to be fo...
0 Responses
Heta Raval
Heta Raval
In a current scenario, when you are eliciting software service-based requirements then, you may be able to derive requirements in certain varieties. In the beginning, they can be just functional or non-functional requirements. But when you come across many other requirements as time goes, you can conclude requirements into several categories and wi...
0 Responses




Latest Articles

What’s Missing from Agile?
Oct 20, 2019
0 Comments
John Seddon launches an attack on the value of Agile as practiced and charts a better way to analyse and design for improvement, making information te...
Copyright 2006-2019 by Modern Analyst Media LLC