The REST API component is designed to connect to any endpoint and make API requests using various methods. It is highly versatile, and capable of interfacing with any available service, offering extensive possibilities for integration. This document will explain how to configure and use the REST API component in a workflow.

Key Concepts

What is an API?

An API (Application Programming Interface) allows different applications to communicate with each other. It's like a messenger that takes your request, tells the target system what you want to do, and then brings the response back to you.

REST API Component

REST API component is a tool that you can use to send requests to other systems and receive responses. You can think of it as a way to ask other applications/services for information or to perform an action.

Configuring the REST API Component

When setting up the REST API component, you will need to provide some key information. Let's break these down:

1. Endpoint
   • The URL where you want to send your request. Think of it as the address of the place you are sending your message to.
2. Method
   • This tells the system what kind of request you are making. Common methods include:
     • GET: To retrieve data.
     • POST: To send new data.
     • PUT: To update existing data.
     • DELETE: To remove data.
3. Headers
   • Extra information you send along with your request. For example, headers can include details about the format of the data you are sending or receiving.
4. Body
   • The actual data you want to send in your request. This is typically used with methods like POST and PUT.
5. Connection ID
   • A special identifier that links to another part of our system called a "Connection". The Connection contains authentication details that tell the system how to log in and gain access to the endpoint.

Connections and Connection IDs

What is a Connection?

A Connection is like a saved set of login details that our system can use to access different services. These details can include things like usernames, passwords, or special tokens.