共用方式為

Zoho 標誌

Zoho's Sign 是一款完整的數字簽名應用程序，可幫助以完全的安全性和可靠性對商業文檔進行數字簽名

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

服務 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）
連絡人​​
名稱 Zoho Sign API 支援
URL https://www.zoho.com/sign/contact.html
Email support@zohosign.com
連接器中繼資料
Publisher Zoho公司
網站 https://www.zoho.com/sign/
隱私策略 https://www.zoho.com/privacy.html
類別 內容和文件;生產力

使用 Zoho 的電子簽名軟件以完全安全和可靠的方式在線對商業文檔進行數字簽名。 透過簡單的電子簽署文件工作流程自動化您的交易。 適用於商業簽署者的完整數字簽名應用程序。

先決條件

若要使用此聯結器，您必須在 Zoho-Sign 平台上支付 Zoho-Sign 帳戶費用。 詳情請參閱 https://www.zoho.com/sign/pricing-api.html 您也可以在這裡 https://zoho.com/sign 設定帳戶 ##How 以取得憑證 Zoho-Sign API 使用 OAuth 2 進行驗證。 因此，一旦設定了帳戶，就不需要額外的步驟。

所有 Zoho Sign API 都需要此必要標頭：授權 - 驗證要求標頭。

對於代幣生成，請參閱： https://www.zoho.com/sign/api/#getting-started

開始使用連接器

Zoho Sign 連接器為用戶提供了直接執行文檔管理、模板管理和其他操作的選項，而無需訪問 Zoho Sign 的 Web 界面

在文件管理器下，使用這些連接器，用戶可以創建文檔、更新文檔、發送文檔以供簽名，並獲取與您的帳戶相關的所有文檔的列表。

同樣地，對於其他操作，請參閱以下鏈接中的“支持的操作是什麼？

https://www.zoho.com/sign/api/#introduction

這些連接器將幫助您自動化使用，從文檔或模板發送到狀態跟踪等。

常見錯誤和補救措施

如果發生錯誤，請使用正確的錯誤代碼及其原因進行調試。

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱 類型 Description 為必填項目
選取區域。 字串 選取網域。 對

節流限制

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

動作

下載文件

下載特定信封
下載檔案

下載特定文件或檔案
下載結業證書

下載特定信封的完成憑證
傳送簽名要求

將上傳的文件發送出去以供簽署
刪除文件

刪除特定文件
取得已完成請求的資料

顯示已簽署信封的詳細資料
取得文件

顯示特定信封的詳細資料
取得特定範本詳細資料

顯示特定文件範本的詳細資料
取得範本清單

顯示所有已建立文件範本的清單
叫用 API

叫用 API
建立要簽署的文件

透過上傳檔案來建立要簽署的文件的動作。
收件人提醒

傳送提醒給特定文件的收件者。
更新已建立請求的屬性

更新已建立請求的屬性
調用特定文件

調用特定文件

下載文件

作業識別碼：
download-document

下載特定信封

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號

傳回

response
file

下載檔案

作業識別碼：
download-file

下載特定文件或檔案

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號
文件 ID
 document_id True integer

文件 ID

傳回

response
file

下載結業證書

作業識別碼：
download-completion-certificate

下載特定信封的完成憑證

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號

傳回

response
file

傳送簽名要求

作業識別碼：
SendSignRequest

將上傳的文件發送出去以供簽署

參數

名稱 機碼 必要 類型 Description
請求編號
 RequestId True string

請求編號

傳回

名稱 路徑 類型 Description
字碼
 code integer

字碼
訊息
 message string

訊息
狀態
 status string

狀態

刪除文件

作業識別碼：
delete-document

刪除特定文件

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號

取得已完成請求的資料

作業識別碼：
get-form-data

顯示已簽署信封的詳細資料

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求標識符

傳回

名稱 路徑 類型 Description
字碼
 code integer

字碼
request_name
 document_form_data.request_name string

請求名稱
zsdocumentid
 document_form_data.zsdocumentid string

Zoho Sign 文件ID
行為
 document_form_data.actions array of object

行為
signed_time
 document_form_data.actions.signed_time string

簽名時間
action_type
 document_form_data.actions.action_type string

動作類型
recipient_email
 document_form_data.actions.recipient_email string

收件者電子郵件
recipient_name
 document_form_data.actions.recipient_name string

收件者名稱
fields
 document_form_data.actions.fields array of object

fields
field_label
 document_form_data.actions.fields.field_label string

欄位標籤
field_value
 document_form_data.actions.fields.field_value string

欄位值
field_name
 document_form_data.actions.fields.field_name string

欄位名稱
狀態
 status string

狀態

取得文件

作業識別碼：
get-document

顯示特定信封的詳細資料

參數

名稱 機碼 必要 類型 Description
請求編號
 RequestId True integer

請求編號

傳回

名稱 路徑 類型 Description
字碼
 code integer

字碼
request_status
 requests.request_status string

請求狀態
附註
 requests.notes string

註釋
attachments
 requests.attachments array of

Attachments
reminder_period
 requests.reminder_period integer

提醒期
owner_id
 requests.owner_id string

負責人識別碼
描述
 requests.description string

請求描述
request_name
 requests.request_name string

請求名稱
modified_time
 requests.modified_time integer

修改時間
action_time
 requests.action_time integer

行動時間
is_deleted
 requests.is_deleted boolean

刪除請求的狀態
expiration_days
 requests.expiration_days integer

到期日
is_sequential
 requests.is_sequential boolean

循序狀態
sign_submitted_time
 requests.sign_submitted_time integer

簽名提交時間
owner_first_name
 requests.owner_first_name string

業主的名字
sign_percentage
 requests.sign_percentage float

符號百分比
expire_by
 requests.expire_by integer

文件到期日
is_expiring
 requests.is_expiring boolean

文件到期日期
owner_email
 requests.owner_email string

擁有者的電子郵件 ID
created_time
 requests.created_time integer

建立文件的時間
email_reminders
 requests.email_reminders boolean

透過電子郵件傳送提醒
document_ids
 requests.document_ids array of object

文件標識碼
image_string
 requests.document_ids.image_string string

影像字串
document_name
 requests.document_ids.document_name string

文件名稱
pages
 requests.document_ids.pages array of object

pages
image_string
 requests.document_ids.pages.image_string string

影像字串
頁面
 requests.document_ids.pages.page integer

頁面
is_thumbnail
 requests.document_ids.pages.is_thumbnail boolean

縮圖狀態
document_size
 requests.document_ids.document_size integer

文件大小
document_order
 requests.document_ids.document_order string

文件順序
total_pages
 requests.document_ids.total_pages integer

文件中的總頁數
document_id
 requests.document_ids.document_id string

文件標識碼
self_sign
 requests.self_sign boolean

自我簽署狀態
sign_id
 requests.sign_id string

簽署標識碼
folder_name
 requests.folder_name string

資料夾名稱
in_process
 requests.in_process boolean

進行中狀態
有效
 requests.validity integer

文件的有效性
request_type_name
 requests.request_type_name string

要求類型名稱
folder_id
 requests.folder_id string

資料夾識別碼
請求ID
 requests.request_id string

請求標識碼
request_type_id
 requests.request_type_id string

要求類型識別碼
owner_last_name
 requests.owner_last_name string

所有者的姓氏
行為
 requests.actions array of object

行為
verify_recipient
 requests.actions.verify_recipient boolean

驗證收件者郵件 ID
action_type
 requests.actions.action_type string

動作類型
private_notes
 requests.actions.private_notes string

私人筆記
recipient_email
 requests.actions.recipient_email string

收件者的電子郵件 ID
send_completed_document
 requests.actions.send_completed_document boolean

傳送已完成文件的狀態
verification_type
 requests.actions.verification_type string

驗證類型
allow_signing
 requests.actions.allow_signing boolean

允許簽署狀態
recipient_phonenumber
 requests.actions.recipient_phonenumber string

收件者電話號碼
is_bulk
 requests.actions.is_bulk boolean

大量狀態
action_id
 requests.actions.action_id string

動作識別碼
is_revoked
 requests.actions.is_revoked boolean

撤銷狀態
is_embedded
 requests.actions.is_embedded boolean

內嵌狀態
signing_order
 requests.actions.signing_order integer

簽署順序
recipient_name
 requests.actions.recipient_name string

收件者名稱
action_status
 requests.actions.action_status string

動作狀態
recipient_countrycode
 requests.actions.recipient_countrycode string

收件者國家/地區代碼
是主機
 requests.actions.ishost boolean

主機使用狀態
語言
 requests.actions.language string

語言
in_person_name
 requests.actions.in_person_name string

以個人姓名
in_person_email
 requests.actions.in_person_email string

親自發送電子郵件
verification_code
 requests.actions.verification_code string

驗證碼
attachment_size
 requests.attachment_size integer

附件的大小
訊息
 message string

訊息
狀態
 status string

狀態

取得特定範本詳細資料

作業識別碼：
get-template-details

顯示特定文件範本的詳細資料

參數

名稱 機碼 必要 類型 Description
模板列表
 template_id True string

模板列表

取得範本清單

作業識別碼：
GetTemplates

顯示所有已建立文件範本的清單

傳回

名稱 路徑 類型 Description
templates
 templates array of object
template_id
 templates.template_id string
template_name
 templates.template_name string

範本名稱

叫用 API

作業識別碼：
InvokeAPI

叫用 API

參數

名稱 機碼 必要 類型 Description
URL 路徑
 url True string

提供網址路徑
方法
 method True string

選擇要使用的 API 方法

傳回

response
object

建立要簽署的文件

作業識別碼：
Create-Document

透過上傳檔案來建立要簽署的文件的動作。

參數

名稱 機碼 必要 類型 Description
建立文件
 file True file

建立文件

傳回

名稱 路徑 類型 Description
字碼
 code integer

字碼
request_status
 requests.request_status string

請求狀態
owner_email
 requests.owner_email string

擁有者電子郵件
created_time
 requests.created_time integer

創建時間
document_ids
 requests.document_ids array of object

document_ids
image_string
 requests.document_ids.image_string string

影像字串
document_name
 requests.document_ids.document_name string

文件名稱
pages
 requests.document_ids.pages array of object

pages
image_string
 requests.document_ids.pages.image_string string

影像字串
頁面
 requests.document_ids.pages.page integer

頁面
is_thumbnail
 requests.document_ids.pages.is_thumbnail boolean

is_thumbnail
document_size
 requests.document_ids.document_size integer

文件大小
document_order
 requests.document_ids.document_order string

文件順序
total_pages
 requests.document_ids.total_pages integer

總頁數
document_id
 requests.document_ids.document_id string

文件 ID
附註
 requests.notes string

附註
self_sign
 requests.self_sign boolean

自我簽名
owner_id
 requests.owner_id string

擁有者 ID
描述
 requests.description string

Description
folder_name
 requests.folder_name string

資料夾名稱
request_name
 requests.request_name string

請求名稱
modified_time
 requests.modified_time integer

修改時間
is_deleted
 requests.is_deleted boolean

刪除狀態
expiration_days
 requests.expiration_days integer

到期日
in_process
 requests.in_process boolean

進行中
is_sequential
 requests.is_sequential boolean

循序狀態
request_type_name
 requests.request_type_name string

要求類型名稱
owner_first_name
 requests.owner_first_name string

擁有者名字
folder_id
 requests.folder_id string

資料夾識別碼
請求ID
 requests.request_id string

請求標識符
request_type_id
 requests.request_type_id string

要求類型識別碼
owner_last_name
 requests.owner_last_name string

所有者姓氏
sign_percentage
 requests.sign_percentage integer

符號百分比
訊息
 message string

Message
狀態
 status string

狀態

收件人提醒

作業識別碼：
remind-document-recipients

傳送提醒給特定文件的收件者。

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號

更新已建立請求的屬性

作業識別碼：
UpdateDocument

更新已建立請求的屬性

參數

名稱 機碼 必要 類型 Description
請求編號
 RequestId True string

請求編號
文件類型
 request_type_id string

request_type_id
文件名稱
 request_name True string

文件名稱（請求）
收件者名稱
 recipient_name string

收件者名稱
收件者電子郵件
 recipient_email string

收件者電子郵件
電話號碼
 recipient_phonenumber string

SMS 驗證模式的收件者電話號碼。
國碼 (地區碼)
 recipient_countrycode string

用於短信身份驗證模式的收件人電話號碼的國家/地區代碼。
動作類型
 action_type string

選取收件者是簽署者、檢視者、核准者或 inpersonSigner。
私人筆記
 private_notes string

私人筆記
簽署訂單
 signing_order integer

簽署順序
收件者需要驗證
 verify_recipient boolean

收件者是否需要透過其中一種驗證模式進行驗證。
驗證傳遞類型
 verification_type string

驗證類型
驗證碼
 verification_code string

離線驗證模式的 6 位驗證碼。
完成所需天數
 expiration_days integer

文件到期的剩餘天數。
依序發送
 is_sequential boolean

允許收件者依指定的順序登入。
自動提醒
 email_reminders boolean

啟用定期提醒，讓收件者簽署文件。
每 - （天） 發送一次剩餘部分
 reminder_period integer

指定將簽署提醒傳送給收件者的時間間隔。
資料夾
 folder_id string

資料夾唯一ID
註釋
 notes html

所有收件人的註釋。

傳回

名稱 路徑 類型 Description
字碼
 code integer

字碼
訊息
 message string

訊息
狀態
 status string

狀態

調用特定文件

作業識別碼：
recall-document

調用特定文件

參數

名稱 機碼 必要 類型 Description
請求編號
 request_id True integer

請求編號

觸發程序

Zoho Sign 觸發器

註冊特定事件的回呼

Zoho Sign 觸發器

作業識別碼：
zoho-sign-triggers

註冊特定事件的回呼

參數

名稱 機碼 必要 類型 Description
行動
 webhook_actions True string

Webhook 動作

傳回

名稱 路徑 類型 Description
request_status
 requests.request_status string

請求狀態
附註
 requests.notes string

附註
reminder_period
 requests.reminder_period integer

提醒期
owner_id
 requests.owner_id string

擁有者 ID
描述
 requests.description string

描述
request_name
 requests.request_name string

要求名稱
modified_time
 requests.modified_time integer

修改時間
action_time
 requests.action_time integer

行動時間
is_deleted
 requests.is_deleted boolean

已刪除狀態
expiration_days
 requests.expiration_days integer

到期日
is_sequential
 requests.is_sequential boolean

循序操作的狀態
sign_submitted_time
 requests.sign_submitted_time integer

簽名提交時間
owner_first_name
 requests.owner_first_name string

名字的所有者
sign_percentage
 requests.sign_percentage integer

符號百分比
expire_by
 requests.expire_by integer

到期日期
owner_email
 requests.owner_email string

擁有者電子郵件
created_time
 requests.created_time integer

創建時間
email_reminders
 requests.email_reminders boolean

電子郵件提醒
document_ids
 requests.document_ids array of object

文件識別碼清單
document_name
 requests.document_ids.document_name string

輸入文件名稱
document_size
 requests.document_ids.document_size integer

文件大小
document_order
 requests.document_ids.document_order string

文件順序
total_pages
 requests.document_ids.total_pages integer

文件中的總頁數
document_id
 requests.document_ids.document_id string

文件 ID
self_sign
 requests.self_sign boolean

自我簽名狀態
in_process
 requests.in_process boolean

進行中狀態
有效
 requests.validity integer

有效期
request_type_name
 requests.request_type_name string

要求類型名稱
decline_reason
 requests.decline_reason string

拒絕原因
請求ID
 requests.request_id string

請求標識符
request_type_id
 requests.request_type_id string

要求類型識別碼
owner_last_name
 requests.owner_last_name string

擁有者姓氏
行為
 requests.actions array of object

行為
verify_recipient
 requests.actions.verify_recipient boolean

驗證收件者
action_type
 requests.actions.action_type string

動作類型
private_notes
 requests.actions.private_notes string

私人筆記
recipient_email
 requests.actions.recipient_email string

收件者電子郵件
allow_signing
 requests.actions.allow_signing boolean

簽署狀態
recipient_phonenumber
 requests.actions.recipient_phonenumber string

收件者電話號碼
is_bulk
 requests.actions.is_bulk boolean

大量動作的狀態
action_id
 requests.actions.action_id string

動作識別碼
is_revoked
 requests.actions.is_revoked boolean

撤銷狀態
is_embedded
 requests.actions.is_embedded boolean

內嵌狀態
signing_order
 requests.actions.signing_order integer

簽署順序
recipient_name
 requests.actions.recipient_name string

收件者名稱
action_status
 requests.actions.action_status string

動作狀態
recipient_countrycode
 requests.actions.recipient_countrycode string

收件人的國家/地區代碼
performed_by_email
 notifications.performed_by_email string

通過電子郵件執行
performed_at
 notifications.performed_at integer

執行於
reason
 notifications.reason string

原因
活動
 notifications.activity string

Activity
operation_type
 notifications.operation_type string

作業類型
action_id
 notifications.action_id string

動作識別碼
performed_by_name
 notifications.performed_by_name string

按名稱執行
signing_order
 notifications.signing_order integer

簽署順序
ip_address
 notifications.ip_address string

IP位址

定義

檔案

這是基本資料類型「檔案」。

物件

這是類型 'object'。