HTTP Request

The HTTP request connector calls other OpenAPIs through HTTP/HTTPS to obtain data required for orchestration.

Creating an HTTP Request Connection

Log in to the new ROMA Connect console.
In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
Select the HTTP request connector.

In the dialog box displayed, configure the connector and click OK.

Parameter	Description
Name	Enter the connector instance name.
base_url	Set the basic URL for all requests. The basic URL format is http://example.com/v1 or https://example.com/v1.
Security Authentication	Authentication mode used to invoke an API. App: Users are authenticated using the key and secret of an authorized integration application. None: Authentication is not required for API requests. Client Credentials: Obtain an access token with client ID and secret, then use it for authentication. Basic Auth: Encode username and password in Base64 and include in the HTTP header; suitable for internal or low-security test environments. Secret: Use pre-shared keys to authenticate API requests.
APP Key	Required when Security Authentication is set to App. Key of the integration application for authentication.
APP Secret	Required when Security Authentication is set to App. Secret of the integration application for authentication.
AccessTokenUrl	Required when Security Authentication is set to Client Credentials. URL provided by the API provider to obtain the access token.
ClientId	Required when Security Authentication is set to Client Credentials. Client ID allocated by the API provider.
ClientSecret	Required when Security Authentication is set to Client Credentials. Client ID allocated by the API provider.
scope	Required when Security Authentication is set to Client Credentials. Defines the API access permission scope as specified by the API provider.
userName	Required when Security Authentication is set to Basic Auth. Username for API authentication.
Password	Required when Security Authentication is set to Basic Auth. Password for API authentication.
Secret	Required when Security Authentication is set to Secret. Key allocated by the API provider.
Description	Enter the description of the connector to identify it.

Action

GET: Retrieves resources from the server by attaching parameters to the URL; used for data queries or fetching resources.
POST: Submits data to the server to create resources or perform operations.
PUT: Updates or replaces resources on the server; used for replacing or updating the entire resource.
DELETE: Removes resources from the server.
HEAD: Similar to GET but returns only response headers, typically used to fetch resource metadata like file size or modification date.

Configuration Parameters

**Table 1** Configuration parameters
Parameter	Description
Request URL	Specify either an absolute URL (e.g., http://example.com/v1 or https://example.com/v1) or a relative URL (e.g., /v1) which is appended to the base URL defined in the connector.
Stop On Failure	Whether to stop the flow task and report an error when the request fails.
Parameter	Set request parameters. Click Add to add request parameters in key-value pairs. Parameter types include: Query: Appended to the URL to pass additional information to the server. Header: Sent in the HTTP header for metadata or authentication. Path: Embedded in the URL path to specify resource IDs or hierarchy. If the URL contains {Path}, the corresponding Path parameter is added automatically.
Request Body Type	Required when Action is set to POST or PUT. Select the request body type of the API. The options are raw, form-data, and x-www-form-urlencoded.
Request Body	Required when Action is set to POST or PUT. Enter the API body.
Response Header Schema	Response headers in JSON format, with keys as field names and values as their corresponding data. Entries on each line are comma-separated. For payload details, see Referencing Variables.
Response Body Schema	Response body data in JSON format, with keys as field names and values as their corresponding data. Entries on each line are comma-separated. For payload details, see Referencing Variables.