Nitro Sign 企業驗證 （預覽版）
Nitro Sign Enterprise Verified 是著名的數位簽章解決方案，提供大量簽章方法並符合最嚴格的（國際）國家法規。 NSEV 允許您將任何基於紙質的流程轉變為具有無與倫比的用戶體驗的端到端數字流程。 完全按照您想要的方式簡化簽名流程，並直接從您最喜歡的業務應用程序發送、簽名和跟踪所有類型的文檔。
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | 硝基支持 |
| URL | https://www.gonitro.com/support |
| service@gonitro.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Nitro Software 比利時內華達州 |
| 網站 | https://www.gonitro.com |
| 隱私策略 | https://www.gonitro.com/legal/privacy-policy |
| 類別 | IT運營;生產力 |
Nitro Sign 企業驗證連接器
智慧文件解決方案專家 Nitro Software 已提供適用於 Power Automate 的 Nitro Sign 企業驗證連接器可供使用。 該連接器允許公司直接從他們最喜歡的 Microsoft 365 應用程序（從 Microsoft Teams 到 Word、SharePoint、Dynamics、OneDrive 等）轉發需要數字簽名的文檔。 Nitro Sign 企業驗證 - 以前稱為 Nitro Sign Premium 和 Connective eSignatures。
先決條件
若要開始使用連接器，需要現有的 Nitro Sign Enterprise Verified 訂閱。 請聯絡您在 Nitro Software 的聯絡人，或前往我們網站上的 說明和支援頁面 以取得憑證。
文件資料
本頁將進一步詳細說明可用的不同動作，並提供有關這些動作實施的不同方式的見解。
請隨時查看我們的 文檔網站 以獲取更多信息，或通過我們的 幫助和支持頁面 或支持郵箱聯繫支持團隊： mailto：service@gonitro.com。 API 文件也以 Postman 格式提供。
詞 彙表 可用來解釋本文檔中使用的不同術語
支援的作業
Nitro Sign Enterprise Verified 連接器以 Nitro Sign Enterprise Verified 的 API v4 為基礎。 API 是 REST API，可讓外部應用程式與本檔案中列出的功能整合，並使用這些功能來建立和管理簽署流程。
可用的動作可以分組到不同的群組中
| 行動小組 | 可用動作 |
|---|---|
| Packages | 取得所有套件 |
| 按 ID 獲取包裹 | |
| 取得套件狀態 | |
| 建立新套件 （標準或即時） | |
| 依 ID 刪除套件 | |
| 更新套件的狀態 | |
| 取得套件的到期日 | |
| 更新套件的到期日 | |
| 略過簽署者 | |
| 傳送提醒 | |
| 下載套件 | |
| 下載封裝的稽核記錄 | |
| Documents | 將文件新增至套件 |
| 從套件下載已簽署的文件 | |
| 利害關係人 | 依識別碼刪除利害關係人 |
| 取得套件的所有利害關係人 | |
| 將利害關係人新增至套件 | |
| 流程 | 取得套件的所有程序步驟 |
| 流程 | 在套件的程序中新增步驟 |
| 流程 | 覆寫封裝的處理程序步驟 |
| 流程 | 取得程序步驟的所有動作 |
| 流程 | 刪除程序步驟及其所有動作者 |
| 流程 | 將動作項目新增至程序步驟 |
| 流程 | 取得目前流程步驟中的所有動作 |
| Other | 在應用程序中啟用所有語言 |
| 取得可指派給套件的所有佈景主題 | |
| 取得可指派套件的所有文件群組 | |
| 取得所有已設定的簽署方法 |
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| Nitro Sign 主機 | 字串 | 主機和 Nitro Sign 環境的路徑，例如 contoso.sign.gonitro.com/esig | 對 |
| API 使用者名稱 | securestring | API 使用者名稱以存取 API | 對 |
| API 密碼 | securestring | 存取 API 的 API 密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載套件 |
用於將某個包中的所有文檔下載為 Zip 文件。 |
| 下載套件的稽核追蹤 |
下載有關套件存留期的已簽署稽核追蹤。 |
| 依 ID 刪除套件 |
依套件的 ID 刪除套件。 |
| 依識別碼刪除利害關係人 |
依專案關係人的 ID 刪除專案關係人。 |
| 傳回目前設定的所有簽署方法 |
傳回目前設定的所有簽署方法 |
| 刪除程序步驟及其所有動作者 |
刪除流程步驟及其所有動作者。 |
| 取得套件狀態 |
擷取套件的目前狀態。 |
| 取得套件的到期日 |
擷取套件的到期日 |
| 取得套件的所有利害關係人 |
擷取套件的利害關係人 |
| 取得所有套件 |
取得所有套件，這些套件會依 creationDate 排序 |
| 取得所有流程步驟 |
取得必須在套件上執行的所有動作。 |
| 取得目前流程步驟中的所有動作 |
取得目前可平行完成的動作集。 |
| 取得程序步驟的所有動作 |
從程序中取得一組可平行完成的特定動作。 |
| 在套件的程序中新增步驟 |
將一組動作新增至套件的程序。 |
| 將利害關係人新增至套件 |
將利害關係人新增至套件 |
| 將動作項目新增至程序步驟 |
將動作者新增至程序步驟。 |
| 將文件新增至套件 |
將文件新增至現有的封裝。 |
| 建立新套件 （標準或即時） |
建立新套件。 依預設，封裝會建立為草稿。 若要建立立即準備好簽署的即時套件，請將屬性設定
便條： 端點 |
| 從套件下載文件 |
從套件下載已簽署的文件。 每個文件都將以 PDF 或 XML 檔案的形式下載。 |
| 按 ID 獲取包裹 |
依套件的 ID 擷取套件。 |
| 擷取可指派套件的所有文件群組 |
擷取可指派封裝的所有文件群組 |
| 擷取可指派給套件的所有佈景主題 |
擷取可指派給封裝的所有佈景主題。 可以提供 MaxQuantity 和 continuationToken 來分頁結果 |
| 擷取應用程式中啟用的所有語言 |
擷取應用程式中啟用的所有語言 |
| 更新套件狀態 |
更新套件的狀態。 |
| 更新套件的到期日 |
更新套件的到期日 |
| 略過簽署者 |
此呼叫會略過所有尚未完成的簽署者，並將其狀態設定為「已跳過」，導致完整套件標示為「已完成」。 |
| 發送包裹提醒 |
公司原則可能要求在指定的時間範圍內處理文件。 觸發「發送提醒」呼叫將查找所有尚未簽名的人，並向他們發送額外的通知作為提醒。 |
| 覆寫套件的處理程序步驟 |
使用 2D 陣列覆寫套件中的所有 actor，其中每組 actor 都是可以平行執行的動作。 |
下載套件
用於將某個包中的所有文檔下載為 Zip 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
- response
- binary
下載套件的稽核追蹤
下載有關套件存留期的已簽署稽核追蹤。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
語言 2 個字母的 ISO 代碼 （ISO 639-1）
|
culture | True | string |
語言 2 個字母的 ISO 代碼 （ISO 639-1） |
傳回
- response
- binary
依 ID 刪除套件
依套件的 ID 刪除套件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
依識別碼刪除利害關係人
依專案關係人的 ID 刪除專案關係人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
利害關係人的唯一識別碼
|
stakeholderId | True | string |
利害關係人的唯一識別碼 |
傳回目前設定的所有簽署方法
傳回目前設定的所有簽署方法
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
僅傳回作用中/非作用中的簽署方法
|
isActive | boolean |
僅傳回作用中/非作用中的簽署方法 |
傳回
- response
- array of ConfiguredSigningMethod
刪除程序步驟及其所有動作者
刪除流程步驟及其所有動作者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
處理步驟的索引
|
stepIndex | True | integer |
處理步驟的索引 |
取得套件狀態
擷取套件的目前狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
取得套件的到期日
擷取套件的到期日
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
ISO 8601 格式的日期時間值
- response
- Common.DateTime
取得套件的所有利害關係人
擷取套件的利害關係人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
- response
- array of Response.Stakeholder
取得所有套件
取得所有套件，這些套件會依 creationDate 排序
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要擷取的頁碼
|
pageNumber | integer |
要擷取的頁碼 |
|
|
每頁項目數
|
pageSize | integer |
每頁項目數 |
|
|
在此日期之前建立的退貨包裹
|
createdBefore | date-time |
在此日期之前建立的退貨包裹 |
|
|
在此日期之後建立的退貨包裹
|
createdAfter | date-time |
在此日期之後建立的退貨包裹 |
|
|
要篩選的套件狀態
|
status | string |
要篩選的套件狀態 |
|
|
用於過濾套件的文件群組程式碼
|
documentGroupCode | string |
用於過濾套件的文件群組程式碼 |
|
|
要篩選的套件發起者的電子郵件
|
initiator |
要篩選的套件發起者的電子郵件 |
||
|
要篩選的套件名稱
|
packageName | string |
要篩選的套件名稱 |
|
|
篩選套件的外部參考
|
externalReference | string |
篩選套件的外部參考 |
|
|
指定結果的排序方式，預設值為遞減
|
sort | string |
指定結果的排序方式，預設值為遞減 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
頁碼
|
PageNumber | integer |
目前頁碼 |
|
PageSize
|
PageSize | integer |
每頁項目數 |
|
總頁數
|
TotalPages | integer |
總頁數 |
|
項目總計
|
TotalItems | integer |
項目總數 |
|
物品
|
Items | array of Response.Package.Get |
取得所有流程步驟
取得必須在套件上執行的所有動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of array | ||
|
items
|
array of Response.Actor |
處理步驟中的一組動作者。 |
取得目前流程步驟中的所有動作
取得目前可平行完成的動作集。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
Items | array of Response.Actor |
取得程序步驟的所有動作
從程序中取得一組可平行完成的特定動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
處理步驟的索引
|
stepIndex | True | integer |
處理步驟的索引 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
Items | array of Response.Actor |
在套件的程序中新增步驟
將一組動作新增至套件的程序。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
類型
|
Type | True | string |
必須在套件上執行的動作類型 |
|
利害關係人標識碼
|
StakeholderId | True | string |
套件中利害關係人的識別碼 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
|
Id
|
Id | string |
現有元素的識別碼。 如果使用，所有其他欄位都應為空。 |
|
|
類型
|
Type | string |
元素類型 |
|
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
DocumentId
|
DocumentId | string |
套件中文件的識別碼 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
語言
|
Language | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
傳回
處理步驟中的一組動作者。
- response
- array of Response.Actor
將利害關係人新增至套件
將利害關係人新增至套件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
類型
|
Type | True | string |
利害關係人的類型 |
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
語言
|
Language | True | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
FirstName
|
FirstName | string |
利害關係人的名字 |
|
|
姓氏
|
LastName | True | string |
利害關係人的姓氏 |
|
電子郵件地址
|
EmailAddress | True |
電子郵件地址 |
|
|
出生日期
|
BirthDate | date | ||
|
電話號碼
|
PhoneNumber | string |
電話號碼 |
|
|
AdditionalProperties
|
AdditionalProperties | object |
利害關係人的可設定附加屬性 |
|
|
類型
|
Type | True | string |
必須在套件上執行的動作類型 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
|
重定向類型
|
RedirectType | string | ||
|
返回按鈕網址
|
BackButtonUrl | url |
關閉工作階段後將使用者傳送至的 URL |
|
|
Id
|
Id | string |
現有元素的識別碼。 如果使用，所有其他欄位都應為空。 |
|
|
類型
|
Type | string |
元素類型 |
|
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
DocumentId
|
DocumentId | string |
套件中文件的識別碼 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
語言
|
Language | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
傳回
將動作項目新增至程序步驟
將動作者新增至程序步驟。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
處理步驟的索引
|
stepIndex | True | integer |
處理步驟的索引 |
|
類型
|
Type | True | string |
必須在套件上執行的動作類型 |
|
利害關係人標識碼
|
StakeholderId | True | string |
套件中利害關係人的識別碼 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
|
Id
|
Id | string |
現有元素的識別碼。 如果使用，所有其他欄位都應為空。 |
|
|
類型
|
Type | string |
元素類型 |
|
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
DocumentId
|
DocumentId | string |
套件中文件的識別碼 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
語言
|
Language | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
傳回
將文件新增至套件
將文件新增至現有的封裝。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件唯一識別碼
|
packageId | True | string |
套件唯一識別碼 |
|
名稱
|
Name | True | string |
文件名稱 |
|
是選擇性
|
IsOptional | boolean |
指出文件是否應為簽署的選擇性 |
|
|
語言
|
Language | True | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
全域唯一識別碼 |
|
|
目標類型
|
TargetType | string |
只有在伺服器配置為文件轉換時才有效。 |
|
|
目標格式
|
TargetFormat | string |
目標格式會定義是否需要進行額外的轉換。 |
|
|
Pdf錯誤處理
|
PdfErrorHandling | string |
如何處理包含小瑕疵的 PDF |
|
|
內容類型
|
ContentType | True | string |
文件的 MIME 類型 |
|
Base64資料
|
Base64Data | True | byte |
Base64 編碼的文件內容 |
|
類型
|
Type | True | string |
元素類型 |
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
語言
|
Language | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
傳回
建立新套件 （標準或即時）
建立新套件。 依預設，封裝會建立為草稿。 若要建立立即準備好簽署的即時套件，請將屬性設定 status 為 Pending。
便條： 端點 POST /packages 可讓您建立標準和即時套件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
Name | True | string |
套件名稱 |
|
Initiator
|
Initiator | True |
電子郵件地址 |
|
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
地位
|
Status | string |
已建立套件的狀態。
|
|
|
文件群組代碼
|
DocumentGroupCode | string |
封裝的文件群組代碼 |
|
|
到期日期
|
ExpiryDate | date-time |
ISO 8601 格式的日期時間值 |
|
|
名稱
|
Name | True | string |
文件名稱 |
|
是選擇性
|
IsOptional | boolean |
指出文件是否應為簽署的選擇性 |
|
|
語言
|
Language | True | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
全域唯一識別碼 |
|
|
目標類型
|
TargetType | string |
只有在伺服器配置為文件轉換時才有效。 |
|
|
目標格式
|
TargetFormat | string |
目標格式會定義是否需要進行額外的轉換。 |
|
|
Pdf錯誤處理
|
PdfErrorHandling | string |
如何處理包含小瑕疵的 PDF |
|
|
內容類型
|
ContentType | True | string |
文件的 MIME 類型 |
|
Base64資料
|
Base64Data | True | byte |
Base64 編碼的文件內容 |
|
類型
|
Type | True | string |
元素類型 |
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
類型
|
Type | True | string |
利害關係人的類型 |
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
語言
|
Language | True | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
FirstName
|
FirstName | string |
利害關係人的名字 |
|
|
姓氏
|
LastName | True | string |
利害關係人的姓氏 |
|
電子郵件地址
|
EmailAddress | True |
電子郵件地址 |
|
|
出生日期
|
BirthDate | date | ||
|
電話號碼
|
PhoneNumber | string |
電話號碼 |
|
|
AdditionalProperties
|
AdditionalProperties | object |
利害關係人的可設定附加屬性 |
|
|
類型
|
Type | True | string |
必須在套件上執行的動作類型 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
|
重定向類型
|
RedirectType | string | ||
|
返回按鈕網址
|
BackButtonUrl | url |
關閉工作階段後將使用者傳送至的 URL |
|
|
處理步驟
|
ProcessStep | integer |
程序步驟編號 |
|
|
文件索引
|
DocumentIndex | True | integer |
套件中檔案的索引 （從 0 開始） — 僅適用於 建立套件 端點 |
|
類型
|
Type | True | string |
元素類型 |
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
簽署方法
|
SigningMethods | True | array of string | |
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
主題代碼
|
ThemeCode | string |
套件主題的識別碼 |
|
|
回呼網址
|
CallBackUrl | url |
執行動作後回呼的URL |
|
|
通知CallBackUrl
|
NotificationCallBackUrl | url |
簽署者要求新簽署URL時回呼的URL |
|
|
預設重新導向網址
|
DefaultRedirectUrl | url |
動作完成後重新導向 URL |
|
|
F2f重定向網址
|
F2fRedirectUrl | url |
面對面簽署後重新導向 URL |
|
|
IsUnsignedContent可下載內容
|
IsUnsignedContentDownloadable | boolean |
是否可以下載未簽名的內容 |
|
|
IsReassign啟用
|
IsReassignEnabled | boolean |
是否啟用重新指派 |
傳回
從套件下載文件
從套件下載已簽署的文件。 每個文件都將以 PDF 或 XML 檔案的形式下載。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
套件中包含的文件的唯一識別碼
|
documentId | True | string |
套件中包含的文件的唯一識別碼 |
傳回
- response
- binary
按 ID 獲取包裹
依套件的 ID 擷取套件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
傳回
擷取可指派套件的所有文件群組
擷取可指派封裝的所有文件群組
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要搜尋的文件群組名稱 （或零件）
|
name | string |
要搜尋的文件群組名稱 （或零件） |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件群組
|
DocumentGroups | array of object |
文件群組清單 |
|
Code
|
DocumentGroups.Code | string |
文件群組的程式碼 |
|
名稱
|
DocumentGroups.Name | string |
文件群組的名稱 |
擷取可指派給套件的所有佈景主題
擷取可指派給封裝的所有佈景主題。 可以提供 MaxQuantity 和 continuationToken 來分頁結果
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Token 來取得下一組結果
|
continuationToken | string |
Token 來取得下一組結果 |
|
|
要傳回的結果數量上限
|
maxQuantity | integer |
要傳回的結果數量上限 |
|
|
排序結果的順序
|
sortOrder | string |
排序結果的順序 |
|
|
指定要排序的欄位
|
sortField | string |
指定要排序的欄位 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
繼續標誌
|
ContinuationToken | string |
用於擷取下一頁結果的代幣 |
|
物品
|
Items | array of object |
包含主題的清單 |
|
Code
|
Items.Code | string |
主題的代碼 |
|
名稱
|
Items.Name | string |
主題名稱 |
|
最大數量
|
MaxQuantity | integer |
每個請求將傳回的結果數目上限 |
|
總數
|
Total | integer |
結果總數。 |
擷取應用程式中啟用的所有語言
擷取應用程式中啟用的所有語言
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已啟用語言
|
EnabledLanguages | array of object |
已啟用語言清單 |
|
顯示名稱
|
EnabledLanguages.DisplayName | string |
語言的顯示名稱 |
|
原生名稱
|
EnabledLanguages.NativeName | string |
語言的母語名稱 |
|
等文化代碼
|
EnabledLanguages.IsoCultureCode | string |
該語言的 2 個字母的 ISO 代碼 （ISO 639-1） |
更新套件狀態
更新套件的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
body
|
body | True | string |
更新套件的到期日
更新套件的到期日
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
到期時間戳記
|
ExpiryTimestamp | date-time |
ISO 8601 格式的日期時間值 |
略過簽署者
此呼叫會略過所有尚未完成的簽署者，並將其狀態設定為「已跳過」，導致完整套件標示為「已完成」。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
發送包裹提醒
公司原則可能要求在指定的時間範圍內處理文件。 觸發「發送提醒」呼叫將查找所有尚未簽名的人，並向他們發送額外的通知作為提醒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
覆寫套件的處理程序步驟
使用 2D 陣列覆寫套件中的所有 actor，其中每組 actor 都是可以平行執行的動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一識別碼
|
packageId | True | string |
套件的唯一識別碼 |
|
類型
|
Type | True | string |
必須在套件上執行的動作類型 |
|
利害關係人標識碼
|
StakeholderId | True | string |
套件中利害關係人的識別碼 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
|
Id
|
Id | string |
現有元素的識別碼。 如果使用，所有其他欄位都應為空。 |
|
|
類型
|
Type | string |
元素類型 |
|
|
外部參考
|
ExternalReference | string |
封裝的外部參考 |
|
|
頁面
|
Page | integer |
文件的頁碼 |
|
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
|
|
寬度
|
Width | number |
元素的寬度 |
|
|
高度
|
Height | number |
元素的高度 |
|
|
DocumentId
|
DocumentId | string |
套件中文件的識別碼 |
|
|
簽署方法
|
SigningMethods | array of string | ||
|
名稱
|
Name | string |
要新增至簽署欄位的法律聲明名稱。 |
|
|
Content
|
Content | string |
自訂法律聲明內容。 |
|
|
語言
|
Language | string |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
定義
ConfiguredSigning方法
在電子簽章中設定的簽署方法
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
IsActive
|
IsActive | boolean |
signingMethod 是否可用於建立新的簽署欄位 |
|
名稱
|
Name | string |
已設定的簽署方法名稱 |
|
顯示名稱
|
DisplayNames | object |
將向簽署者顯示的每種語言名稱 |
|
DisplayNamesInitiator
|
DisplayNamesInitiator | object |
建立套件時應向啟動器顯示的每種語言名稱。 |
|
說明書
|
Descriptions | object |
每種語言的簽署方法描述，以在套件建立期間提供簽署方法的詳細資訊。 |
|
必要屬性
|
RequiredProperties | array of string |
強制簽署的必要屬性 |
|
金鑰對
|
KeyPairs | array of KeyPair |
可用來使用此方法簽署的金鑰組 |
金鑰對
簽署金鑰組的表示法
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
Name | string |
金鑰組的名稱 |
|
顯示名稱
|
DisplayNames | object |
將顯示給啟動器的每種語言名稱 |
Common.Guid
Common.電子郵件地址
通用語言
Common.電話號碼
Common.ExternalReference
Common.Additional屬性
利害關係人的可設定附加屬性
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
object |
利害關係人的可設定附加屬性 |
Common.DateTime
套件狀態
Package.Name
Document.Name
文件狀態
Document.Document選項
定義選用文件參數
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
目標類型
|
TargetType | string |
只有在伺服器配置為文件轉換時才有效。 |
|
目標格式
|
PdfOptions.TargetFormat | string |
目標格式會定義是否需要進行額外的轉換。 |
|
Pdf錯誤處理
|
PdfOptions.PdfErrorHandling | string |
如何處理包含小瑕疵的 PDF |
利害關係人.FirstName
利害關係人姓氏
Actor.Type
Actor.狀態
元素類型
元素狀態
元素位置
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
頁面
|
Page | integer |
文件的頁碼 |
|
前幾個
|
Top | number |
頂端位置 （以像素為單位） |
|
左側
|
Left | number |
左邊位置 （以像素為單位） |
元素尺寸
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
寬度
|
Width | number |
元素的寬度 |
|
高度
|
Height | number |
元素的高度 |
回應.Package.Get
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
Id | Common.Guid |
全域唯一識別碼 |
|
名稱
|
Name | Package.Name |
套件名稱 |
|
Initiator
|
Initiator | Common.EmailAddress |
電子郵件地址 |
|
外部參考
|
ExternalReference | Common.ExternalReference |
封裝的外部參考 |
|
CreationDate
|
CreationDate | Common.DateTime |
ISO 8601 格式的日期時間值 |
|
地位
|
Status | Package.Status |
包裹的狀態 |
|
到期日期
|
ExpiryDate | Common.DateTime |
ISO 8601 格式的日期時間值 |
|
Documents
|
Documents | array of Response.Document | |
|
利害關係人
|
Stakeholders | array of Response.Stakeholder |
回應文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
Id | Common.Guid |
全域唯一識別碼 |
|
地位
|
Status | Document.Status |
文件的狀態 |
|
文件選項
|
DocumentOptions | Document.DocumentOptions |
定義選用文件參數 |
|
名稱
|
Name | Document.Name |
文件名稱 |
|
語言
|
Language | Common.Language |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
外部參考
|
ExternalReference | Common.ExternalReference |
封裝的外部參考 |
|
ProofCorrelationId
|
ProofCorrelationId | Common.Guid |
全域唯一識別碼 |
回應。利害關係人
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
Type | string |
利害關係人的類型 |
|
外部參考
|
ExternalReference | Common.ExternalReference |
封裝的外部參考 |
|
Id
|
Id | Common.Guid |
全域唯一識別碼 |
|
語言
|
Language | Common.Language |
一個國家的 2 個字母的 ISO 代碼 （ISO 639-1） |
|
FirstName
|
FirstName | Stakeholder.FirstName |
利害關係人的名字 |
|
姓氏
|
LastName | Stakeholder.LastName |
利害關係人的姓氏 |
|
電子郵件地址
|
EmailAddress | Common.EmailAddress |
電子郵件地址 |
|
出生日期
|
BirthDate | date | |
|
電話號碼
|
PhoneNumber | Common.PhoneNumber |
電話號碼 |
|
AdditionalProperties
|
AdditionalProperties | Common.AdditionalProperties |
利害關係人的可設定附加屬性 |
|
Actors
|
Actors | array of Response.Actor |
回應.Actor
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
Type | Actor.Type |
必須在套件上執行的動作類型 |
|
Id
|
Id | Common.Guid |
全域唯一識別碼 |
|
利害關係人標識碼
|
StakeholderId | Common.Guid |
全域唯一識別碼 |
|
地位
|
Status | Actor.Status |
演員的地位 |
|
隱藏通知
|
SuppressNotifications | boolean |
隱藏動作者的通知 |
|
重新導向網址
|
RedirectUrl | url |
動作者動作完成後重新導向 URL |
|
Elements
|
Elements | array of Response.Element |
回應元素
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
Type | Element.Type |
元素類型 |
|
Id
|
Id | Common.Guid |
全域唯一識別碼 |
|
ActorId
|
ActorId | Common.Guid |
全域唯一識別碼 |
|
DocumentId
|
DocumentId | integer |
套件中文件的識別碼 |
|
地位
|
Status | Element.Status |
元素的狀態 |
|
外部參考
|
ExternalReference | Common.ExternalReference |
封裝的外部參考 |
|
地點
|
Location | Element.Location | |
|
尺寸
|
Dimensions | Element.Dimensions | |
|
簽署方法
|
SigningMethods | array of string | |
|
UsedSigning方法
|
UsedSigningMethod | string |
使用的簽署方法 |
回應.套件.狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
Status | Package.Status |
包裹的狀態 |
二進位
這是基本數據類型 『binary』。