OpenAPI

Updated on 2023-12-28 GMT+08:00

View PDF

The OpenAPI connector is used to generate and release an API. The API is implemented by the subsequent components of the OpenAPI component. Therefore, the OpenAPI component can be used only as the trigger in a composite application and must be followed by other nodes.

After a flow is started, you can choose API Connect > APIs to view and edit the released API.

Action

Receiving API calls

Configuration Parameters

Parameter	Description
Name	Enter an API name. The name will be displayed on the APIs page of the corresponding ROMA Connect instance.
Security Authentication	Select a security authentication mode. Options: App: ROMA Connect authenticates API requests. When calling an API, a user gets authenticated using the key and secret of an authorized integration application. APIs using this mode can be called by all users. IAM: IAM authenticates API requests. When calling an API, a user gets authenticated using a token or an AK/SK pair. APIs using this mode can be called only by users on the same cloud service platform. None: Authentication is not required for API requests. APIs using this mode are less secure and can be called by all users. Be careful when using this mode.
Request Method	Select a request method of the API.
Request Path	Enter the API request path.
Matching	Select a matching mode of the API request path. Exact match: The path in an API request must be the same as the value of Request Path. Prefix match: The path in an API request must be prefixed with the value of Request Path. For example, if Request Path is set to /test/AA and Matching is set to Prefix match, the API can be accessed using /test/AA/BB or /test/AA/CC but cannot be accessed using /test/AACC.
Request Parameter	Configure the request parameters of the API. Click Add to define API request parameters as required. Name: name the request parameter Type: Select the type of the request parameter. The options are Header and Query. If the request path contains the Path parameter, the Path parameter is required. Mandatory: Whether the request parameter is mandatory in an API request. Default Value: Available when Mandatory is set to No If no value is assigned to this parameter when the API is called, the default value is used. NOTE: Request parameters can be referenced as custom variables in subsequent nodes. For details, see Custom Variables.
Example Body	Available when Request Method is set to POST or PUT. Example request body of an API NOTE: The request body can be referenced as node variables in subsequent nodes. For details, see Node Variables.
Response Mode	Select a response mode of the API. Synchronous: After receiving a request, the API processes the request immediately and returns a result. Asynchronous: After receiving a request, the API returns a response body, queues the request, and returns a result after the request is successfully processed.
Response Body	Available when Response Mode is set to Asynchronous. Response body returned after the API receives a request.

Parent topic: Triggers

Previous topic: Triggers

Next topic: FTP

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot