Skip to content

插件系统

插件让 OpenEdge 可以连接外部业务系统,并把这些能力暴露给控制台和 bot 工作流。插件可以声明 action、接收用户输入、返回卡片,并处理交互事件。

适用场景

  • 从内部系统查询订单。
  • 从 CRM 获取客户记录。
  • 通过 bot 卡片触发工作流。
  • 把天气、新闻或自定义数据能力接入控制台。

协议

获取 Actions

http
GET /actions

响应:

json
{
  "actions": [
    {
      "id": "search_orders",
      "label": "Search Orders",
      "type": "form",
      "inputs": [
        { "name": "query", "label": "Order ID", "type": "text" }
      ]
    }
  ]
}

执行 Action

http
POST /execute

请求:

json
{
  "action_id": "search_orders",
  "params": { "query": "123" },
  "user_id": "user_1"
}

响应:

json
{
  "type": "list",
  "items": [
    {
      "id": "ord_123",
      "title": "Order #123",
      "subtitle": "$50.00 - Pending",
      "card": {
        "title": "Order #123 Details",
        "body": [
          { "type": "text", "content": "Status: Pending" }
        ],
        "actions": [
          { "type": "button", "label": "Refund", "id": "refund_123" }
        ]
      }
    }
  ]
}

处理交互

http
POST /

请求:

json
{
  "action_id": "refund_123",
  "user_id": "telegram_user_id",
  "interaction_id": "interaction_..."
}

安全

插件请求应当鉴权。插件端需要校验来自网关的签名或共享密钥,避免未授权调用。

如果集成需要第三方凭据,优先使用 第三方连接账户,不要把密钥硬编码到插件配置里。

注册插件

  1. 将插件部署为 HTTPS endpoint。
  2. 打开 OpenEdge 控制台。
  3. 注册插件 URL。
  4. 测试 action list。
  5. 在控制台或 bot 工作流中执行 action。