嵌入中的工作流管理

功能可用性

嵌入功能需要嵌入许可证。有关何时使用嵌入功能以及成本和许可流程的更多信息，请参阅 n8n 网站上的嵌入功能。

在管理跨团队或组织的嵌入式 n8n 部署时，您可能需要为多个用户运行相同（或类似）的工作流。有两个可用选项：

解决方案	优点	缺点
为每个用户创建工作流	对工作流如何启动没有限制（可以使用任何触发器）	需要管理多个工作流。
创建单个工作流，并在执行时传递用户凭据	简化工作流管理（只需更改一个工作流）。	要运行工作流，您的产品必须调用它

Warning

本文档中引用的 API 可能随时更改。请确保在每次版本升级时检查持续功能。

每用户工作流

有三个一般步骤要遵循：

• 获取每个用户的凭据，以及根据工作流可能需要的任何其他参数。
• 为此用户创建 n8n 凭据。
• 创建工作流。

1. 获取用户凭据

在这里，您需要捕获此用户必须进行身份验证的任何节点/服务的所有凭据，以及特定工作流所需的任何其他参数。所需的凭据和任何参数将取决于您的工作流和您要尝试做的事情。

2. 创建用户凭据

在获取所有相关的凭据信息后，你就可以在 n8n 中创建对应服务的凭据。你可以通过 Editor UI 编辑器 UI 或调用 API 来完成此操作。

使用 Editor UI 编辑器 UI

1. 在菜单中选择 Credentials 凭据 > New 新建。
2. 使用下拉框选择要创建的 Credential type 凭据类型，例如 Airtable。
3. 在 Create New Credentials 创建新凭据 模态框中，输入该用户对应的凭据信息，并选择哪些节点可以访问这些凭据。
4. 点击 Create 创建 完成并保存。

使用 API

Editor UI 使用的前端 API 也可以直接调用以实现相同效果。该 API 端点格式为：https://<n8n-domain>/rest/credentials。

例如，要创建上方 Editor UI 示例中的凭据，请求如下：

POST https://<n8n-domain>/rest/credentials

请求 body 为：

{
   "name":"MyAirtable",
   "type":"airtableApi",
   "nodesAccess":[
      {
         "nodeType":"n8n-nodes-base.airtable"
      }
   ],
   "data":{
      "apiKey":"q12we34r5t67yu"
   }
}

响应中会包含新建凭据的 ID，你将在为该用户创建工作流时用到它：

{
   "data":{
      "name":"MyAirtable",
      "type":"airtableApi",
      "data":{
         "apiKey":"q12we34r5t67yu"
      },
      "nodesAccess":[
         {
            "nodeType":"n8n-nodes-base.airtable",
            "date":"2021-09-10T07:41:27.770Z"
         }
      ],
      "id":"29",
      "createdAt":"2021-09-10T07:41:27.777Z",
      "updatedAt":"2021-09-10T07:41:27.777Z"
   }
}

3. 创建工作流

最佳实践是先准备一个「基础」工作流，然后为每个新用户复制一份，并按该用户的凭据（以及其他必要信息）进行定制。

你可以通过 Editor UI 编辑器 UI 或 API 调用来复制并定制你的工作流模板。

使用 Editor UI 编辑器 UI

1. 在菜单中选择 Workflows 工作流 > Open 打开，打开要复制的工作流模板。

2. 选择 Workflows 工作流 > Duplicate 复制，为新工作流输入名称，然后点击 Save 保存。

3. 更新所有相关节点，使其使用该用户的凭据（上一步创建）。

4. Save 保存 该工作流，并使用右上角开关将其设为已发布（active=true）。

使用 API

1. 使用端点 https://<n8n-domain>/rest/workflows/<workflow_id> 获取工作流模板的 JSON：

   GET https://<n8n-domain>/rest/workflows/1012
   

响应中会包含所选工作流的 JSON 数据：

{
  "data": {
    "id": "1012",
    "name": "Nathan's Workflow",
    "active": false,
    "nodes": [
      {
        "parameters": {},
        "name": "Start",
        "type": "n8n-nodes-base.start",
        "typeVersion": 1,
        "position": [
          130,
          640
        ]
      },
      {
        "parameters": {
          "authentication": "headerAuth",
          "url": "https://internal.users.n8n.cloud/webhook/custom-erp",
          "options": {
            "splitIntoItems": true
          },
          "headerParametersUi": {
            "parameter": [
              {
                "name": "unique_id",
                "value": "recLhLYQbzNSFtHNq"
              }
            ]
          }
        },
        "name": "HTTP Request",
        "type": "n8n-nodes-base.httpRequest",
        "typeVersion": 1,
        "position": [
          430,
          300
        ],
        "credentials": {
          "httpHeaderAuth": "beginner_course"
        }
      },
      {
        "parameters": {
          "operation": "append",
          "application": "appKBGQfbm6NfW6bv",
          "table": "processingOrders",
          "options": {}
        },
        "name": "Airtable",
        "type": "n8n-nodes-base.airtable",
        "typeVersion": 1,
        "position": [
          990,
          210
        ],
        "credentials": {
          "airtableApi": "Airtable"
        }
      },
      {
        "parameters": {
          "conditions": {
            "string": [
              {
                "value1": "={{$json[\"orderStatus\"]}}",
                "value2": "processing"
              }
            ]
          }
        },
        "name": "IF",
        "type": "n8n-nodes-base.if",
        "typeVersion": 1,
        "position": [
          630,
          300
        ]
      },
      {
        "parameters": {
          "keepOnlySet": true,
          "values": {
            "number": [
              {
                "name": "=orderId",
                "value": "={{$json[\"orderID\"]}}"
              }
            ],
            "string": [
              {
                "name": "employeeName",
                "value": "={{$json[\"employeeName\"]}}"
              }
            ]
          },
          "options": {}
        },
        "name": "Set",
        "type": "n8n-nodes-base.set",
        "typeVersion": 1,
        "position": [
          800,
          210
        ]
      },
      {
        "parameters": {
          "functionCode": "let totalBooked = items.length;\nlet bookedSum = 0;\n\nfor(let i=0; i < items.length; i++) {\n  bookedSum = bookedSum + items[i].json.orderPrice;\n}\nreturn [{json:{totalBooked, bookedSum}}]\n"
        },
        "name": "Function",
        "type": "n8n-nodes-base.function",
        "typeVersion": 1,
        "position": [
          800,
          400
        ]
      },
      {
        "parameters": {
          "webhookUri": "https://discord.com/api/webhooks/865213348202151968/oD5_WPDQwtr22Vjd_82QP3-_4b_lGhAeM7RynQ8Js5DzyXrQEnj0zeAQIA6fki1JLtXE",
          "text": "=This week we have {{$json[\"totalBooked\"]}} booked orders with a total value of {{$json[\"bookedSum\"]}}. My Unique ID: {{ $(\"HTTP Request\").params.headerParameters.parameters[0].value }}"
        },
        "name": "Discord",
        "type": "n8n-nodes-base.discord",
        "typeVersion": 1,
        "position": [
          1000,
          400
        ]
      },
      {
        "parameters": {
          "triggerTimes": {
            "item": [
              {
                "mode": "everyWeek",
                "hour": 9
              }
            ]
          }
        },
        "name": "Cron",
        "type": "n8n-nodes-base.cron",
        "typeVersion": 1,
        "position": [
          220,
          300
        ]
      }
    ],
    "connections": {
      "HTTP Request": {
        "main": [
          [
            {
              "node": "IF",
              "type": "main",
              "index": 0
            }
          ]
        ]
      },
      "Start": {
        "main": [
          []
        ]
      },
      "IF": {
        "main": [
          [
            {
              "node": "Set",
              "type": "main",
              "index": 0
            }
          ],
          [
            {
              "node": "Function",
              "type": "main",
              "index": 0
            }
          ]
        ]
      },
      "Set": {
        "main": [
          [
            {
              "node": "Airtable",
              "type": "main",
              "index": 0
            }
          ]
        ]
      },
      "Function": {
        "main": [
          [
            {
              "node": "Discord",
              "type": "main",
              "index": 0
            }
          ]
        ]
      },
      "Cron": {
        "main": [
          [
            {
              "node": "HTTP Request",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "createdAt": "2021-07-16T11:15:46.066Z",
    "updatedAt": "2021-07-16T12:05:44.045Z",
    "settings": {},
    "staticData": null,
    "tags": []
  }
}

1. 保存返回的 JSON 数据，并为新用户更新相关凭据与字段。

2. 使用更新后的 JSON 作为请求 body，在端点 https://<n8n-domain>/rest/workflows 创建新工作流：

   POST https://<n8n-domain>/rest/workflows/
   

响应中会包含新建工作流的 ID，你将在下一步中用到它。

1. 最后，发布新的工作流：

   PATCH https://<n8n-domain>/rest/workflows/1012
   

在 JSON payload 中额外传入 active 值：

// ...
"active":true,
"settings": {},
"staticData": null,
"tags": []

单个工作流

要实现此方法，需要遵循四个步骤：

• 获取每个用户的凭据，以及工作流可能需要的其他参数。请参阅上方的获取用户凭据。
• 为该用户创建 n8n 凭据。请参阅上方的创建用户凭据。
• 创建工作流。
• 按需调用工作流。

创建工作流

该工作流的细节与范围会因具体用例而差异很大，但有一些设计要点需要注意：

• 此工作流必须由 Webhook 节点触发。
• 入站 webhook 调用必须包含用户凭据，以及工作流所需的其他参数。
• 任何需要使用用户凭据的节点都应使用表达式，让节点的凭据字段读取 webhook 调用中提供的凭据。
• 保存并发布工作流，并确保 Webhook 节点选择了生产 URL。更多信息请参阅 Webhook 节点。

调用工作流

对于每个新用户（或按需对现有用户），调用作为工作流触发器的 webhook，并提供必要的凭据（以及其他工作流参数）。