簽名API

使用 SignatureAPI（專為自動化而構建的電子簽名平台）發送文件進行簽名、追蹤其進度並更快地完成工作。 https://signatureapi.com/docs/integrations/power-automate/getting-started

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	簽名 API， Inc.
URL	https://signatureapi.com
Email	support@signatureapi.com

連接器中繼資料
Publisher	簽名API
網站	https://signatureapi.com/power-automate
隱私策略	https://signatureapi.com/privacy
類別	通敵;生產力

簽名API

SignatureAPI 是一個專為自動化而構建的電子簽名平台。

使用我們的 Power Automate 電子簽名平台傳送文件進行簽署並追蹤其進度，該平台提供各種動作和觸發程序，以協助您建立簡單和複雜的工作流程。

使用 SignatureAPI 製作的電子簽名具有法律約束力並在全球範圍內被接受，就像大多數司法管轄區的傳統墨跡簽名一樣。

SignatureAPI 為大批量自動化提供經濟高效的定價。請參閱我們的定價詳細資訊。

主要功能

多個收件者：在一次交易中將文件傳送給最多 10 位簽署者。
平行或順序簽署：選擇一次或按特定順序將文件傳送給所有收件者。
文件模板：使用模板和動態數據以編程方式生成文件。
語言和本地化：使用不同的語言、日期時間格式和時區自定義簽名界面。
無帳戶簽名：允許收件人簽署文檔，而無需創建或登錄帳戶。
審計日誌：維護文件存取、審查和簽名事件的詳細日誌。
防篡改：透過經過驗證、無可辯駁的簽名後證明確保文件完整性。
追蹤信封：透過使用者友善的儀表板監控簽署進度。
Real-Time 通知：透過電子郵件和 Webhook 接收有關簽名活動的即時更新。

先決條件

若要使用此連接器，請註冊 SignatureAPI 帳戶並產生 API 金鑰。取得免費的測試 API 金鑰並設定您的連線。

使用者入門

最常見的工作流程涉及將一或多個文件傳送給收件者以供簽署。收件者會收到一封電子郵件，其中包含存取簽署介面的連結。

SignatureAPI 支援進階工作流程。探索我們的連接器指南，以取得逐步說明、使用案例和自動化策略。

步驟 1：建立信封

首先建立一個空信封。信封是保存文件和管理簽署過程的容器。

動作：建立信封

這些選項包括：

定義收件者是平行登入還是循序登入（收件者路由）
自訂語言、時區和日期時間格式（信封當地語系化）
設定寄件者的名稱和電子郵件

第 2 步：新增收件者

將收件人新增至信封，以指定需要簽署文件的人員。目前僅支援簽署者，但未來將提供其他收件者類型。

動作：新增收件者 — 簽署者

第 3 步：新增文件

將需要簽名的文件新增至信封。您可以上傳 PDF 或 DOCX 文件或使用數據從模板生成文檔。

第 4 步：定義文件中的位置

地點是文件中收件人互動的指定區域，例如簽署、提供姓名縮寫或新增文字。它們也可以包含靜態值或計算值，例如完成日期。

第 5 步：開始簽名過程

信封完全準備好後，啟動簽名過程。

動作：啟動信封

第 6 步：等待信封完成

若要將整個工作流程保留在同一個流程中，您可以等到信封完成。這可確保所有收件者都已簽署，並產生可傳送物（已簽署的文件）。

動作：等待信封

或者，您可以在信封完成並產生可傳送作業時觸發個別的工作流程。

觸發器：產生可傳送作業時

第 7 步：檢索已簽署的文件

程序完成後，請檢索已簽署的文件（可交付成果）。

動作：取得可交付成果

使用觸發器

SignatureAPI 提供觸發器來自動化您的工作流程並簡化流程。瞭解觸發器的完整清單以及如何使用它們。

常用觸發器

產生可傳送作業時

當信封完成且已簽署的文件（可交付成果）準備就緒時觸發。

當收件人完成信封時

每次收件者完成其部分簽署程序時觸發。

觸發器：收件者完成時

當收件人電子郵件退回時

當收件者的電子郵件地址無法接收請求時觸發。

已知問題和限制

使用測試 API 金鑰來建立測試信封。這些信封不會發送真正的電子郵件，也不計費，因此非常適合測試。進一步了解測試信封。
「等待信封」動作會在 30 天後逾時。如果您預期收件者需要更長的時間，請改用從「產生可傳送項目時」觸發器開始的新工作流程。

常見錯誤及解決方案

請確定 取得可交付成果 動作在 等待信封 動作之後執行。只有在所有收件者都完成其部分後，才能使用可傳送作業。
如果您從測試 API 金鑰切換至即時 API 金鑰，請更新觸發程序，以確保在正確的環境（即時或測試）中建立 Webhook。如需詳細資訊，請參閱我們的疑難排解指南。

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	securestring	SignatureAPI 帳戶的 API 金鑰。	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

刪除信封	刪除信封和所有相關資訊。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
取得交付項目	使用其 ID 擷取可傳送作業。使用它來下載信封的已簽署副本。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
取得信封	依信封 ID 擷取信封詳細資料。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
取得擷取的值	擷取收件者在簽署期間在輸入位置輸入的值。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
取得收件者	依收件者的 ID 擷取收件者詳細資料。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
啟動信封	起始信封的簽署程序。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
將資料新增至範本	將資料新增至範本。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
建立信封	建立新的信封，您可以在其中新增收件人和文件。準備就緒後，使用「啟動信封」動作來啟動簽署程序。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
建立儀式 — 自訂驗證	建立儀式，讓收件者在外部向 SignatureAPI 進行驗證。使用此選項可取得儀式 URL，以便與收件者共用。使用自訂驗證之前，請先閱讀 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
建立儀式 — 電子郵件連結驗證	建立儀式，透過傳送至其電子郵件的連結對收件者進行驗證。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
新增地點 — 信封完成日期	將信封完成日期地點新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
新增地點 — 姓名縮寫	將姓名縮寫位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
新增地點 — 收件者完成日期	將收件者完成的日期地點新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
新增地點 — 文字	將文字位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
新增地點 — 文字輸入	將文字輸入位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
新增地點 — 簽名	將簽名位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
新增收件者 — 簽署者	將收件人新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
新增文件 — DOCX	將 DOCX 文件新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
新增文件 — PDF	將 PDF 文件新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document
新增範本 — DOCX	將 DOCX 範本新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template
等待信封	等待信封達到已完成狀態或其他最終狀態。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

刪除信封

作業識別碼：: DeleteEnvelope

刪除信封和所有相關資訊。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。

取得交付項目

作業識別碼：: GetDeliverable

使用其 ID 擷取可傳送作業。使用它來下載信封的已簽署副本。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

參數

名稱	機碼	必要	類型	Description
可交付項目 ID	deliverableId	True	string	可傳送作業的 ID。

傳回

身體: Deliverable

取得信封

作業識別碼：: GetEnvelope

依信封 ID 擷取信封詳細資料。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。

傳回

身體: Envelope

取得擷取的值

作業識別碼：: GetCapture

擷取收件者在簽署期間在輸入位置輸入的值。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。
擷取金鑰	captureKey	True	string	擷取值的索引鍵。

傳回

身體: Capture

取得收件者

作業識別碼：: GetRecipient

依收件者的 ID 擷取收件者詳細資料。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

參數

名稱	機碼	必要	類型	Description
收件者 ID	recipientId	True	string	收件者的ID。

傳回

身體: Recipient

啟動信封

作業識別碼：: StartEnvelope

起始信封的簽署程序。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。

傳回

身體: StartEnvelopeOutput

將資料新增至範本

作業識別碼：: AddTemplateData

將資料新增至範本。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
欄位名稱	field_name	True	string	範本中欄位的名稱。
價值觀	value	True	string	範本中欄位的值。

建立信封

作業識別碼：: CreateEnvelope

建立新的信封，您可以在其中新增收件人和文件。準備就緒後，使用「啟動信封」動作來啟動簽署程序。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

參數

名稱	機碼	必要	類型	Description
信封標題	title	True	string	這個信封的標題。這可能會顯示給收件者。
信封標籤	label		string	信封上貼有客製化標籤，以便於識別。標籤僅供內部使用，不會向收件者顯示。
信封訊息	message		string	將傳送給收件者的訊息。
信封模式	mode		string	測試模式信封不具約束力，且不計費。
信封路由	routing		string	收件人簽署信封的順序。它可以是並行的，所有收件者都可以同時簽署，也可以是順序的，收件者一個接一個地簽署。
語言	language		string	簽署儀式和交付項目中使用的預設語言。如果未指定，則會使用帳戶的預設語言。 https://signatureapi.com/docs/localization/language
時區	timezone		string	要用於交付項目中時間戳記的時區。如果未指定，則會使用帳戶的預設時區偏移。 https://signatureapi.com/docs/localization/timezone
時間戳記格式	timestamp_format		string	要用於交付項目時間戳記的日期和時間格式。如果未指定，則會使用帳戶的預設時間戳記格式。 https://signatureapi.com/docs/localization/timestamp_format
信封證明	attestation		string	法規或合規性證明
名稱	name		string	寄件者的名稱。
Email	email		string	寄件者的電子郵件地址。
信封主題	topics		array of string	用於分類信封和篩選 Webhook 通知。
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: CreateEnvelopeOutput

建立儀式 — 自訂驗證

作業識別碼：: CreateCeremonyCustom

建立儀式，讓收件者在外部向 SignatureAPI 進行驗證。使用此選項可取得儀式 URL，以便與收件者共用。使用自訂驗證之前，請先閱讀 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

參數

名稱	機碼	必要	類型	Description
收件者 ID	recipientId	True	string	收件者的ID。
驗證提供者	provider	True	string	驗證提供者的名稱。此值是任意值，將出現在信封的稽核記錄中。
驗證資料	data	True	array of string	Key：包含驗證中繼資料的值組。這些詳細資料將包含在信封的稽核記錄中。
重新導向網址	redirect_url		string	儀式結束後要將收件者重新導向至的URL。了解更多： https://signatureapi.com/docs/resources/ceremonies/redirect-url
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: CreateCeremonyCustomOutput

建立儀式 — 電子郵件連結驗證

作業識別碼：: CreateCeremonyEmailLink

建立儀式，透過傳送至其電子郵件的連結對收件者進行驗證。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

參數

名稱	機碼	必要	類型	Description
收件者 ID	recipientId	True	string	收件者的ID。
重新導向網址	redirect_url		string	儀式結束後要將收件者重新導向至的URL。了解更多： https://signatureapi.com/docs/resources/ceremonies/redirect-url
額外屬性	extra		string	擴充性的額外屬性

傳回

response: object

新增地點 — 信封完成日期

作業識別碼：: AddPlaceEnvelopeCompletedDate

將信封完成日期地點新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
日期格式	date_format		string	定義日期和時間的格式。請參閱檔案以取得允許的值。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增地點 — 姓名縮寫

作業識別碼：: AddPlaceInitials

將姓名縮寫位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
收件者金鑰	recipient_key	True	string	這裡指的是收件人的鑰匙。
放置高度	height		number	設置自定義高度，寬度按比例調整。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增地點 — 收件者完成日期

作業識別碼：: AddPlaceRecipientCompletedDate

將收件者完成的日期地點新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
收件者金鑰	recipient_key	True	string	這裡指的是收件人的鑰匙。
日期格式	date_format		string	定義日期和時間的格式。請參閱檔案以取得允許的值。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增地點 — 文字

作業識別碼：: AddPlaceText

將文字位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
價值觀	value	True	string	此文字位置的值。
字體大小	font_size		number	字型大小（以點為單位）。
字體顏色	font_color		string	十六進位表示法的字型顏色。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增地點 — 文字輸入

作業識別碼：: AddPlaceTextInput

將文字輸入位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
收件者金鑰	recipient_key	True	string	這裡指的是收件人的鑰匙。
擷取為	capture_as		string	儲存收件人輸入並包含在信封擷取中的金鑰。
Hint	hint		string	收件者輸入欄位上方顯示的工具提示訊息。
Prompt	prompt		string	在簽署儀式期間，輸入文字欄位內顯示的佔位符訊息。
Requirement	requirement		string	指定收件者是否必須填寫此欄位才能完成簽署儀式。
格式	format		string	指定使用者輸入的有效格式。請參閱檔案以取得允許的值。
格式化訊息	format_message		string	當使用者的輸入不符合所需格式時顯示的訊息。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增地點 — 簽名

作業識別碼：: AddPlaceSignature

將簽名位置新增至文件。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

參數

名稱	機碼	必要	類型	Description
文件 ID	documentId	True	string	文件的 ID。
放置鍵	key	True	string	在文件中識別此位置的索引鍵。
收件者金鑰	recipient_key	True	string	這裡指的是收件人的鑰匙。
放置高度	height		number	設置自定義高度，寬度按比例調整。
頁碼	page		number	定位此位置的頁碼。
離頂部的距離	top		number	從頁面頂端到位置底部的距離（以點為單位）。
從左邊的距離	left		number	從頁面左側到該地點的距離（以點為單位）。
額外屬性	extra		string	擴充性的額外屬性

新增收件者 — 簽署者

作業識別碼：: AddRecipient

將收件人新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。
收件者名稱	name	True	string	收件者的名稱。
收件者電子郵件	email	True	string	收件者的電子郵件地址。
收件者金鑰	key	True	string	識別信封內收件人的金鑰。
獲獎典禮創建	ceremony_creation		string	如何創建收件人的儀式。
收件者遞送類型	delivery_type		string	如何將交付項目傳送給收件者。
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: AddRecipientSignerOutput

新增文件 — DOCX

作業識別碼：: AddDocumentDocx

將 DOCX 文件新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。
文件標題	title		string	本文件的標題。這可能會顯示給收件者。
檔案內容	file_content	True	byte	文件檔案的內容。
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: AddDocumentOutput

新增文件 — PDF

作業識別碼：: AddDocument

將 PDF 文件新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。
文件標題	title		string	本文件的標題。這可能會顯示給收件者。
檔案內容	file_content	True	byte	文件檔案的內容。
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: AddDocumentOutput

新增範本 — DOCX

作業識別碼：: AddTemplate

將 DOCX 範本新增至信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。
文件標題	title		string	本文件的標題。這可能會顯示給收件者。
檔案內容	file_content	True	byte	文件檔案的內容。
範本資料	data		array of string	欄位：包含要填寫到範本中的資料的值組。
額外屬性	extra		string	擴充性的額外屬性

傳回

身體: AddDocumentOutput

等待信封

作業識別碼：: WaitEnvelope

等待信封達到已完成狀態或其他最終狀態。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

參數

名稱	機碼	必要	類型	Description
信封 ID	envelopeId	True	string	信封的識別碼。

傳回

身體: Envelope

觸發程序

傳送收件者時	當要求傳送給收件者時，就會發生此事件。
取消信封時	當簽署程序在完成之前故意停止時，就會發生此事件，導致信封狀態為已取消。
完成信封時	當信封狀態從in_progress轉換為已完成時，就會發生此事件，表示所有收件人都已完成。
建立信封時	每當建立信封時，都會發生此事件。
收件者完成時	當收件者完成其部分簽署程式時，就會發生此事件。
產生可傳送作業時	當成功產生可傳送項目（例如稽核記錄）時，就會發生此事件。
當交付項目失敗時	當產生可傳送作業失敗時，就會發生此事件，導致可傳送作業狀態為失敗。
當信封失敗時	當信封失敗時，會發生此事件，導致信封狀態為失敗。
當信封開始時	當信封狀態從處理中轉換為in_progress時，就會發生此事件，表示已準備好傳送給收件人。
當收件人被拒絕時	當收件人拒絕信封時，就會發生此事件。
當收件人被替換時	當收件者被新收件者取代時，就會發生此事件。
當收件人被重新發送時	當要求重新傳送給收件者時，就會發生此事件。
當收件人退信時	當電子郵件暫時（軟退信）或永久（硬退信）無法送達時，就會發生此事件。
當收件者失敗時	當發生與收件者相關的失敗時，就會發生此事件，導致收件者狀態為失敗。
當收件者被釋放時	當收件人準備好傳送完成信封的請求時，就會發生此事件。

傳送收件者時

作業識別碼：: CreateEndpointForRecipientSent

當要求傳送給收件者時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientSent

取消信封時

作業識別碼：: CreateEndpointForEnvelopeCanceled

當簽署程序在完成之前故意停止時，就會發生此事件，導致信封狀態為已取消。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForEnvelopeCanceled

完成信封時

作業識別碼：: CreateEndpointForEnvelopeCompleted

當信封狀態從in_progress轉換為已完成時，就會發生此事件，表示所有收件人都已完成。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForEnvelopeCompleted

建立信封時

作業識別碼：: CreateEndpointForEnvelopeCreated

每當建立信封時，都會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForEnvelopeCreated

收件者完成時

作業識別碼：: CreateEndpointForRecipientCompleted

當收件者完成其部分簽署程式時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientCompleted

產生可傳送作業時

作業識別碼：: CreateEndpointForDeliverableGenerated

當成功產生可傳送項目（例如稽核記錄）時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForDeliverableGenerated

當交付項目失敗時

作業識別碼：: CreateEndpointForDeliverableFailed

當產生可傳送作業失敗時，就會發生此事件，導致可傳送作業狀態為失敗。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForDeliverableFailed

當信封失敗時

作業識別碼：: CreateEndpointForEnvelopeFailed

當信封失敗時，會發生此事件，導致信封狀態為失敗。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForEnvelopeFailed

當信封開始時

作業識別碼：: CreateEndpointForEnvelopeStarted

當信封狀態從處理中轉換為in_progress時，就會發生此事件，表示已準備好傳送給收件人。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForEnvelopeStarted

當收件人被拒絕時

作業識別碼：: CreateEndpointForRecipientRejected

當收件人拒絕信封時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientRejected

當收件人被替換時

作業識別碼：: CreateEndpointForRecipientReplaced

當收件者被新收件者取代時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientReplaced

當收件人被重新發送時

作業識別碼：: CreateEndpointForRecipientResent

當要求重新傳送給收件者時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientResent

當收件人退信時

作業識別碼：: CreateEndpointForRecipientBounced

當電子郵件暫時（軟退信）或永久（硬退信）無法送達時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientBounced

當收件者失敗時

作業識別碼：: CreateEndpointForRecipientFailed

當發生與收件者相關的失敗時，就會發生此事件，導致收件者狀態為失敗。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientFailed

當收件者被釋放時

作業識別碼：: CreateEndpointForRecipientReleased

當收件人準備好傳送完成信封的請求時，就會發生此事件。

參數

名稱	機碼	必要	類型	Description
主題	topics		array of string	用於分類信封和篩選 Webhook 通知。

傳回

身體: NotificationForRecipientReleased

定義

信封

名稱	路徑	類型	Description
信封 ID	id	EnvelopeId	信封的識別碼。
信封標題	title	EnvelopeTitle	這個信封的標題。這可能會顯示給收件者。
信封標籤	label	EnvelopeLabel	信封上貼有客製化標籤，以便於識別。標籤僅供內部使用，不會向收件者顯示。
信封訊息	message	EnvelopeMessage	將傳送給收件者的訊息。
傳送者	sender	EnvelopeSender
信封狀態	status	EnvelopeStatus	信封的狀態。
可交付成果	deliverable	EnvelopeDeliverable
信封完成時間	completed_at	EnvelopeCompletedAt	所有收件人完成信封的時間。
信封模式	mode	EnvelopeMode	測試模式信封不具約束力，且不計費。
信封路由	routing	EnvelopeRouting	收件人簽署信封的順序。它可以是並行的，所有收件者都可以同時簽署，也可以是順序的，收件者一個接一個地簽署。
時區	timezone	EnvelopeTimezone	要用於交付項目中時間戳記的時區。如果未指定，則會使用帳戶的預設時區偏移。 https://signatureapi.com/docs/localization/timezone
時間戳記格式	timestamp_format	EnvelopeTimestampFormat	要用於交付項目時間戳記的日期和時間格式。如果未指定，則會使用帳戶的預設時間戳記格式。 https://signatureapi.com/docs/localization/timestamp_format
信封證明	attestation	EnvelopeAttestation	法規或合規性證明
信封主題	topics	EnvelopeTopics	用於分類信封和篩選 Webhook 通知。

Recipient

名稱	路徑	類型	Description
收件者 ID	id	RecipientId	收件者的ID。
信封 ID	envelope_id	EnvelopeId	信封的識別碼。
收件者類型	type	RecipientType	收件者的類型。
收件者金鑰	key	RecipientKey	識別信封內收件人的金鑰。
收件者名稱	name	RecipientName	收件者的名稱。
收件者電子郵件	email	RecipientEmail	收件者的電子郵件地址。
收件者狀態	status	RecipientStatus	收件者的狀態。
獲獎典禮創建	ceremony_creation	RecipientCeremonyCreation	如何創建收件人的儀式。
收件者遞送類型	delivery_type	RecipientDeliveryType	如何將交付項目傳送給收件者。
收件人完成時間	completed_at	RecipientCompletedAt	收件人完成信封的時間。

可交付成果

名稱	路徑	類型	Description
可交付成果 ID	id	DeliverableId	可傳送作業的 ID。
可交付成果類型	type	DeliverableType	可交付成果的類型。
可交付成果狀態	status	DeliverableStatus	可傳送作業的狀態。
檔案內容	file_content	DeliverableFileContent	可傳送作業的檔案內容。使用它來儲存信封的已簽署副本。

擷取

名稱	路徑	類型	Description
捕獲價值	value	CaptureValue	收件者輸入擷取的值

CreateEnvelope輸出

名稱	路徑	類型	Description
信封 ID	id	EnvelopeId	信封的識別碼。
信封標題	title	EnvelopeTitle	這個信封的標題。這可能會顯示給收件者。
信封標籤	label	EnvelopeLabel	信封上貼有客製化標籤，以便於識別。標籤僅供內部使用，不會向收件者顯示。
信封訊息	message	EnvelopeMessage	將傳送給收件者的訊息。
傳送者	sender	EnvelopeSender
信封模式	mode	EnvelopeMode	測試模式信封不具約束力，且不計費。
信封路由	routing	EnvelopeRouting	收件人簽署信封的順序。它可以是並行的，所有收件者都可以同時簽署，也可以是順序的，收件者一個接一個地簽署。
時區	timezone	EnvelopeTimezone	要用於交付項目中時間戳記的時區。如果未指定，則會使用帳戶的預設時區偏移。 https://signatureapi.com/docs/localization/timezone
時間戳記格式	timestamp_format	EnvelopeTimestampFormat	要用於交付項目時間戳記的日期和時間格式。如果未指定，則會使用帳戶的預設時間戳記格式。 https://signatureapi.com/docs/localization/timestamp_format
信封證明	attestation	EnvelopeAttestation	法規或合規性證明
信封主題	topics	EnvelopeTopics	用於分類信封和篩選 Webhook 通知。

StartEnvelope輸出

名稱	路徑	類型	Description
信封狀態	status	EnvelopeStatus	信封的狀態。

新增文件輸出

名稱	路徑	類型	Description
文件 ID	id	DocumentId	文件的 ID

AddRecipientSigner輸出

名稱	路徑	類型	Description
收件者 ID	id	RecipientId	收件者的ID。
收件者名稱	name	RecipientName	收件者的名稱。
收件者電子郵件	email	RecipientEmail	收件者的電子郵件地址。
收件者金鑰	key	RecipientKey	識別信封內收件人的金鑰。
獲獎典禮創建	ceremony_creation	RecipientCeremonyCreation	如何創建收件人的儀式。
收件者遞送類型	delivery_type	RecipientDeliveryType	如何將交付項目傳送給收件者。

CreateCeremonyCustomOutput

名稱	路徑	類型	Description
儀式網址	url	CeremonyUrl	收件者必須造訪才能啟動儀式的URL

EnvelopeId

信封的識別碼。

信封 ID: string

信封標題

這個信封的標題。這可能會顯示給收件者。

信封標題: string

信封標籤

信封上貼有客製化標籤，以便於識別。標籤僅供內部使用，不會向收件者顯示。

信封標籤: string

信封訊息

將傳送給收件者的訊息。

信封訊息: string

信封路由

收件人簽署信封的順序。它可以是並行的，所有收件者都可以同時簽署，也可以是順序的，收件者一個接一個地簽署。

信封路由: string

信封時區

要用於交付項目中時間戳記的時區。如果未指定，則會使用帳戶的預設時區偏移。 https://signatureapi.com/docs/localization/timezone

時區: string

EnvelopeTimestampFormat

要用於交付項目時間戳記的日期和時間格式。如果未指定，則會使用帳戶的預設時間戳記格式。 https://signatureapi.com/docs/localization/timestamp_format

時間戳記格式: string

信封寄件者

名稱	路徑	類型	Description
寄件者名稱	name	string	寄件者的名稱。
寄件者電子郵件	email	string	寄件者的電子郵件地址。

信封狀態

信封的狀態。

信封狀態: string

信封模式

測試模式信封不具約束力，且不計費。

信封模式: string

信封主題

用於分類信封和篩選 Webhook 通知。

名稱	路徑	類型	Description
物品		string

信封證明

法規或合規性證明

信封證明: string

信封可交付項目

名稱	路徑	類型	Description
可交付項目 ID	id	string	可傳送作業的 ID。使用此選項可下載信封的已簽署副本。

信封完成時間

所有收件人完成信封的時間。

信封完成時間: date-time

DocumentId

文件的 ID

文件 ID: string

收件者識別碼

收件者的ID。

收件者 ID: string

RecipientType

收件者的類型。

收件者類型: string

收件者名稱

收件者的名稱。

收件者名稱: string

收件者電子郵件

收件者的電子郵件地址。

收件者電子郵件: string

收件者金鑰

識別信封內收件人的金鑰。

收件者金鑰: string

收件者狀態

收件者的狀態。

收件者狀態: string

RecipientCeremony創作

如何創建收件人的儀式。

獲獎典禮創建: string

收件者傳遞類型

如何將交付項目傳送給收件者。

收件者遞送類型: string

收件者完成時間

收件人完成信封的時間。

收件人完成時間: date-time

交付項目標識符

可傳送作業的 ID。

可交付成果 ID: string

DeliverableType

可交付成果的類型。

可交付成果類型: string

可交付項目狀態

可傳送作業的狀態。

可交付成果狀態: string

可交付文件內容

可傳送作業的檔案內容。使用它來儲存信封的已簽署副本。

檔案內容: byte

儀式網址

收件者必須造訪才能啟動儀式的URL

儀式網址: string

擷取值

收件者輸入擷取的值

捕獲價值: string

NotificationForEnvelope已建立

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。

NotificationForEnvelope已開始

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。

NotificationForEnvelope已完成

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。

NotificationForEnvelope失敗

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
詳細資料	data.detail	string	有關失敗的資訊。

NotificationForEnvelope已取消

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。

NotificationForRecipient已釋放

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。

NotificationForRecipient已發送

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。

NotificationForRecipient已完成

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。

NotificationForRecipient已拒絕

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。
原因	data.reason	string	收件者對拒絕的說明。

NotificationForRecipientBounced

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。
詳細資料	data.detail	string	有關反彈的資訊。

NotificationForRecipient失敗

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。
詳細資料	data.detail	string	有關失敗的資訊。

NotificationForRecipient已取代

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。
新的收件者 ID	data.new_recipient_id	string	新收件者的ID。

NotificationForRecipientResent

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
收件者 ID	data.object_id	EventRecipientId	此事件所參考的收件者識別碼。
收件者類型	data.recipient_type	EventRecipientType	此事件所參考的收件者型別。
收件者金鑰	data.recipient_key	EventRecipientKey	此事件所參考的收件者金鑰。

NotificationForDeliverableGenerated

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
可交付項目 ID	data.object_id	EventDeliverableId	此事件所參考的交付項目的 ID。

NotificationForDeliverable失敗

名稱	路徑	類型	Description
事件識別碼	id	EventId	事件的標識碼。
事件時間戳	timestamp	EventTimestamp	事件的日期和時間，採用 ISO 8601 格式。
事件類型	type	EventType	事件的類型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件所參考的信封 ID。
可交付項目 ID	data.object_id	EventDeliverableId	此事件所參考的交付項目的 ID。
詳細資料	data.detail	string	有關失敗的資訊。

事件標識符

事件的標識碼。

事件識別碼: string

事件時間戳記

事件的日期和時間，採用 ISO 8601 格式。

事件時間戳: date-time

事件類型

事件的類型。

事件類型: string

EventEnvelopeId

此事件所參考的信封 ID。

信封 ID: string

事件收件人標識符

此事件所參考的收件者識別碼。

收件者 ID: string

事件收件者類型

此事件所參考的收件者型別。

收件者類型: string

EventRecipient索引鍵

此事件所參考的收件者金鑰。

收件者金鑰: string

EventDeliverableId

此事件所參考的交付項目的 ID。

可交付項目 ID: string

物件

這是類型 'object'。

共用方式為

簽名API

簽名API

主要功能

先決條件

使用者入門

步驟 1：建立信封

第 2 步：新增收件者

第 3 步：新增文件

第 4 步：定義文件中的位置

第 5 步：開始簽名過程

第 6 步：等待信封完成

第 7 步：檢索已簽署的文件

使用觸發器

常用觸發器

產生可傳送作業時

當收件人完成信封時

當收件人電子郵件退回時

已知問題和限制

常見錯誤及解決方案

正在建立連線

預設

節流限制

動作

刪除信封

參數

取得交付項目

參數

傳回

取得信封

參數

傳回

取得擷取的值

參數

傳回

取得收件者

參數

傳回

啟動信封

參數

傳回

將資料新增至範本

參數

建立信封

參數

傳回

建立儀式 — 自訂驗證

參數

傳回

建立儀式 — 電子郵件連結驗證

參數

傳回

新增地點 — 信封完成日期

參數

新增地點 — 姓名縮寫

參數

新增地點 — 收件者完成日期

參數

新增地點 — 文字

參數

新增地點 — 文字輸入

參數

新增地點 — 簽名

參數

新增收件者 — 簽署者

參數

傳回

新增文件 — DOCX

參數

傳回

新增文件 — PDF

參數

傳回

新增範本 — DOCX

參數

傳回

等待信封

參數

傳回

觸發程序