DocsICP FilingConsole
官方文档
首页

Create a connector

更新时间：
复制 MD 格式
产品详情
我的收藏

AppFlow provides many built-in connectors for popular SaaS applications and cloud services. If you need to integrate a proprietary or third-party application, you can use the custom connector feature to package the application as an AppFlow connector. You can then use this connector in your connection flows. This topic describes how to create a custom connector.

Background

  • Connector: Enables data flow between different systems and applications. A connector includes authentication settings, triggers, and actions.

  • Trigger: A condition or event that starts a workflow, such as a time-based schedule or a system event.

  • Action: A specific operation in a workflow, such as calling an external API to perform a business operation.

Procedure

  1. Log on to the AppFlow console.

  2. In the left-side navigation pane, choose Connector > Custom Connectors. On the Custom Connectors page, click Create Connector.

  3. On the Create Connector page, configure the connector information.

    Parameter

    Description

    Connector icon

    Upload an icon for the connector. The recommended resolution is 192 × 192 pixels. Supported formats: JPG, PNG, and SVG.

    Connector name

    Specify a name for the connector. The name must be 3 to 200 characters long. Each Chinese character counts as 2 characters.

    Connector description

    Specify a description for the connector. The description must be 10 to 500 characters long. Each Chinese character counts as 2 characters.

    Connector type

    Select a connector type.

    • Application connector: An application service that exposes standard interfaces over HTTP/HTTPS.

    • Data connector: This feature is not yet available.

  4. Click Save Connector to open the connector configuration page.

    1. In the Basic information section, review the connector's details. The left side of the page displays a four-step navigation menu, with Basic information being the first step. The right side displays properties such as the connector name, description, protocol type (HTTP), and connector type.

    2. In the Authentication Settings section, select an authentication method for the connector.

      By default, AppFlow connectors do not require authentication. If you select an authentication method, users must provide credentials to use the connector. For more information about authentication settings, see Connector Authentication Methods.

      Supported authentication methods include No authentication, Basic Auth, Bearer Token, and AppCode.

    3. In the Trigger Event section, add triggers for the connector.

      A trigger is the starting point of a connection flow. If your connector does not need to define triggers, you can skip this step. For more information about triggers, see Connector Trigger Configuration.

      1. Click Create Trigger Event to open the Create Trigger page.

      2. On the Basic information tab, enter a name and description for the trigger, and then click Next step.

      3. On the Model Configuration tab, configure the input parameters for the trigger.

        When the trigger fires, its input parameters can be referenced by subsequent nodes in the workflow. The page provides a table for input parameters with the following columns: Field Key, Field Name, Field Type, Required, and Field Description. By default, the table contains a root node of type object. You can click Import JSON to bulk import the field structure, or click Add to add child fields individually. After you complete the configuration, click Publish.

      4. Click Publish to create the trigger.

    4. In the Execute Action section, create actions for the connector.

      An action typically consists of an API and its corresponding input and output parameters. In a connection flow, actions serve as execution nodes that perform specific business operations.

      1. Click Create Execution Action.

      2. On the Basic information tab, enter a name, description, and API path for the action, and then click Next step.

      3. On the Input parameter configuration tab, configure the API input parameters for the action, and then click Next step.

      4. On the Parameter-out configuration tab, configure the action's output parameters. Select the Response body tab and define the API output fields. For example, you can add fields such as code (error code, number type, description: 200 indicates success), message (error message, string type, description: ok), and data (return object, string type). You can also click Import JSON to import fields in bulk.

      5. Click Publish to create the action.

Previous：Create a connection flowNext：RDS Copilot