SignRequest (預覽版)
SignRequest 是一款安全且具有法律約束力的電子簽名工具,使您能夠和您的合作夥伴快速簽署合同和其他文檔,而無需打印、簽名和掃描。
此連接器適用於以下產品和區域:
| 服務 | 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) |
| 連絡人 | |
|---|---|
| tech-support@signrequest.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | SignRequest B.V. |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
|
傳送 Sign |
建立並傳送新的 SignRequest。 |
傳送 SignRequest
建立並傳送新的 SignRequest。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自動刪除天數
|
auto_delete_days | integer |
完成的文件(已簽署/取消/拒絕)將自動刪除的天數 |
|
|
自動到期天數
|
auto_expire_days | integer |
未完成文件自動過期的天數 |
|
|
停用附件
|
disable_attachments | boolean |
停用上傳/新增附件 |
|
|
禁用區塊鏈證明
|
disable_blockchain_proof | boolean |
停用在區塊鏈整合中儲存時間戳記證明雜湊。 |
|
|
停用日期
|
disable_date | boolean |
停用新增日期 |
|
|
停用電子郵件
|
disable_emails | boolean |
停用所有 SignRequest 狀態電子郵件,以及包含已簽署文件的電子郵件 |
|
|
停用文字
|
disable_text | boolean |
停用新增文字 |
|
|
停用文字簽名
|
disable_text_signatures | boolean |
停用輸入產生的簽名 (文字) |
|
|
停用上傳簽名
|
disable_upload_signatures | boolean |
停用使用已上傳的簽名(影像) |
|
|
文件
|
document | uri | ||
|
事件回呼網址
|
events_callback_url | uri |
接收此檔案事件 回呼 的URL |
|
|
外部ID
|
external_id | string |
用於在外部系統中引用文件的 ID |
|
|
檔案
|
file | uri |
原始檔案的臨時 URL,五分鐘後到期 |
|
|
從內容檔案
|
file_from_content | byte |
Base64 編碼的文件內容 |
|
|
內容名稱中的檔案
|
file_from_content_name | string |
檔案名稱,包括副檔名。 使用 |
|
|
從 url 檔案
|
file_from_url | uri |
SignRequest 要下載的文件的可公開存取 URL |
|
|
來自電子郵件
|
from_email |
傳送 SignRequest 的使用者電子郵件 (必須是經過驗證的電子郵件) |
||
|
從電子郵件名稱
|
from_email_name | string |
要在電子郵件標題中使用的 |
|
|
前端 ID
|
frontend_id | string |
與 SignRequest-js 用戶端 搭配使用的共用密碼,以授與使用者存取非文件小組成員之文件的存取權 |
|
|
正在準備中
|
is_being_prepared | boolean |
讓 SignRequest 的寄件者在傳送要求之前準備文件,請參閱: 使用 Web 介面進行準備 |
|
|
Message
|
message | string |
要包含在 SignRequest 電子郵件中的訊息,可能包含下列 html 標籤: |
|
|
名稱
|
name | string |
預設為檔案名稱,包括副檔名 |
|
|
預先填入標籤核取方塊值
|
checkbox_value | boolean | ||
|
預先填入標籤日期值
|
date_value | date | ||
|
預先填入標籤外部ID
|
external_id | string | ||
|
預先填入標籤文字
|
text | string | ||
|
準備網址
|
prepare_url | uri | ||
|
重新導向網址
|
redirect_url | uri |
簽署文件時,SignRequest 將重新導向至 URL |
|
|
重新導向網址被拒絕
|
redirect_url_declined | uri |
當文件被拒絕時,SignRequest 將重新導向至 URL |
|
|
必要的附件名稱
|
name | True | string | |
|
必要的附件 Uuid
|
uuid | string | ||
|
傳送提醒
|
send_reminders | boolean |
自動提醒簽署者簽署文件,請參閱: 自動提醒 |
|
|
文件後的簽署者
|
after_document | uri | ||
|
僅限簽署者核准
|
approve_only | boolean |
要求使用者核准文件 (不新增簽名),請參閱: 僅核准 |
|
|
檔案
|
file | uri | ||
|
必要的附件名稱
|
name | True | string | |
|
必要的附件 Uuid
|
uuid | string | ||
|
名稱
|
name | string |
預設為檔案名稱 |
|
|
烏伊德
|
uuid | string | ||
|
簽署者拒絕
|
declined | boolean | ||
|
簽名者拒絕了
|
declined_on | date-time | ||
|
簽署者顯示名稱
|
display_name | string | ||
|
簽署者已下載
|
downloaded | boolean | ||
|
簽署者電子郵件
|
True | |||
|
已檢視的簽署者電子郵件
|
email_viewed | boolean | ||
|
簽署者已傳送電子郵件
|
emailed | boolean | ||
|
簽署者內嵌網址
|
embed_url | uri | ||
|
簽署者內嵌 URL 使用者 ID
|
embed_url_user_id | string | ||
|
簽署人名字
|
first_name | string | ||
|
手語強制語言
|
force_language | boolean | ||
|
簽署人轉寄
|
forwarded | boolean | ||
|
簽署人轉寄
|
forwarded_on | date-time | ||
|
簽署者轉寄的原因
|
forwarded_reason | string | ||
|
簽署者轉寄至電子郵件
|
forwarded_to_email | |||
|
親自簽署
|
in_person | boolean |
當與寄件者上的內嵌 URL 結合使用時,寄件者簽署後,他們將被重新導向到下一個 |
|
|
核取方塊值
|
checkbox_value | boolean | ||
|
日期值
|
date_value | date | ||
|
外部ID
|
external_id | string | ||
|
頁面索引
|
page_index | True | integer | |
|
預留位置 uuid
|
placeholder_uuid | string | ||
|
文字
|
text | string | ||
|
類型
|
type | string | ||
|
手語語言
|
language | string | ||
|
簽署者姓氏
|
last_name | string | ||
|
簽署者訊息
|
message | string | ||
|
簽署者需要簽署
|
needs_to_sign | boolean |
當使用者不需要簽署,但會收到已簽署文件和簽署記錄的副本時 |
|
|
僅限簽署者通知
|
notify_only | boolean |
傳送有關文件的通知,以及已簽署文件和簽署記錄的副本,但不需要他們採取任何動作,請參閱: 僅通知 |
|
|
簽署者順序
|
order | integer | ||
|
簽署者密碼
|
password | string |
要求簽署者在簽署文件之前輸入此密碼。 此欄位僅限寫入。 |
|
|
簽署者重新導向 URL
|
redirect_url | uri | ||
|
簽署者重新導向 URL 已拒絕
|
redirect_url_declined | uri | ||
|
簽署者已簽署
|
signed | boolean | ||
|
簽署者已登入
|
signed_on | date-time | ||
|
簽署者僅限核准使用戳記
|
use_stamp_for_approve_only | boolean |
當簽署者核准文件時,在文件上蓋上核准戳記 |
|
|
簽署人驗證銀行帳戶
|
verify_bank_account | string | ||
|
簽署者驗證電話號碼
|
verify_phone_number | string | ||
|
簽署者檢視
|
viewed | boolean | ||
|
球隊
|
subdomain | string | ||
|
主旨
|
subject | string |
SignRequest 電子郵件的主題 |
|
|
Template
|
template | uri | ||
|
簡訊驗證已鎖定
|
text_message_verification_locked | boolean |
如果為true,則需要進行簡訊驗證,簽署者才能看到文件 |
|
|
網址
|
url | uri | ||
|
烏伊德
|
uuid | string | ||
|
何人
|
who | string |
|
傳回
觸發程序
| 當文件狀態變更時 |
當 SignRequest 的文件狀態變更時觸發。 |
當文件狀態變更時
當 SignRequest 的文件狀態變更時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
已建立
|
created | date-time | ||
|
事件類型
|
event_type | True | string | |
|
名稱
|
name | string |
可選名稱,以輕鬆識別 Webhook 的用途 |
|
|
球隊
|
subdomain | string | ||
|
小組名稱
|
name | string | ||
|
團隊子網域
|
subdomain | uri | ||
|
團隊網址
|
url | uri | ||
|
網址
|
url | uri | ||
|
烏伊德
|
uuid | string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件
|
document | Document |
定義
文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用的文件 API
|
api_used | boolean |
指出文件是否是使用 API 建立的 |
|
attachments
|
attachments | array of DocumentAttachment | |
|
文件自動刪除後
|
auto_delete_after | date-time |
計算的日期和時間 |
|
文件自動刪除天數
|
auto_delete_days | integer |
完成的文件(已簽署/取消/拒絕)將自動刪除的天數 |
|
文件自動過期時間
|
auto_expire_after | date-time |
計算 |
|
文件自動到期天數
|
auto_expire_days | integer |
未完成文件自動過期的天數 |
|
文件事件回呼 URL
|
events_callback_url | uri |
接收此檔案事件 回呼 的URL |
|
文件外部 ID
|
external_id | string |
用於在外部系統中引用文件的 ID |
|
文件檔案
|
file | uri |
原始檔案的臨時 URL,五分鐘後到期 |
|
文件檔案為 Pdf
|
file_as_pdf | uri |
原始檔案的暫存 URL 格式為 PDF,五分鐘後到期 |
|
內容中的文件檔案
|
file_from_content | string |
Base64 編碼的文件內容 |
|
內容名稱中的文件檔案
|
file_from_content_name | string |
檔案名稱,包括副檔名。 使用 |
|
來自 sf 的檔案
|
file_from_sf | FileFromSf | |
|
來自 url 的文件檔案
|
file_from_url | uri |
SignRequest 要下載的文件的可公開存取 URL |
|
文件前端 ID
|
frontend_id | string |
與 SignRequest-js 用戶端 搭配使用的共用密碼,以授與使用者存取非文件小組成員之文件的存取權 |
|
文件名稱
|
name | string |
預設為檔案名稱,包括副檔名 |
|
文件 PDF
|
uri |
已簽署文件的臨時 URL 格式為 PDF,五分鐘後到期 |
|
|
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
預先填入簽署者輸入資料,請參閱 預先填入標籤 |
|
文件處理
|
processing | boolean |
指出是否正在處理文件的變更,且 PDF 可能已過期。 建議等到處理完成後再下載 PDF。 在處理完成之前,不會傳送 Webhook。 |
|
文件沙箱
|
sandbox | boolean |
指出文件是否是作為沙箱小組的一部分建立的 |
|
檔案安全性雜湊
|
security_hash | string |
PDF 內容的 SHA256 雜湊 |
|
簽署日誌 pdf
|
signing_log.pdf | uri |
簽署記錄的臨時 URL,五分鐘後到期 |
|
簽署記錄安全雜湊
|
signing_log.security_hash | string |
PDF 內容的 SHA256 雜湊 |
|
Signrequest 停用附件
|
signrequest.disable_attachments | boolean |
停用上傳/新增附件 |
|
Signrequest 停用區塊鏈證明
|
signrequest.disable_blockchain_proof | boolean |
停用在區塊鏈整合中儲存時間戳記證明雜湊。 |
|
簽署要求停用日期
|
signrequest.disable_date | boolean |
停用新增日期 |
|
Signrequest 停用電子郵件
|
signrequest.disable_emails | boolean |
停用所有 SignRequest 狀態電子郵件,以及包含已簽署文件的電子郵件 |
|
Signrequest 停用文字
|
signrequest.disable_text | boolean |
停用新增文字 |
|
Signrequest 停用文字簽章
|
signrequest.disable_text_signatures | boolean |
停用輸入產生的簽名 (文字) |
|
Signrequest 停用上傳簽章
|
signrequest.disable_upload_signatures | boolean |
停用使用已上傳的簽名(影像) |
|
Signrequest From Email
|
signrequest.from_email |
傳送 SignRequest 的使用者電子郵件 (必須是經過驗證的電子郵件) |
|
|
Signrequest From Email Name
|
signrequest.from_email_name | string |
要在電子郵件標題中使用的 |
|
Signrequest 正在準備中
|
signrequest.is_being_prepared | boolean |
讓 SignRequest 的寄件者在傳送要求之前準備文件,請參閱: 使用 Web 介面進行準備 |
|
Signrequest 訊息
|
signrequest.message | string |
要包含在 SignRequest 電子郵件中的訊息,可能包含下列 html 標籤: |
|
Signrequest 準備 URL
|
signrequest.prepare_url | uri | |
|
Signrequest 重新導向 URL
|
signrequest.redirect_url | uri |
簽署文件時,SignRequest 將重新導向至 URL |
|
Signrequest 重新導向 URL 已拒絕
|
signrequest.redirect_url_declined | uri |
當文件被拒絕時,SignRequest 將重新導向至 URL |
|
required_attachments
|
signrequest.required_attachments | array of RequiredAttachment | |
|
Signrequest 發送提醒
|
signrequest.send_reminders | boolean |
自動提醒簽署者簽署文件,請參閱: 自動提醒 |
|
簽署者
|
signrequest.signers | array of Signer | |
|
簽署要求主旨
|
signrequest.subject | string |
SignRequest 電子郵件的主題 |
|
Signrequest 簡訊驗證已鎖定
|
signrequest.text_message_verification_locked | boolean |
如果為true,則需要進行簡訊驗證,簽署者才能看到文件 |
|
簽名請求 Uuid
|
signrequest.uuid | string | |
|
簽署請求誰
|
signrequest.who | string |
|
|
文件狀態
|
status | string |
|
|
小組名稱
|
team.name | string | |
|
團隊子網域
|
team.subdomain | uri | |
|
團隊網址
|
team.url | uri | |
|
文件範本
|
template | uri | |
|
文件網址
|
url | uri | |
|
User
|
user | User | |
|
文件 Uuid
|
uuid | string |
文件附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件附件文件
|
document | uri | |
|
文件附件檔
|
file | uri |
文件附件的臨時 URL,五分鐘後到期 |
|
內容中的文件附件檔案
|
file_from_content | string |
Base64 編碼的文件內容 |
|
內容名稱中的文件附件檔案
|
file_from_content_name | string |
檔案名稱,包括副檔名。 使用 |
|
來自 url 的文件附件文件
|
file_from_url | uri |
SignRequest 要下載的文件的可公開存取 URL |
|
文件附件名稱
|
name | string |
預設為檔案名稱,包括副檔名 |
|
文件附件 URL
|
url | uri | |
|
文件附件 Uuid
|
uuid | string |
檔案來自 Sf
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物件識別碼
|
object_id | string | |
|
物件類型
|
object_type | string | |
|
烏德
|
uid | string |
InlinePrefill標籤
預先填入簽署者輸入資料,請參閱 預先填入標籤
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
預先填入標籤核取方塊值
|
checkbox_value | boolean | |
|
預先填入標籤日期值
|
date_value | date | |
|
預先填入標籤外部ID
|
external_id | string | |
|
預先填入標籤文字
|
text | string |
必要附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
必要的附件名稱
|
name | string | |
|
必要的附件 Uuid
|
uuid | string |
SignRequestQuickCreate
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自動刪除天數
|
auto_delete_days | integer |
完成的文件(已簽署/取消/拒絕)將自動刪除的天數 |
|
自動到期天數
|
auto_expire_days | integer |
未完成文件自動過期的天數 |
|
停用附件
|
disable_attachments | boolean |
停用上傳/新增附件 |
|
禁用區塊鏈證明
|
disable_blockchain_proof | boolean |
停用在區塊鏈整合中儲存時間戳記證明雜湊。 |
|
停用日期
|
disable_date | boolean |
停用新增日期 |
|
停用電子郵件
|
disable_emails | boolean |
停用所有 SignRequest 狀態電子郵件,以及包含已簽署文件的電子郵件 |
|
停用文字
|
disable_text | boolean |
停用新增文字 |
|
停用文字簽名
|
disable_text_signatures | boolean |
停用輸入產生的簽名 (文字) |
|
停用上傳簽名
|
disable_upload_signatures | boolean |
停用使用已上傳的簽名(影像) |
|
文件
|
document | uri | |
|
事件回呼網址
|
events_callback_url | uri |
接收此檔案事件 回呼 的URL |
|
外部ID
|
external_id | string |
用於在外部系統中引用文件的 ID |
|
檔案
|
file | uri |
原始檔案的臨時 URL,五分鐘後到期 |
|
從內容檔案
|
file_from_content | byte |
Base64 編碼的文件內容 |
|
內容名稱中的檔案
|
file_from_content_name | string |
檔案名稱,包括副檔名。 使用 |
|
從 url 檔案
|
file_from_url | uri |
SignRequest 要下載的文件的可公開存取 URL |
|
來自電子郵件
|
from_email |
傳送 SignRequest 的使用者電子郵件 (必須是經過驗證的電子郵件) |
|
|
從電子郵件名稱
|
from_email_name | string |
要在電子郵件標題中使用的 |
|
前端 ID
|
frontend_id | string |
與 SignRequest-js 用戶端 搭配使用的共用密碼,以授與使用者存取非文件小組成員之文件的存取權 |
|
正在準備中
|
is_being_prepared | boolean |
讓 SignRequest 的寄件者在傳送要求之前準備文件,請參閱: 使用 Web 介面進行準備 |
|
Message
|
message | string |
要包含在 SignRequest 電子郵件中的訊息,可能包含下列 html 標籤: |
|
名稱
|
name | string |
預設為檔案名稱,包括副檔名 |
|
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
預先填入簽署者輸入資料,請參閱 預先填入標籤 |
|
準備網址
|
prepare_url | uri | |
|
重新導向網址
|
redirect_url | uri |
簽署文件時,SignRequest 將重新導向至 URL |
|
重新導向網址被拒絕
|
redirect_url_declined | uri |
當文件被拒絕時,SignRequest 將重新導向至 URL |
|
required_attachments
|
required_attachments | array of RequiredAttachment |
簽署人必須上傳的附件 |
|
傳送提醒
|
send_reminders | boolean |
自動提醒簽署者簽署文件,請參閱: 自動提醒 |
|
簽署者
|
signers | array of Signer | |
|
球隊
|
subdomain | string | |
|
主旨
|
subject | string |
SignRequest 電子郵件的主題 |
|
Template
|
template | uri | |
|
簡訊驗證已鎖定
|
text_message_verification_locked | boolean |
如果為true,則需要進行簡訊驗證,簽署者才能看到文件 |
|
網址
|
url | uri | |
|
烏伊德
|
uuid | string | |
|
何人
|
who | string |
|
簽署者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件後的簽署者
|
after_document | uri | |
|
僅限簽署者核准
|
approve_only | boolean |
要求使用者核准文件 (不新增簽名),請參閱: 僅核准 |
|
attachments
|
attachments | array of SignerAttachment | |
|
簽署者拒絕
|
declined | boolean | |
|
簽名者拒絕了
|
declined_on | date-time | |
|
簽署者顯示名稱
|
display_name | string | |
|
簽署者已下載
|
downloaded | boolean | |
|
簽署者電子郵件
|
|||
|
已檢視的簽署者電子郵件
|
email_viewed | boolean | |
|
簽署者已傳送電子郵件
|
emailed | boolean | |
|
簽署者內嵌網址
|
embed_url | uri | |
|
簽署者內嵌 URL 使用者 ID
|
embed_url_user_id | string | |
|
簽署人名字
|
first_name | string | |
|
手語強制語言
|
force_language | boolean | |
|
簽署人轉寄
|
forwarded | boolean | |
|
簽署人轉寄
|
forwarded_on | date-time | |
|
簽署者轉寄的原因
|
forwarded_reason | string | |
|
簽署者轉寄至電子郵件
|
forwarded_to_email | ||
|
親自簽署
|
in_person | boolean |
當與寄件者上的內嵌 URL 結合使用時,寄件者簽署後,他們將被重新導向到下一個 |
|
輸入
|
inputs | array of SignerInputs | |
|
手語語言
|
language | string | |
|
簽署者姓氏
|
last_name | string | |
|
簽署者訊息
|
message | string | |
|
簽署者需要簽署
|
needs_to_sign | boolean |
當使用者不需要簽署,但會收到已簽署文件和簽署記錄的副本時 |
|
僅限簽署者通知
|
notify_only | boolean |
傳送有關文件的通知,以及已簽署文件和簽署記錄的副本,但不需要他們採取任何動作,請參閱: 僅通知 |
|
簽署者順序
|
order | integer | |
|
簽署者密碼
|
password | string |
要求簽署者在簽署文件之前輸入此密碼。 此欄位僅限寫入。 |
|
簽署者重新導向 URL
|
redirect_url | uri | |
|
簽署者重新導向 URL 已拒絕
|
redirect_url_declined | uri | |
|
簽署者已簽署
|
signed | boolean | |
|
簽署者已登入
|
signed_on | date-time | |
|
簽署者僅限核准使用戳記
|
use_stamp_for_approve_only | boolean |
當簽署者核准文件時,在文件上蓋上核准戳記 |
|
簽署人驗證銀行帳戶
|
verify_bank_account | string | |
|
簽署者驗證電話號碼
|
verify_phone_number | string | |
|
簽署者檢視
|
viewed | boolean |
簽署者附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案
|
file | uri | |
|
for_attachment
|
for_attachment | RequiredAttachment | |
|
名稱
|
name | string |
預設為檔案名稱 |
|
烏伊德
|
uuid | string |
簽署者輸入
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
核取方塊值
|
checkbox_value | boolean | |
|
日期值
|
date_value | date | |
|
外部ID
|
external_id | string | |
|
頁面索引
|
page_index | integer | |
|
預留位置 uuid
|
placeholder_uuid | string | |
|
文字
|
text | string | |
|
類型
|
type | string |
User
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者顯示名稱
|
display_name | string | |
|
使用者電子郵件地址
|
|||
|
使用者名字
|
first_name | string | |
|
使用者姓氏
|
last_name | string |