跳至主要內容

開發者 API 與 Webhook

在開發者中心建立 API 金鑰、註冊 webhook 端點,並檢閱請求記錄。

作者:Sarah Chen

開發者中心 是您將 Exayard 連接至自己程式碼與工具的地方。從 設定 接著 開發者 開啟它。您可在此建立 API 金鑰、註冊 Webhook 端點,並檢閱每筆 API 請求的即時記錄。只有組織管理員可以進入此頁面。

API 金鑰

API 金鑰 用於驗證對 Exayard API 發出的請求。金鑰隸屬於您的組織,因此會自動選取正確的帳戶,無需傳入組織 ID。

開啟 憑證 卡片中的 API 金鑰 分頁,並按一下 + 按鈕。為金鑰命一個 名稱,然後選擇它的 範圍。選擇 全部 以授予每個範圍,或選擇 特定 以挑選個別權限。範圍依每項資源遵循讀取與寫入的劃分,例如 read:projectswrite:estimatesadmin:org 範圍為完整存取權的授予。請選擇您整合所需的最少範圍。

Exayard 只會在您建立金鑰後立即完整顯示一次。請當下即複製它,因為它不會再次顯示。在那之後,每組金鑰都會連同其名稱、一段像 ak_••••1234 這樣的遮蔽預覽,以及它最後一次使用的日期一併顯示。

使用鉛筆圖示可重新命名金鑰或變更其範圍。使用垃圾桶圖示可 撤銷 它。撤銷是永久性的,任何使用該金鑰的整合都會立即停止運作。

同一組金鑰也可驗證無程式碼整合。請參閱 將 Exayard 連接至 Zapier將 Exayard 連接至 Make,以及 將 Exayard 連接至 n8n。如需代理人與 AI 編輯器存取權,請參閱 連接至 Claude 與其他 AI 工具

Webhook

Webhook 會告知 Exayard 在發生某事時通知您的伺服器。開啟 Webhook 分頁並按一下 + 以新增一個端點。輸入應接收傳遞的 URL,以及一個選用的 描述

選擇要訂閱哪些 事件。選擇 全部 以接收每個事件,或選擇 特定 以從清單中挑選:

事件

觸發時機

project.created

建立一個專案時

project.updated

變更一個專案時

project.archived

封存一個專案時

assessment.started

一筆算量評估開始時

assessment.completed

一筆評估完成時

assessment.approved

一筆評估獲得核准時

assessment.cancelled

一筆評估遭到取消時

estimate.generated

產生一筆估價單時

bid.generated

產生一筆投標時

file.processed

一個已上傳的檔案完成處理時

當您建立一個端點時,Exayard 只會顯示一次 簽署密鑰。請當下即複製它,因為它不會再次顯示。

保護 Webhook 傳遞的安全

每筆傳遞都帶有一個 Exayard-Signature 標頭,格式為 t=<unix>,v1=<digest>。Exayard 會將時間戳記與請求主體合併,然後使用您的端點密鑰以 HMAC-SHA256 簽署它們,藉此建立簽章。

若要驗證一筆傳遞,請使用您的密鑰重新計算簽章,確認時間戳記在目前時間的五分鐘以內,並比對摘要。失敗的傳遞會在約三天內以指數退避重試。

若要編輯一個端點,請按一下鉛筆圖示。您可以變更 URL、描述與事件,並將其 狀態 設為 使用中已暫停。已暫停的端點會停止接收傳遞。同一個對話方塊有一個 輪替密鑰 按鈕。輪替會發出一組新密鑰,舊密鑰會立即停止運作,因此請在輪替前先更新您的伺服器。垃圾桶圖示會刪除一個端點,並結束對它的所有傳遞。

快速入門

快速入門 卡片內含一個現成的提示,可用於像 Claude 或 Cursor 這類 AI 編輯器。按一下 複製提示,並將其貼入您的編輯器。此提示包含 API 基底 URL、驗證格式、範圍詞彙,以及 Webhook 簽署機制,讓 AI 能夠搭建出一個可運作的整合,並向您詢問它所需的詳細資料。

文件

文件 卡片連結至完整的開發者文件以及 OpenAPI spec,後者描述了每個路由與結構描述。連接 MCP 會開啟將 AI 代理人直接連接至 Exayard 的設定。

記錄

記錄 區段會記錄您橫跨 REST API 與 MCP 的最近數筆 API 請求。每一列都會顯示方法、路徑、回應狀態與延遲。選取某一列即可查看其完整詳細資料,包括請求 ID 以及請求與回應主體。使用記錄即可確認某次呼叫是否成功,或對失敗的整合進行偵錯。

是否回答了您的問題?