API Basics

REST APIs?

REST (Representational State Transfer) is an architectural style for designing networked applications. It is based on a set of principles and constraints to build APIs (Application Programming Interfaces) that enable communication between different systems over the Internet. REST APIs expose the functionalities of a service or application, allowing developers to interact with it programmatically.

A RESTful web application provides information about itself through its resources. Also, it allows the client to act on those resources, such as adding new resources (for example, adding a new user) or changing existing resources (for example, editing a post).

Example

Use the Falcon add users API to add a new user. The API response returns a unique identifier of the newly added user. The representation of the state is in a JSON format.

-X POST https://creditqa.tab.kitecash.in/cc-open-api/falcon/v2/user
-H 'Authorization: {{access_token}} \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
    "cifNumber": "43804110342",
    "personalDetails": {
        "salutation": "MR",
        "userFirstName": "Hello",
        "userMiddleName": "User",
        "userLastName": "New",
        "userPAN": "ABYPP5886J",
        "userMobileNumber": "9702169003",
        "email": "[email protected]",
        "userDOB": "1989-11-04",
        "userGender": "MALE",
        "fatherName": "Jona",
        "motherName": "Luc",
        "userOVDType": "AADHAR",
        "userOVDID": "4312"
    },
    "permanentAddress": {
        "houseNumber": "10",
        "address": "permanent addres",
        "locality": "permanent locality",
        "city": "Gurgaon",
        "state": "Haryana",
        "pinCode": "122001",
        "country": "INDIA"
    },
    "deliveryAddress": {
        "houseNumber": "11",
        "address": "delivery addres",
        "locality": "delivery locality",
        "city": "New Delhi",
        "state": "Tamil Nadu",
        "pinCode": "122001",
        "country": "INDIA"
    },
    "officeAddress": {
        "houseNumber": "12",
        "address": "office addres",
        "locality": "office locality",
        "city": "Gurgaon",
        "state": "Haryana",
        "pinCode": "122002",
        "country": "INDIA"
    }
}'

{
    "userId": "c84832dc-60f3-4682-9e44-79f0f01eae2d"
}

The following information defines the communication between client and server during API polling:

• An identifier of the resource: This is the resource URL, also called an endpoint.
• The operation you want to perform on the resource (in the form of an HTTP method or verb): GET, POST, PUT, PATCH, and DELETE.

HTTP Methods

HTTP defines a set of request methods. These methods indicate actions for a given resource.

Given below is the list of methods commonly used in Falcon APIs.

Parameter

Parameters are options that contain data. You can pass these with an endpoint to get a required response. The table below depicts the various parameters.

HTTPS Status Codes

HTTP response status codes represent whether a request is completed. All responses are grouped into the following classes.

• Informational responses (100–199)
• Successful responses (200–299)
• Redirection messages (300–399)
• Client error responses (400–499)
• Server error responses (500–599)

Success Codes

Below is the success status code used in the Falcon APIs.

Error Codes

Given below is the list of error status codes used in the Falcon APIs.