Help Center> ROMA Connect> User Guide> Business Flow Guide> Business Flow Components> HTTP Client
View PDF

HTTP Client

Overview

The HTTP Client component calls other open APIs through HTTP/HTTPS to obtain data required for orchestration.

Configuration

Table 1 HTTP Client configuration

Parameter

Description

URL

Enter a correct API request address that starts with http or https.

Security Authentication

Currently, APP authentication and None modes are supported.

  • APP Authentication: ROMA Connect performs security authentication on API requests. These APIs are exposed b the API gateway. When this type of API is called, the key and secret of the authorized integration application are used for security authentication of the API request.
  • None: Authentication is not required for API requests. All users can call the API in this mode.

APP Key

This parameter is mandatory only if Security Authentication is set to App Authentication.

Key of the application authorized by the API provider.

APP Secret

This parameter is mandatory only if Security Authentication is set to App Authentication.

Secret of the application authorized by the API provider.

Method

Request method. The options are as follows:

  • GET
  • HEAD
  • POST
  • PUT
  • DELETE

Parameters

Configure the condition information carried in the API access request to control the API execution behavior.

The following types are supported:

  • Header: Request parameters are added to the request header to set access authentication and request types.
  • Query: The request parameter has a concatenated end in the format of ?key=value&key=value.
  • Path: A request parameter replaces the placeholder in the URI. For example, if the URI is /name/{name}, {name} will be replaced with the value in use.

Body

This parameter is mandatory only when Method is set to POST or PUT.

Request body to be carried in the API request. The JSON and XML formats are supported. You can add Content-Type: application/json or Content-Type: application/xml to the request header.
Parent topic: Business Flow Components