透過 Quire API 整合外部工具──以 n8n 為例

最後更新：2026年7月20日

Quire 提供一個開放式 API,可以讓你透過程式讀取及更新 Quire 任務。應用程式目錄入面好多應用程式,都係直接同 Quire API 互動嚟建立嘅。

如果現有應用程式未能滿足你嘅需求,你可以建立自訂整合。呢篇文章會以 n8n 作為示例自動化平台,講解點樣使用 Quire API;同樣嘅概念亦適用於 Zapier 呢類其他低程式碼平台。

呢個做法愈嚟愈普遍。Gartner 估計到 2025 年,組織開發嘅新應用程式當中會有 70% 使用低程式碼或無程式碼技術,較 2020 年嘅不足 25% 大幅上升。n8n 就係呢個類別入面最廣泛使用嘅開源選項之一。

呢篇指南用到嘅 Quire API endpoints

實施步驟係咩?

1. 喺 Quire 建立一個應用程式,取得 API 憑證
2. 準備並執行一個 n8n 實例
3. 喺 n8n 用 OAuth2 進行身份驗證
4. 發送第一個 API 請求(讀取任務)
5. 透過 API 建立或修改任務(寫入)
6. 使用 sourceRef 儲存來源參照或自訂中繼資料

1. 喺 Quire 建立一個應用程式

要存取 Quire API,你需要喺 Quire 註冊一個應用程式,取得 client ID 同 client secret,並為 OAuth2 設定 redirect URI。

想睇逐步指南,了解點樣建立你自己嘅 Quire API 應用程式,歡迎瀏覽我哋嘅網誌文章。

2. 準備 n8n

你可以免費自行架設 n8n 作測試用途。可以參考呢份官方文件。

執行之後,建立一個新嘅工作流程,喺入面加入節點嚟執行 API 請求並處理回應。

3. 使用 OAuth2 進行身份驗證

Quire 使用 OAuth2 進行授權。當你建立憑證時,n8n 會幫你處理 token 交換。

• 喺工作流程檢視入面,新增一個憑證,並選擇 OAuth2 選項。

• 填入你嘅 Quire 應用程式設定入面嘅 client ID、client secret、授權 URL、token URL 同 redirect URI。redirect 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
• Endpoint:/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 建立任務(參閱文件入面嘅新增任務)。

• Endpoint:/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 錯誤?

四個 HTTP 狀態碼幾乎涵蓋咗你使用 Quire API 時會遇到嘅所有問題。每一個都有對應嘅解決方法:

• 401 Unauthorized:檢查你嘅 OAuth2 token 係咪有效同未過期。確認你嘅憑證設定正確。
• 400 Bad Request:檢查你嘅請求主體同參數。確保 JSON 格式正確,並包含所有必要欄位。
• 403 Forbidden:確認你嘅應用程式同使用者有授權存取該專案或資源。
• 404 Not Found:仔細核對你使用嘅 API endpoint 同專案/任務 ID。

務必參考 Quire API 文件,了解錯誤訊息同必要參數嘅詳情。如果遇到錯誤,請仔細閱讀回應訊息,通常入面會提供問題所在嘅提示。

點樣實現 Quire API 嘅雙向同步?

正如前面提到嘅文章所述,你亦可以用 n8n 同 Quire API 建立屬於自己嘅雙向同步方案。

想睇實際範例,可以參考我哋嘅開源 repository:n8n Quire API。呢個 repository 提供逐步指南同一個可用嘅範本,幫助你更容易喺你嘅應用程式同 Quire 之間實現雙向同步。

想睇逐步指南,了解點樣用 Quire API 建立雙向同步,歡迎瀏覽我哋嘅網誌文章。

下一步係咩?

你而家已經掌握咗讀取任務、建立任務、用 sourceRef 附加來源中繼資料,以及用 asUser 喺活動紀錄入面標明你整合身份嘅方法。同樣嘅模式亦適用於其他 Quire API endpoints;官方 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 應用程式,取得 client ID 同 secret,並將 n8n 嘅 authentication 欄位設為 Body,咁樣憑證先會以 Quire 要求嘅格式傳送。

可唔可以用 n8n 同 Quire 做整合?

可以。你可以免費自行架設 n8n,或者使用 n8n.cloud,然後用配合 OAuth2 憑證嘅 HTTP Request 節點嚟讀寫任務。同樣嘅模式亦適用於 Zapier 呢類相似平台。

Quire API 入面嘅 sourceRef 係咩?

sourceRef 用嚟喺任務入面儲存自訂資料。預先定義嘅 text 欄位支援 Markdown,並會顯示喺任務詳情入面,而你亦可以加入其他任何鍵值,例如 meta,用嚟追蹤來源或攜帶自動化中繼資料。

Quire API 回傳錯誤時應該檢查啲咩?

401 代表 token 有問題,400 代表請求主體有誤,403 代表授權問題,而 404 代表 endpoint 或 ID 錯誤。請仔細閱讀回應訊息,通常會直接指向解決方法。