You can create a connector by importing OpenAPI definition from the web or from Postman collection. All the required parameters for the connector actions are automatically configured after the importing operation is complete.

Prerequisites

Ensure that you have created a custom connector. See Create custom connector.
Note:
  • OpenAPI versions 2.x and 3.x are supported.
  • The import process skips any API definitions that are dependent on file operations (such as uploading a file, downloading a file) as they are not supported.

Procedure

  1. On the connector editor page, click Import API definition.
  2. In the Import API definition window, select one of the following input types:
    • Open API file: Click Browse and select the API definition file (JSON or YAML) that you want to import. Connector Builder will read the file and generate actions.
    • Open API from URL: Enter the URL from where you want to import the API definition. Connector Builder will read the contents of the page and generate actions.
    • Postman collection: Click Browse and select the Postman collection file (JSON or YAML) that you want to import. Connector Builder will parse the Postman collection file for required values and generate actions.
  3. Optional: Enable the Exclude optional fields check box to import only the properties that are marked as required in the API definition file.
    This option allows you to skip the parameters, bodies, and other properties that are marked as required: false in the API definition file.
  4. Click Import.

    An error icon is displayed for actions that have errors. Select the action to review and fix the errors.

  5. Configure action in connector editor.