N8N中文教程
嵌入功能

工作流模板#

功能可用性 使用 Embed 功能需要有效的 Embed 许可证。有关何时使用 Embed、费用以及许可流程的更多信息,请参阅 n8n 官网上的 Embed 页面。 n8n 提供了一个工作流模板库。在嵌入 n8n 时,您可以:

  • 继续使用 n8n 的工作流模板库(这是默认行为)
  • 禁用工作流模板
  • 创建您自己的工作流模板库

禁用工作流模板#

在你的环境变量中,将 N8N_TEMPLATES_ENABLED 设置为 false。

使用你自己的工作流模板库#

在你的环境变量中,将 N8N_TEMPLATES_HOST 设置为你 API 的基础 URL。

端点(Endpoints)#

你的 API 必须提供与 n8n 相同的端点和数据结构。 这些端点包括:

方法路径
GET/templates/workflows/<id>
GET/templates/search
GET/templates/collections/<id>
GET/templates/collections
GET/templates/categories
GET/health

查询参数(Query parameters)#

/templates/search 端点接受以下查询参数:

参数类型说明
page整数(integer)返回的结果页码
rows整数(integer)每页返回的最大结果数量
category以逗号分隔的字符串列表(分类)要搜索的分类范围
search字符串(string)搜索关键词

/templates/collections 端点接受以下查询参数:

参数类型说明
category以逗号分隔的字符串列表(分类)要搜索的分类范围
search字符串(string)搜索关键词

数据模式(Data schema)#

你可以通过以下内容查看各端点返回响应对象中条目的数据结构:

显示 workflow 条目数据模式

工作流条目数据模式

  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

| ``` { "$schema":"http://json-schema.org/draft-07/schema#", "title":"Generated schema for Root", "type":"object", "properties":{ "id":{ "type":"number" }, "name":{ "type":"string" }, "totalViews":{ "type":"number" }, "price":{}, "purchaseUrl":{}, "recentViews":{ "type":"number" }, "createdAt":{ "type":"string" }, "user":{ "type":"object", "properties":{ "username":{ "type":"string" }, "verified":{ "type":"boolean" } }, "required":[ "username", "verified" ] }, "nodes":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"number" }, "icon":{ "type":"string" }, "name":{ "type":"string" }, "codex":{ "type":"object", "properties":{ "data":{ "type":"object", "properties":{ "details":{ "type":"string" }, "resources":{ "type":"object", "properties":{ "generic":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" }, "icon":{ "type":"string" }, "label":{ "type":"string" } }, "required":[ "url", "label" ] } }, "primaryDocumentation":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" } }, "required":[ "url" ] } } }, "required":[ "primaryDocumentation" ] }, "categories":{ "type":"array", "items":{ "type":"string" } }, "nodeVersion":{ "type":"string" }, "codexVersion":{ "type":"string" } }, "required":[ "categories" ] } } }, "group":{ "type":"string" }, "defaults":{ "type":"object", "properties":{ "name":{ "type":"string" }, "color":{ "type":"string" } }, "required":[ "name" ] }, "iconData":{ "type":"object", "properties":{ "icon":{ "type":"string" }, "type":{ "type":"string" }, "fileBuffer":{ "type":"string" } }, "required":[ "type" ] }, "displayName":{ "type":"string" }, "typeVersion":{ "type":"number" }, "nodeCategories":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"number" }, "name":{ "type":"string" } }, "required":[ "id", "name" ] } } }, "required":[ "id", "icon", "name", "codex", "group", "defaults", "iconData", "displayName", "typeVersion" ] } } }, "required":[ "id", "name", "totalViews", "price", "purchaseUrl", "recentViews", "createdAt", "user", "nodes" ] }

显示 category 项目数据结构 Category item data schema


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

| ``` { "$schema":"http://json-schema.org/draft-07/schema#", "type":"object", "properties":{ "id":{ "type":"number" }, "name":{ "type":"string" } }, "required":[ "id", "name" ] }


显示 `collection` 项目数据结构
Collection item data schema
---

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

| ```
{
"$schema":"http://json-schema.org/draft-07/schema#",
"type":"object",
"properties":{
"id":{
"type":"number"
},
"rank":{
"type":"number"
},
"name":{
"type":"string"
},
"totalViews":{},
"createdAt":{
"type":"string"
},
"workflows":{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"type":"number"
}
},
"required":[
"id"
]
}
},
"nodes":{
"type":"array",
"items":{}
}
},
"required":[
"id",
"rank",
"name",
"totalViews",
"createdAt",
"workflows",
"nodes"
]
}

你也可以交互式地探索 n8n 的 API 接口: https://api.n8n.io/templates/categories https://api.n8n.io/templates/collections https://api.n8n.io/templates/search https://api.n8n.io/health 如有更多支持需求,欢迎联系我们。

将你的工作流添加到 n8n 模板库#

你可以将自己的工作流提交至 n8n 的模板库中。 n8n 正在推进创作者计划(Creator Program),并开发一个模板市场。该项目仍在持续进行中,具体细节可能会有所调整。 有关如何提交模板以及成为创作者的信息,请参考 n8n Creator hub。