Help Center> ROMA Connect> User Guide> Business Flow Guide> Business Flow Components> Open API
View PDF

Open API

Overview

The Open API component is used to create a service integration task that generates and releases an API. The API is implemented by the subsequent components of the Open API component. Therefore, the Open API component can be used only as the first node in a task and must be connected to other nodes.

After the business flow task is started successfully, you can choose API Connect > API Management to view and edit the released API.

Configuration

Table 1 Open API configuration

Parameter

Description

API Group

Select an API group, either the API group bound to the current application or the global API group in the current ROMA Connect instance.

API Name

User-defined API name.

The name will be displayed after you choose API Connect > API Management for the current ROMA Connect instance.

Security Authentication

Select a security authentication mode. Currently, the following two authentication modes are supported:

  • App Authentication: When an external system calls this API, ROMA Connect performs security authentication on the request. This authentication mode has a high security level and is recommended.
  • None: No authentication is required when an external system calls the API. The security level is low, and all users can access the API. Therefore, be cautious in selecting this mode.

Method

Request method of the API. The options are as follows:

  • GET
  • HEAD
  • POST
  • PUT
  • DELETE

Request Path

Enter the API request path.

Parameters

Request parameters of the API.

  • Name
  • Default value. If no value is assigned to this parameter when the API is called, the default value is used.
  • Type. The options are as follows:
    • Header: request header parameter.
    • Query: The request parameter has a concatenated end in the format of ?key=value&key=value.
    • Path: request path parameter. If {Parameter name} exists in the request path, the path parameter corresponding to the parameter name is automatically added to the request parameter.

Example Body

Example request body of an API, which is optional. This parameter is mandatory only when Method is set to POST or PUT.

Request parameter defined in the Open API component. You can reference the variable in a simple expression ${property.variable name} in subsequent steps.

Parent topic: Business Flow Components