API Design Strategy Best Practices

The API design of NBFC ecosystem uses the RESTful principle to design the programming interfaces that each of the stakeholders, viz. the FIP, the AA, and the FIU need to host to facilitate the account aggregation functionality. The following HTTP methods are used in the design of AA ecosystem.

HTTP Method
Description
Request has body
Response has body
Idempotent
Cacheable

GET

Requests the representation of a resource.

The primary information retrieval mechanism.

No

Yes

Yes

Yes

POST

Requests server processing of an attached payload according to its own semantics.

Can be used to submit a form, post a message, or add items to a database.

Yes

Yes

No

Yes

DELETE

Requests server removal of a specified resource.

It is up to the server to archive or actually delete information.

No

Yes

Yes

No

Last updated