API Basics
What is an API?
API stands for Application Programming Interface. An API is an intermediary that allows two applications to interact with each other. It works like a messenger between two parties, where one party requests and receives a response from another party for the request.
Who is a Client?
A client is a software distributed to customers who can access or communicate with the server by using an API. This could be an internal service or an external facing asset like a mobile app (Android/iOS) or mobile website or website.
What is a Server?
🖥️A server is a machine running some processes that will process some service for you based on a user's request via API.
What are Status Codes?
🏳️Status codes are sent by a server in response to the request made by a client.
Status codes with their meanings
| Status Code | Meaning |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 404 | Not found |
| 422 | Unprocessable Entity (Usually occurs when a parameter is missing in a request) |
| 500 | Internal Server Error |
API Response Keys
🀄The below mentioned response keys pertain to all the APIs
| Response Key | Scenario |
|---|---|
| NOT_FOUND | Resource for which the request was made was not found |
| CREATE_FAILED | Resource creation failed for the made request |
| UPDATE_FAILED | Updation of resource failed for the made request |
| USER_NOT_FOUND | finsire_id passed in the request is incorrect |
| KYC_NOT_COMPLETE | User has not completed their KYC |
| DELETE_FAILED | Deletion of user failed for the made request |
| USER_DOES_NOT_EXIST | User does not exist |
Updated 5 months ago