通过 Quire API 集成外部工具 —— 以 n8n 为例

最后更新：2026年7月20日

Quire 提供了一个开放 API，可以让你以编程方式读取和更新 Quire 任务。应用程序目录中的许多应用程序都是通过直接调用 Quire API 构建的。

如果现有应用程序无法满足你的需求，不妨自己搭建一个集成。本文以 n8n 为例讲解 Quire API 的使用；同样的概念也适用于 Zapier 等其他低代码平台。

这条路线正变得越来越普遍。Gartner 曾预计，到 2025 年，组织开发的新应用程序中将有 70% 使用低代码或无代码技术，而 2020 年这一比例还不到 25%。n8n 正是该类别中使用最广泛的开源方案之一。

本指南用到的 Quire API 端点

实施步骤有哪些？

1. 在 Quire 中创建应用以获取 API 凭据
2. 准备并运行一个 n8n 实例
3. 在 n8n 中完成 OAuth2 身份验证
4. 发送第一个 API 请求（读取任务）
5. 通过 API 创建或修改任务（写入）
6. 使用 sourceRef 存储来源引用或自定义元数据

1. 在 Quire 中创建应用

要访问 Quire API，你需要在 Quire 中注册一个应用，获取客户端 ID 和客户端密钥，并为 OAuth2 配置重定向 URI。

关于如何创建带 API 权限的 Quire 应用的详细步骤，请参阅我们的这篇博文。

2. 准备 n8n

你可以免费自托管 n8n 用于测试。可以参考这份官方文档。

启动后，创建一个新的工作流，用来添加执行 API 请求和处理响应的节点。

3. 完成 OAuth2 身份验证

Quire 使用 OAuth2 进行授权。当你创建凭据时，n8n 会帮你自动管理令牌交换。

• 在工作流视图中，添加一个新凭据并选择 OAuth2 选项。

• 填入来自你的 Quire 应用设置中的客户端 ID、客户端密钥、授权 URL、令牌 URL 和重定向 URI。重定向 URI 需要从 n8n 复制并粘贴到你的 Quire 应用设置中，以确保 OAuth2 流程正常运作。在 n8n 中，你必须将 "Authentication" 字段设置为 Body，才能确保凭据以 Quire 要求的正确格式发送。

• 点击 Connect to my account，n8n 会将你重定向到 Quire 的授权页面。选择要授权的项目并完成流程。

4. 发送第一个 API 请求（读取任务）

Quire API 文档：https://quire.io/dev/api/

使用 n8n 的 HTTP Request 节点调用 API。举例来说，获取某个项目的全部根任务：

• 基础 URL：https://quire.io/api
• 端点：/task/list/id/{projectId}（将 {projectId} 替换为你项目 URL 中的项目 ID，通常形如 https://quire.io/w/<projectId>）

在 HTTP Request 节点中：

• 方法：GET
• URL：https://quire.io/api/task/list/id/<your_project_id>
• Authentication：Generic Credential Type
• Generic Auth Type：OAuth2 API
• OAuth2 API：<你刚创建的凭据>

执行该节点，在右侧面板查看响应数据，你可以将这些数据传递给后续节点做进一步处理。

5. 创建或修改任务（写入）

你可以通过 API 创建任务（参见文档中的新增任务）。

• 端点：/task/id/{projectId}

在 n8n 的 HTTP Request 节点中：

• 方法：POST
• URL：https://quire.io/api/task/id/<your_project_id>
• 启用 Send Body，填入必填字段（例如 name）以及可选字段，比如 description。

启用 Send Body 后，请确保将 Body Content Type 设置为 JSON，并将 Specify Body 设置为 Using JSON。这样你就可以以 JSON 格式输入请求体，如下方示例代码所示：

{
  "name": "Example task",
  "description": "Created via n8n"
}

执行该节点；响应中会包含创建的任务详情，你也会在 Quire 项目中看到这个任务。

6. 使用 sourceRef 存储来源引用与自定义数据

带 sourceRef 的示例请求体：

{
  "name": "Task from n8n",
  "description": "Automated task",
  "sourceRef": {
    "text": "[Open in MyApp](https://example.com/item/123)",
    "meta": { "workflowId": "n8n-abc-123" }
  }
}

sourceRef 用于存储与任务相关的自定义数据。唯一预定义的字段是 text，它支持 Markdown，并会显示在 Quire 任务详情中，非常适合放置链接或简短说明，供用户点击。你在 sourceRef 下添加的其他字段完全由你的应用决定；例如，你可以加入一个 meta 对象或其他键，用来存储标识符或标记供自动化流程使用，但这些都是可选的。

当你通过 API 读取任务时，可以在返回的 JSON 中查找 sourceRef 对象。你能读取到 text 字段以及你存储的任何自定义数据，让你的自动化流程轻松追踪来源，并携带额外信息供后续处理使用。

创建或更新任务时，另一个有用的字段是 asUser。

如果将 asUser 设为 true，活动纪录中就会显示 Quire 应用的名称，作为创建或更新任务的用户。这有助于用户识别哪些任务是由 API 集成创建的。

如何处理 Quire API 错误？

调用 Quire API 时，几乎所有问题都可以归结为四种 HTTP 状态码。每一种都有对应的解决方法：

• 401 Unauthorized：检查你的 OAuth2 令牌是否有效、是否已过期。确认你的凭据配置正确。
• 400 Bad Request：检查你的请求体和参数。确保 JSON 格式正确，且已包含所有必填字段。
• 403 Forbidden：确认你的应用和用户是否有权限访问该项目或资源。
• 404 Not Found：仔细核对使用的 API 端点以及项目/任务 ID。

请务必参考 Quire API 文档，了解错误信息和所需参数的详细说明。如果遇到错误，请仔细阅读响应消息，其中通常会提示出错的原因。

如何用 Quire API 实现双向同步？

正如前文所述，你也可以使用 n8n 和 Quire API 搭建自己的双向同步方案。

想看实际示例，可以参考我们的开源仓库：n8n Quire API。该仓库提供了分步指南和可直接使用的模板，让你更容易在自己的应用与 Quire 之间实现双向同步。

关于如何用 Quire API 搭建双向同步的详细步骤，请参阅我们的这篇博文。

下一步该做什么？

现在你已经掌握了读取任务、创建任务、用 sourceRef 附加来源元数据，以及用 asUser 在活动纪录中标识你的集成所需的一切。同样的模式也可以扩展到其他 Quire API 端点；官方 API 文档是最权威的参考资料。

如果遇到问题，上面的错误处理部分覆盖了四种最常见的 HTTP 响应。如有其他问题，请发送邮件至 feedback@quire.io。

相关阅读：5 分钟完成 Quire MCP 设置：连接 Claude、ChatGPT 或任意 AI 客户端——如果你希望 AI 客户端直接与 Quire 协作，而不是自己编写 API 调用，MCP 会是更快捷的方案。

相关阅读：Quire Webhooks 设置分步指南——Webhooks 会在 Quire 中发生变化的那一刻把更新推送给你的自动化流程，而不必让你的工作流反复轮询 API。

常见问题解答

Quire API 是什么？我可以用它做什么？

这是一个开放 API，可以让你以编程方式读取和更新 Quire 任务。当应用程序目录中的现有应用程序不符合需求时，可以用它构建自定义集成。

如何通过 Quire API 进行身份验证？

Quire 使用 OAuth2。注册一个 Quire 应用，获取客户端 ID 和密钥，并将 n8n 的 authentication 字段设置为 Body，这样凭据就会按 Quire 要求的格式发送。

我可以用 n8n 与 Quire 集成吗？

可以。免费自托管 n8n，或使用 n8n.cloud，然后通过带 OAuth2 凭据的 HTTP Request 节点读写任务。同样的模式也适用于 Zapier 等类似平台。

Quire API 中的 sourceRef 是什么？

sourceRef 用于在任务上存储自定义数据。预定义的 text 字段支持 Markdown，并会渲染在任务详情中，你还可以附加 meta 等其他键，用来追踪来源或携带自动化元数据。

当 Quire API 返回错误时，我该检查什么？

401 表示令牌问题，400 表示请求体有误，403 表示权限问题，404 表示端点或 ID 错误。仔细阅读响应消息，它通常会直接指出问题所在。