---
title: "n8n"
description: "使用 n8n 和 Quire 社区节点自动化 Quire。"
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/zh-Hans/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n

<span id="n8n"></span>

Quire 的 n8n 社区节点包含一个调用 REST API 的操作节点，以及一个在 Quire 发生事件时启动工作流的触发器节点。它没有运行时依赖项，因此不会给您的 n8n 实例添加除自身以外的内容。

## 安装 <!--quire:install-->

在 n8n 中打开**设置**，然后选择**社区节点**和**安装**，输入 `@quire/n8n-node`。自托管 n8n 也可以在 n8n 用户目录中运行 `npm install @quire/n8n-node`，然后重启。

## 连接 <!--quire:connect-->

创建凭据。系统提供两种类型：

<figure class="quire-shot" lang="en" dir="ltr"><img src="/screenshots/admin-api-keys.webp" alt="The API keys page with a key named for an n8n automation." width="944" height="700" loading="lazy" decoding="async"><figcaption>Create a key at /admin/integrations/api-keys and paste it into the Quire credential in n8n.</figcaption></figure>

- **Quire API 密钥**：**基本 URL**应填写组织地址，末尾不带斜杠，例如 `https://acme.quirelms.com`。**API 密钥**应使用管理员在 `/admin/integrations/api-keys` 创建、以 `qk_live_` 开头的密钥。只授予工作流所需的作用范围。
- **Quire OAuth2**：适用于需要代表特定人员操作的工作流。在 `/admin/integrations/oauth-clients` 注册 OAuth 客户端，并填入 n8n 显示在凭据页面中的重定向地址，然后输入客户端 ID、密钥和作用范围。

## 操作 <!--quire:actions-->

**Quire** 节点支持用户、课程、选课、群组、完成情况、成绩、证书、提交内容、测验作答、项目、订单、电子邮件和组织。API 支持的资源操作都可执行列表查询、读取、创建、更新和删除；还可以按外部 ID 执行新增或更新，这正适合同步场景：即使运行同一工作流两次，也不会重复创建数据。

这些操作由 Quire OpenAPI 文档生成，因此与[API 参考](https://docs.quirelms.com/api/)中的字段完全一致。每项操作也可以作为 n8n AI 代理的工具使用，其说明来自 API 参考。

列表默认返回所有页面。大型组织可关闭**返回所有结果**并设置上限。

## 触发器 <!--quire:trigger-->

添加 **Quire Trigger** 节点，选择凭据并选择**事件**：按名称选择事件（例如 `enrolment.created`）、选择整个区域（例如 `course.*`）或选择所有事件。激活工作流后，该节点会在 Quire 中为 n8n 的地址创建 webhook 订阅；停用工作流时会删除订阅。

工作流启动前会验证每次投递的签名。验证失败的投递会被丢弃并产生节点错误，因此伪造请求无法启动工作流。事件的 `data` 字段包含标识符；您可以在触发器后添加 Quire 节点来获取完整记录。

## 示例：选课后发送欢迎邮件 <!--quire:example-welcome-email-on-enrolment-->

1. 添加 **Quire Trigger**，监听 `enrolment.created`。
2. 添加 **Quire** 节点，资源选**用户**、操作选**读取**，用户 ID 填 `{{$json.data.user_id}}`。
3. 添加 **Quire** 节点，资源选**课程**、操作选**读取**，课程 ID 填 `{{$json.data.course_id}}`。
4. 添加电子邮件或聊天节点，使用用户姓名和课程标题。

## 故障排查 <!--quire:troubleshooting-->

- 每次调用都返回 **401**：基本 URL 和密钥属于不同组织，或者密钥已撤销。
- 某项操作返回 **403**：密钥缺少相应作用范围。请在 `/admin/integrations/api-keys` 添加所需权限。
- 触发器始终没有运行：n8n 的 webhook 地址必须能让 Quire 通过 HTTPS 访问。请在 `/admin/webhooks` 查看订阅投递日志。

Source: https://docs.quirelms.com/zh-Hans/integrations/n8n/index.mdx