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

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
Heta Raval
Heta Raval
It is essential to write an impressive approach which helps you to make a client convinced about your understanding of his requirement. The satisfactory approach would help you to be on the same page with the client. So, your chances to get the contract/project would raise. In order to provide a technical solution, a business analyst needs to recog...
0 Responses
Arash
Arash
Machine Learning (ML) models are intended to positively impact business efficiency. By understanding how these models are created, how they function, and how they are put into production, one can fully utilize their potential to make a difference in every day scenarios.   What is a Machine Learning Model? By creating cases within a narrow d...
0 Responses




Latest Articles

What happens when the BA and UX worlds collide?
Aug 18, 2019
1 Comments
Are you a Business Analyst (BA) wondering what User Experience (UX) Design is all about and how your involvement in a design project is likely to impa...
Copyright 2006-2019 by Modern Analyst Media LLC