Skip to content

Embed 中的工作流管理

功能可用性

嵌入需要嵌入许可证。有关何时使用嵌入以及费用和许可流程的更多信息,请参阅n8n 网站上的“嵌入”

在管理跨团队或组织的嵌入式 n8n 部署时,您可能需要为多个用户运行相同(或类似)的工作流程。有两种方法可以实现此目的:

解决方案 优点 缺点
为每个用户创建工作流程 工作流程启动方式不受限制(可以使用任何触发器) 需要管理多个工作流程。
创建单个工作流并在执行时向其传递用户凭据 简化工作流程管理(只需要改变一个工作流程)。 要运行工作流程,您的产品必须调用它

警告

本文档中引用的 API 随时可能更改。请务必在每次版本升级后检查其功能是否持续可用。

每个用户的工作流程

有三个一般步骤需要遵循:

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

1.获取用户凭证

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

2.创建用户凭证

获取所有相关凭证详细信息后,您可以继续在 n8n 中创建相关的服务凭证。您可以使用编辑器 UI 或 API 调用来完成此操作。

使用编辑器 UI

  1. 从菜单中选择“凭据” > “新建”
  2. 使用下拉菜单选择要创建的凭证类型,例如Airtable
  3. 创建新凭证模式中,输入用户相应的凭证详细信息,然后选择有权访问这些凭证的节点。
  4. 单击“创建”完成并保存。

使用 API

您也可以调用编辑器 UI 使用的前端 API 来实现相同的效果。API 端点的格式为: 。

例如,要在上面的编辑器 UI 示例中创建凭据,请求将是:

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

带有请求主体:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
   "name":"MyAirtable",
   "type":"airtableApi",
   "nodesAccess":[
      {
         "nodeType":"n8n-nodes-base.airtable"
      }
   ],
   "data":{
      "apiKey":"q12we34r5t67yu"
   }
}

响应将包含新凭证的 ID,您将在为该用户创建工作流时使用该 ID:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
   "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.创建工作流程

最佳做法是拥有一个“基础”工作流程,然后为每个新用户复制并定制其凭据(以及任何其他详细信息)。

您可以使用编辑器 UI 或 API 调用复制和自定义模板工作流程。

使用编辑器 UI

  1. 从菜单中选择工作流>打开以打开要复制的模板工作流。

  2. 选择工作流>复制,然后输入此新工作流的名称并单击保存

  3. 更新所有相关节点以使用此用户的凭据(上面创建)。

  4. 保存此工作流程并使用右上角的切换按钮将其设置为“活动”

使用 API

  1. 使用端点获取模板工作流的 JSON:

响应将包含所选工作流的 JSON 数据:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
  "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: {{$node[\"HTTP Request\"].parameter[\"headerParametersUi\"][\"parameter\"][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 作为端点的请求主体创建一个新的工作流:

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

响应将包含新工作流的 ID,您将在下一步中使用该 ID。

  1. 最后,激活新的工作流程:

在 JSON 有效负载中传递附加值:

1
2
3
4
5
// ...
"active":true,
"settings": {},
"staticData": null,
"tags": []

单一工作流

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

  • 获取每个用户的凭据,以及根据工作流可能需要的任何其他参数。请参阅上文的“获取用户凭据”
  • 为该用户创建 n8n 凭据。请参阅上文的“创建用户凭据”
  • 创建工作流程。
  • 根据需要调用工作流。

创建工作流

此工作流程的细节和范围将根据各个用例而有很大差异,但需要牢记一些设计实现:

  • 此工作流程必须由Webhook节点触发。
  • 传入的 webhook 调用必须包含用户的凭据和任何其他所需的工作流参数。
  • 每个需要用户凭证的节点都应使用一个表达式,以便节点的凭证字段读取 webhook 调用中提供的凭证。
  • 保存并激活工作流,确保为 Webhook 节点选择生产 URL。有关更多信息,请参阅Webhook 节点

调用工作流

对于每个新用户或任何现有用户(根据需要),调用定义为工作流触发器的 webhook 并提供必要的凭据(以及任何其他工作流参数)。