# Rest Api Component

The **REST API** component provides a way for applications to interact with a web-based service through a set of predefined operations or HTTP methods, such as _**GET, POST, PUT,PATCH, DELETE**_ etc.

All component configurations are classified broadly into 3 section

* [​Basic Information​](../component-base-configuration)
* Meta Information
* [Resource Configuration​](../resource-configuration)

{% hint style="info" %}
_<mark style="color:green;">Follow the steps given in the demonstration to configure the Rest API component.</mark>_
{% endhint %}

{% embed url="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc39ZvXI46qjXzpN3rYAg%2Fuploads%2FWlNlF58hpgJAr0zDSeBZ%2FrestAPI%20comp%20(1).mp4?alt=media&token=f3ce5341-8f4a-4994-8762-08753c8f2567" %}
_**Configuring Rest API Component**_
{% endembed %}

## **Configuring Meta Information of Rest API component**

<figure><img src="https://content.gitbook.com/content/vmyGSlDvDj86v7eh3RHM/blobs/JydIlV4dFxHhz7D8pQ3I/MicrosoftTeams-image%20(17).png" alt=""><figcaption><p>Meta information of Rest API Component</p></figcaption></figure>

* **Source Name:** Provide the name of the source you would like to reference.
* **URL:** It is a unique identifier that specifies the location of a resource on the web.&#x20;
* **Request Type:** The Request Type refers to the HTTP method or operation used to interact with a web service or resource. The most common HTTP methods used in REST APIs are:
  * **GET:** It retrieves data from a resource.&#x20;
  * **POST:** It submits new data to a resource.&#x20;
  * **PUT:** It updates existing data in a resource.&#x20;
  * **DELETE:** It deletes data from a resource.&#x20;
  * **PATCH:** It is to partially update a resource or entity on the server.
* **Query Params:** These are additional parameters that can be passed along with the URL of a request to modify the data returned by an API endpoint
* **Headers:** It refer to the additional information sent in the HTTP request or response along with the actual data.&#x20;
* **Authorization:** It refers to the process of verifying that a user or application has the necessary permissions to access a particular resource or perform a particular action.&#x20;
* **Iteration(s):** It refers to the process of retrieving a collection of resources from a web service in a paginated manner, where each page contains a subset of the overall resource collection.&#x20;
* **Delay(in sec):** It refers to a period of time between when a request is made by a client and when a response is received from the server.
* **Body:** It refers to the data or payload of a request or response message.
