PlatoForms User Guide
Ctrl+K

  • Form Builder

    Creating an Online Form for an Existing PDF

  • Custom Domain

    With Builder you can build three types of forms: online web forms, online PDF forms, and master forms.

  • Master Form Builder

    you will arrive at the Form Builder. On the form Builder, there are three main sections:

What's new? API Docs

API 和 Webhooks

本頁內容

API 和 Webhooks 頁面是您的團隊管理工具以將 PlatoForms 連接到外部服務的地方：將表單提交推送到其他系統的 webhook 端點、用於第三方整合的 OAuth2 應用程序，以及用於伺服器對伺服器 API 調用的長期令牌。本章將介紹如何訪問該頁面並配置這些工具。

訪問 API 和 Webhooks 頁面

  1. 登入您的儀表板。

  2. 在左側邊欄中，點擊您的團隊名稱以打開團隊菜單。

  3. 從列表中選擇 API 和 Webhooks。

    團隊菜單中突出顯示的 API 和 Webhooks

根據您的權限看到的內容

如果您有訪問權限

該頁面直接打開到 API URL 和令牌，您可以在此查看和管理您的 webhooks、OAuth2 應用程序和令牌。

Note

團隊管理員始終可以直接訪問此頁面。

如果您沒有訪問權限

API 和 Webhooks 顯示為帶鎖圖標，並標有 「請求管理員授權」 標籤。

點擊 請求管理員授權 發送請求。

團隊菜單中受限的 API 和 Webhooks

您的團隊管理員會收到一封電子郵件通知他們該請求。一旦授予訪問權限，您將能夠從自己的團隊菜單中打開 API 和 Webhooks。

配置 Webhook 端點

設置端點以在表單提交或其他事件發生時接收即時通知。這對於將表單數據整合到其他應用程序或服務中非常有用。

點擊 + 添加端點 以創建一個新的，或點擊現有端點旁邊的編輯圖標進行修改。

添加端點

在添加或編輯端點時，您可以配置：

欄位 描述
名稱 幫助您識別端點的標籤。
WebHook URL 將接收 POST 請求的 URL。
自定義請求標頭 每次傳送最多可附帶 5 個標頭名稱和值，例如您的伺服器檢查的密鑰。點擊 + 添加標題 以添加一個。
發送時間 端點接收的事件：表單已提交（預設）、工作流程運行或任務變更、文件已請求、接收或審核，或 續訂已計劃、發送、完成或過期。
目標表單 選擇 所有表單 以接收每個表單的所選事件，或選擇特定表單。使用 表單已提交 時，所有表單 會觸發任何表單提交的 webhook。
包含可共享鏈接 在有效負載中包含可共享的提交鏈接。
將提交數據作為字典（而非列表） 更改有效負載中提交數據的結構。此頁面上創建的端點預設為開啟；通過 API 創建的端點則為關閉。
即時 Hook（不等待 PDF 創建） 立即觸發 webhook，而不是等待提交 PDF 完成生成。
從有效負載中排除簽名數據 從有效負載中省略簽名數據。
Webhook 啟用 在不刪除的情況下打開或關閉端點（編輯現有端點時可用）。

點擊 保存 以應用您的更改，或 刪除 以完全刪除端點。

有效負載選項（可共享鏈接、字典、即時 Hook 和簽名數據）僅適用於提交 webhook。

傳送和失敗

任何 2xx 回應都算作已傳送。不會跟隨重定向，且伺服器在 30 秒內未回應則算作失敗。編輯窗口顯示 最後錯誤： 及簡短原因，例如 “HTTP 500” 或 “30 秒內無回應”。

持續失敗的端點（至少連續失敗 5 次且超過 72 小時）會自動關閉，團隊擁有者和具有 API 訪問權限的成員會收到電子郵件。修復接收伺服器後，啟用 Webhook 啟用 並點擊 保存。在關閉期間發生的事件不會被發送。

創建 OAuth2 應用程序

PlatoForms 的 API 由 OAuth2 協議保護，這是一個安全的身份驗證和授權框架。「OAuth2 應用程序」指的是利用 OAuth 2.0 與系統交互的註冊應用程序。

通過創建 OAuth2 應用程序，您可以通過身份驗證過程安全地獲取 客戶端 ID 和 客戶端密鑰。這反過來又促進了其他應用程序安全授權訪問平台的 API。創建「OAuth2 應用程序」設置了安全整合的基本組件，允許使用 OAuth2 進行身份驗證和授權的 API 交互。

要創建 OAuth2 應用程序：

  1. 點擊 + 添加應用程序。

    添加應用程序

  2. 在打開的窗口中：

    創建 OAuth2 應用程序

    • 為您的應用程序提供一個 名稱，以幫助在系統中識別它。

    • 指定一個 重定向 URL，這對於 OAuth2 流程至關重要。

  3. 點擊 保存 以確認您的設置。

一旦應用程序保存，系統將生成一個唯一的 客戶端 ID 和 客戶端密鑰。立即複製密鑰：它以哈希形式存儲且僅顯示一次。如果丟失，請在應用程序上使用 重新生成密鑰；舊密鑰會立即失效，因此請更新使用該密鑰的每個集成。

創建和重置您的令牌

如果您是需要長期 API 訪問的開發人員，該平台提供創建和重置團隊 無過期令牌 的功能。此功能消除了定期刷新令牌的需要，確保伺服器對伺服器請求的 API 訪問不中斷且持久。每個團隊都有一個無過期令牌。

只需點擊 創建或重置 以生成令牌，並在需要時使用 刪除 來刪除它。此功能簡化了管理長期 API 訪問的過程。

該令牌攜帶團隊擁有者的 API 訪問權限。重置它會替換令牌，仍在使用舊令牌的集成會立即停止工作，因此請先與設置它們的人員確認。

AI 助理訪問權限 (MCP)

此頁面的 AI 助理訪問權限 (MCP) 面板可為整個團隊開啟或關閉 AI 助理訪問權限。請參閱 AI 助理 (MCP)。

Note

將令牌、客戶端 ID 和客戶端密鑰視為密碼。任何擁有它們的人都可以訪問您的團隊數據。

如果您更願意透過 AI 助手以對話方式處理表單——無需編寫任何程式碼——請參閱 AI 助手（MCP）。

Is the content helpful?
Give feedback about this article