In this document we introduce the REST API component and cover the following subjects:

This article is part of the series of articles dedicated to REST API component and the usage in the integration flow design.

The new REST API component

Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body


One of the methods to provide an interoperability between different system is to use the REST web service to connect with an API provider. The majority of services out there have their own REST API service through which the communications are done. In fact, here is our own REST API service.

There are many online services, browser extensions and desktop applications which help to communicate with any REST API service. They are used by the developing community to build new products which communicate with a given REST API service.

The REST API component on our platform is such a service component designed specifically to connect and query any REST API. You can use it to query any REST API and then use the response to design your integration flow without switching to an external tool.

In the example below the REST API component is used with our own REST API service.

The authorization type is selected in the previous step of the configuration. REST API Component: Authorization page has more information about the supported authorization types.

Method

Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body


All standard methods like GET, PUT, POST, PATCH and DELETE are supported. Just select from the drop-down menu.

In case of GET only the Headers are available. For the other methods, the Body part is also available.

URL

Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body


The field where the URL of the REST API is inputted. This field accepts only JSONata expressions, meaning the URL address should be a string.

Headers

Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body


Use this part to add as many headers as necessary.

If REST API requires an authorization then the credentials are submitted in the header as it is shown above. For more details about authorization, visit the REST API Component: Authorization page.

Content Types and the Body

Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body


When HTTP Method is not GET then the Body part is switched on.

In current view, it is possible to input the body of the HTTP call. The type of body depends on the content type which is application/json in the above example. The rendered field Body accepts only JSONata expressions.

The Content type field can have different values like multipart/form-data, application/x-www-form-urlencoded, text/plain, application/json, application/xml, text/xml and text/html. The required Body will be different accordingly.

This article is part of the series of articles dedicated to REST API component and the usage in the integration flow design.


Jump to: Top | REST API component | Method | URL | Headers | Content Types/Body