In this document we show how to use the authorization with 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.

Authorization types

Jump to: Top | Auth types | Basic Auth | API Key Auth


Before REST API component can be used, authorization information should be provided. This information is sent in HTTP Request header to the REST API provider. There are 3 available types: No Auth, Basic Auth and API Key Auth.

The No Auth is not exactly a type but can be selected to work with completely open REST APIs.

Basic Auth

Jump to: Top | Auth types | Basic Auth | API Key Auth


Use this option when a pair of username/password is required to query the REST APIs. When selected two input fields will be shown like this:

After inputting the username/password the information is encoded and placed in the header of the HTTP request:

Please note that this header cannot be deleted from the component configuration page (it is greyed). To remove this header select different authorisation method by going one step back.

API Key Auth

Jump to: Top | Auth types | Basic Auth | API Key Auth


Use this option when an API Key is required to query the REST APIs. When selected two input fields will be shown like this:

In above example, the test API Key of the Petstore API is used. After inputting the necessary information the API Key will be placed in the header of the HTTP request:

Please note that this header cannot be deleted from the component configuration page (it is greyed). To remove this header select different authorisation method by going one step back.

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 | Auth types | Basic Auth | API Key Auth