連接電子簽名
Connective eSignatures 是著名的數位簽章解決方案，提供大量簽章方法並符合最嚴格的（國際）國家法規。 電子簽名可讓您將任何紙本流程轉變為端對端數位流程，並提供無與倫比的使用者體驗。 完全按照您想要的方式簡化簽名流程，並直接從您最喜歡的業務應用程序發送、簽名和跟踪所有類型的文檔。 加入 500 多名滿意的客戶。
此連接器適用於以下產品和區域：
| 服務 | 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://connective.eu/contact-support/ |
| service@connective.eu |
| 連接器中繼資料 | |
|---|---|
| Publisher | 連接的 |
| 網站 | https://www.connective.eu |
| 隱私策略 | https://connective.eu/privacy-policy/ |
| 類別 | IT運營;生產力 |
Connective 是數位簽章、身分識別服務和智慧文件產生方面的專家，已提供適用於 Power Automate 的 Connective 電子簽章連接器可供使用。 該連接器允許公司直接從他們最喜歡的 Microsoft 365 應用程序（從 Microsoft Teams 到 Word、SharePoint、Dynamics、OneDrive 等）轉發需要數字簽名的文檔。
如何開始使用連接器
要開始使用連接器，請聯繫您在 Connective 的客戶經理或訪問我們網站上的 聯繫頁面 以獲取憑據。
本頁將進一步詳細說明可用的不同動作，並提供有關這些動作實施的不同方式的見解。
請隨時查看我們的 文件網站 以取得更多資訊，或透過 支援聯絡表單 或支援信箱與支援團隊聯絡： service@connective.eu
詞 彙表 可用來解釋本文檔中使用的不同術語
行動
Connective eSignatures 連接器是以 eSignatures 的 API v3 為基礎。 電子簽章 API 是一種 REST API，可讓外部應用程式與本文件中列出的功能整合並使用這些功能來建立和管理簽署流程。
可用的動作可以分組到不同的群組中
| 行動小組 | 可用動作 |
|---|---|
| 上傳文件 | 建立套件 |
| 將文件新增至封裝 | |
| 取得簽署位置 | |
| 設定流程資訊 | |
| 設定套件狀態 | |
| 建立即時套件 | |
| 擷取文件的狀態 | 取得套件狀態 |
| 取得套件清單 | |
| 其他動作 | 略過簽署者 |
| 下載套件 | |
| 套件到期延長 | |
| 發送包裹提醒 | |
| 刪除套件 | |
| 檢索審計證明 | 擷取封裝稽核校訂 |
| 擷取文件稽核校訂 | |
| 擷取具有關聯ID的套件稽核校訂 | |
| 擷取具有關聯ID的檔案稽核校訂 | |
| 從外部來源新增校訂 |
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 連接電子簽章環境網址 | 字串 | 連接電子簽名環境的 URL，例如。esignatures.connective.eu | 對 |
| API 使用者名稱 | securestring | API 使用者名稱以存取 API | 對 |
| API 密碼 | securestring | 存取 API 的 API 密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載套件 |
外部系統可以使用此呼叫下載包含已簽署文件的套件。 |
| 具有文件 ID 的套件稽核校訂 |
當套件完全簽署時，可以擷取套件的稽核校訂xml。 這同樣適用於文件：它僅在包含的套件完全簽署時才有效。 |
| 刪除套件 |
eSignatures 不會在套件達到最終狀態後自動從資料庫中刪除套件。 它們會無限期地儲存。 若要從資料庫中刪除套件，使用者可以使用「刪除套件」呼叫。 |
| 到期時間戳記 |
當套件在 Create Package 呼叫中傳遞 ExpiryTimestamp 參數的值時，套件的狀態可能為 Expired。 這樣的包裹無法再簽署。 |
| 包裝清單 |
取得套件清單及其目前狀態 |
| 包裹審核證明 |
當套件完全簽署時，可以擷取套件的稽核校訂xml。 這同樣適用於文件：它僅在包含的套件完全簽署時才有效。 |
| 取得套件狀態 |
擷取套件及其文件的目前狀態。 |
| 取得簽署位置 |
此呼叫提供套件內文件內所有簽署位置的概觀。 |
| 套件關聯性審核證明下載 |
關聯 ID 可用來追蹤透過 eSignatures 應用程式的多個傳遞中的封裝或文件。 |
| 將文件新增至封裝 |
此呼叫會將文件新增至現有套件。 |
| 建立即時套件 |
此呼叫會建立包含單一文件的套件，並立即準備簽署 |
| 建立套件 |
此呼叫會建立一個空套件，允許將文件新增至其中 |
| 從外部來源新增校訂 |
此呼叫可讓API使用者從外部來源將額外的校訂新增至檔案上的位置。 |
| 從套件下載文件 |
外部系統可以使用此呼叫逐一下載套件中已簽署的文件。 每個文件都會下載為 PDF 或 XML 檔案串流，視 DocumentType 參數的值而定。 |
| 文檔關聯審計證明下載 |
關聯 ID 可用來追蹤透過 eSignatures 應用程式的多個傳遞中的封裝或文件。 |
| 略過簽署者 |
此呼叫會略過所有尚未簽署的簽署者，並將其狀態設定為「已跳過」，這會導致完整套件標示為「已完成」。 |
| 發送包裹提醒 |
公司原則可能要求在指定的時間範圍內處理文件。 觸發「發送提醒」呼叫將查找所有尚未簽名的人，並向他們發送額外的通知作為提醒。 |
| 設定套件狀態 |
透過「設定封裝狀態」呼叫，您可以變更封裝的狀態。 |
| 設定流程資訊 |
此 Web 服務方法會更新參與流程的人員 （利害關係人） ，並為他們指派需要採取的步驟。 |
下載套件
外部系統可以使用此呼叫下載包含已簽署文件的套件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
id | True | string |
套件的唯一 ID |
傳回
- response
- binary
具有文件 ID 的套件稽核校訂
當套件完全簽署時，可以擷取套件的稽核校訂xml。 這同樣適用於文件：它僅在包含的套件完全簽署時才有效。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
packageId | True | string |
套件的唯一 ID |
|
文件的唯一ID
|
documentId | True | string |
文件的唯一ID |
傳回
- 身體
- Content
刪除套件
eSignatures 不會在套件達到最終狀態後自動從資料庫中刪除套件。 它們會無限期地儲存。 若要從資料庫中刪除套件，使用者可以使用「刪除套件」呼叫。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
id | True | string |
套件的唯一 ID |
到期時間戳記
當套件在 Create Package 呼叫中傳遞 ExpiryTimestamp 參數的值時，套件的狀態可能為 Expired。 這樣的包裹無法再簽署。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
id | True | string |
套件的唯一 ID |
|
到期時間戳記
|
ExpiryTimestamp | date-time |
包裝清單
取得套件清單及其目前狀態
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
繼續權杖/guid，以知道要傳回的頁面。
|
ContinuationToken | string |
繼續權杖/guid，以知道要傳回的頁面。 MUST BE EMPTY 或從先前呼叫傳回的權杖。 |
|
|
取得或設定最大數量。
|
MaxQuantity | integer |
取得或設定最大數量。 |
|
|
取得或設定排序欄位。
|
SortField | string |
取得或設定排序欄位。 |
|
|
取得或設定排序欄位。
|
SortOrder | string |
取得或設定排序欄位。 |
|
|
取得或設定建立之前的日期。
|
CreatedBeforeDate | string |
取得或設定建立之前的日期。 |
|
|
取得或設定狀態。
|
Status | string |
取得或設定狀態。 |
|
|
取得或設定建立的日期。
|
createdAfterDate | string |
取得或設定建立的日期。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
繼續標誌
|
ContinuationToken | string |
繼續標誌 |
|
最大數量
|
MaxQuantity | integer |
最大數量 |
|
總數
|
Total | integer |
總數 |
|
物品
|
Items | array of Package |
包裹審核證明
當套件完全簽署時，可以擷取套件的稽核校訂xml。 這同樣適用於文件：它僅在包含的套件完全簽署時才有效。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
packageId | True | string |
套件的唯一 ID |
傳回
- 身體
- Content
取得套件狀態
擷取套件及其文件的目前狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽署套件的唯一識別碼
|
Id | True | string |
簽署套件的唯一識別碼 |
傳回
以檔案名稱形式向 eSignatures 入口網站使用者顯示的封裝說明。
取得簽署位置
此呼叫提供套件內文件內所有簽署位置的概觀。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽署欄位的標識碼
|
Id | True | string |
簽署欄位的標識碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
文件的唯一 ID |
|
外部文件參考
|
Documents.ExternalDocumentReference | string |
用於識別的外部參考。 請務必使用唯一值。 |
|
位置
|
Documents.Locations | array of object |
代表簽章的可能位置 |
|
Id
|
Documents.Locations.Id | string |
此位置的唯一識別碼。 |
|
標籤
|
Documents.Locations.Label | string |
您輸入為 [請求] 參數的值。 |
|
頁碼
|
Documents.Locations.PageNumber | integer |
可以找到簽名的頁面編號。 |
套件關聯性審核證明下載
關聯 ID 可用來追蹤透過 eSignatures 應用程式的多個傳遞中的封裝或文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
相關性識別碼。
|
correlationId | True | string |
相關性識別碼。 |
傳回
- 身體
- Content
將文件新增至封裝
此呼叫會將文件新增至現有套件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件識別碼。
|
PackageId | True | string |
套件唯一識別碼 |
|
文件
|
Document | string |
base64 編碼格式的附加文件。 |
|
|
文件語言
|
DocumentLanguage | string |
簽名文字中使用的語言。 |
|
|
文件名稱
|
DocumentName | string |
要在 eSignatures 入口網站中顯示的文件名稱。 |
|
|
頁碼
|
PageNumber | integer |
要新增簽署位置的頁面編號 |
|
|
寬度
|
Width | string |
寬度 |
|
|
高度
|
Height | string |
高度 |
|
|
左側
|
Left | string |
從頁面左側開始的位置 |
|
|
前幾個
|
Top | string |
從頁面頂部開始的位置 |
|
|
標記或欄位標識符
|
MarkerOrFieldId | string |
對簽署欄位、文字標記或文字欄位的唯一參考。 |
|
|
CorrelationId
|
CorrelationId | string |
識別碼，指出此套件中的哪些文件與過去在其他套件中簽署的文件相關聯。 |
|
|
DocumentType
|
DocumentType | string |
將要簽署的文件類型。 |
|
|
外部文件參考
|
ExternalDocumentReference | string |
呼叫端應用程式所提供的參考。 |
|
|
ErrorCode
|
ErrorCode | string |
包含變數資訊的錯誤碼。 |
|
|
Message
|
Message | string |
錯誤訊息詳細資料文字，未本地化 |
|
|
代表
|
Representation | string |
隨附的 base64 格式的表示文件。 這必須是 PDF 資料。 |
|
|
表示類型
|
RepresentationType | string |
表示文件的類型。 |
|
|
目標類型
|
TargetType | string |
TargetType 定義在簽署之前是否需要額外轉換為 PDF/A。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
文件的唯一 ID |
|
CreationTimestamp
|
CreationTimestamp | string |
建立流程的日期和時間。 格式：YYYY-MM-DDThh：mm：ss+zz：zz |
|
位置
|
Locations | array of object |
代表簽章的可能位置 |
|
Id
|
Locations.Id | string |
此位置的唯一識別碼 |
|
標籤
|
Locations.Label | string |
偵測到或指定的標籤 |
|
頁碼
|
Locations.PageNumber | integer |
找到該位置的頁面。 |
建立即時套件
此呼叫會建立包含單一文件的套件，並立即準備簽署
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
Document | byte |
base64 編碼格式的附加文件。 除非使用多部分格式，否則為必要。 |
|
|
文件語言
|
DocumentLanguage | string |
簽名文字中使用的語言。 目前支援：en、nl、de、fr、es。 |
|
|
文件名稱
|
DocumentName | string |
要在 eSignatures 入口網站中顯示的文件和套件的名稱。 |
|
|
外部套件資料
|
ExternalPackageData | string |
外部套件資料 |
|
|
Initiator
|
Initiator | string |
註冊使用者的電子郵件地址 |
|
|
類型
|
Type | string |
簽署者/接收者 |
|
|
訂單索引
|
OrderIndex | integer |
此數字指定參與者需要執行其動作的順序。 |
|
|
頁碼
|
PageNumber | integer |
要新增簽署位置的頁面編號 |
|
|
寬度
|
Width | string |
寬度 |
|
|
高度
|
Height | string |
高度 |
|
|
左側
|
Left | string |
從頁面左側開始的位置 |
|
|
前幾個
|
Top | string |
從頁面頂部開始的位置 |
|
|
標記或欄位標識符
|
MarkerOrFieldId | string |
對簽署欄位、文字標記或文字欄位的唯一參考。 |
|
|
簽署類型
|
SigningType | string |
此動作項目工作階段中使用的簽署類型。 |
|
|
承諾類型
|
CommitmentTypes | array of string |
一或多個承諾類型的 OID。 只有在使用簽章原則時才能傳遞。 |
|
|
MandatedSigner驗證
|
MandatedSignerValidation | string |
在 eID 其他智慧卡或 itsme 簽署會話期間執行的驗證類型。 |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
定義允許在此工作階段期間簽署哪些 eID 或其他智慧卡。 |
|
|
簽名原則標識符
|
SignaturePolicyId | string |
簽章的簽署原則詳細資料。 |
|
|
電話號碼
|
Phonenumber | string |
用於接收短信 OTP 的電話號碼。 |
|
|
重新導向網址
|
RedirectUrl | string |
最終使用者在簽署後被重新導向到的 URL。 |
|
|
傳送通知
|
SendNotifications | boolean |
電子簽名可以傳送電子郵件給所有允許簽署的人。 |
|
|
使用者角色
|
UserRoles | array of string |
簽署者的角色或職能。 |
|
|
法律聲明代碼
|
LegalNoticeCode | string |
法律注意事項 |
|
|
法律聲明文本
|
LegalNoticeText | string |
自訂法律聲明文字，以防三個預先定義的法律聲明均不適用。 |
|
|
電子郵件地址
|
EmailAddress | string |
電子郵件地址 |
|
|
FirstName
|
FirstName | string |
FirstName |
|
|
姓氏
|
LastName | string |
姓氏 |
|
|
出生日期
|
BirthDate | string |
出生日期 |
|
|
語言
|
Language | string |
語言 |
|
|
外部利害關係人參考
|
ExternalStakeholderReference | string |
外部利害關係人參考 |
|
|
回呼網址
|
CallBackUrl | string |
每次完成此套件的動作時都會呼叫的 REST API URL |
|
|
CorrelationId
|
CorrelationId | string |
識別碼，指出哪些套件或文件相互關聯 |
|
|
文件群組代碼
|
DocumentGroupCode | string |
「代碼」，用於識別應在其中顯示文件的文件群組 |
|
|
主題代碼
|
ThemeCode | string |
必須套用至套件的佈景主題 |
|
|
下載未簽名文件
|
DownloadUnsignedFiles | boolean |
此參數決定在簽署之前是否可以從所見即所得下載套件 |
|
|
重新指派已啟用
|
ReassignEnabled | boolean |
此參數會決定是否可以將套件從所見即所得重新指派給另一個核准者/簽署者。 |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
此參數會決定動作 URL 在未使用時必須在多少天後到期。 |
|
|
到期時間戳記
|
ExpiryTimestamp | string |
呼叫端應用程式所提供的參考。 電子簽章入口網站不會使用此參數 |
|
|
外部文件參考
|
ExternalDocumentReference | string |
此參數由呼叫應用程式提供，則電子簽章入口網站不會使用此參數 |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
此參數由呼叫應用程式提供，則電子簽章入口網站不會使用此參數 |
|
|
F2F直接網址
|
F2FRedirectUrl | string |
在所有欄位都以「面對面」簽署後，或所有欄位都遭到拒絕後，一般使用者會重新導向至的 URL。 |
|
|
通知CallBackUrl
|
NotificationCallBackUrl | string |
REST API URL，當使用者要求接收通知時，將呼叫該 URL。 如果未提供 URL，則不會執行回呼 |
|
|
Pdf錯誤處理
|
PdfErrorHandling | string |
如何處理包含小瑕疵的 PDF |
|
|
代表
|
Representation | string |
附加的 base64 格式表示文件 |
|
|
表示類型
|
RepresentationType | string |
表示文件的類型，在填寫表示時必須存在。 僅支援「應用程式/pdf」。 |
|
|
簽署範本程式碼
|
SigningTemplateCode | string |
入口網站中設定的範本將提供所有必要的資訊 |
|
|
目標類型
|
TargetType | string |
TargetType 定義在簽署之前是否需要完成 PDF/A 的額外轉換 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
套件的唯一識別碼。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根據伺服器建立套件的日期和時間。 |
建立套件
此呼叫會建立一個空套件，允許將文件新增至其中
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
內容-類型
|
Content-Type | True | string |
內容-類型 |
|
Initiator
|
Initiator | string |
註冊使用者的電子郵件地址。 |
|
|
PackageName
|
PackageName | string |
套件名稱，在 eSignatures 入口網站中顯示，以及下載為 zip 檔案時。 |
|
|
回呼網址
|
CallBackUrl | string |
REST API URL，每次完成此套件的動作時都會呼叫。 |
|
|
CorrelationId
|
CorrelationId | string |
識別碼，指出哪些套件相互關聯。 |
|
|
文件群組代碼
|
DocumentGroupCode | string |
「代碼」，用於識別應在其中顯示套件的文件群組。 |
|
|
主題代碼
|
ThemeCode | string |
必須套用至套件的佈景主題 |
|
|
下載未簽名文件
|
DownloadUnsignedFiles | boolean |
此參數會決定在簽署之前是否可以從所見即所得下載套件。 |
|
|
重新指派已啟用
|
ReassignEnabled | boolean |
此參數會決定是否可以將套件從所見即所得重新指派給另一個核准者/簽署者。 |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
此參數會決定動作 URL 在未使用時必須在多少天後到期。 |
|
|
到期時間戳記
|
ExpiryTimestamp | string |
此套件到期且無法再簽署的日期和時間。 |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
呼叫端應用程式所提供的參考。 電子簽章入口網站不會使用此參數。 |
|
|
外部套件資料
|
ExternalPackageData | string |
此欄位保留供將來使用。 它可用於客戶特定的擴充功能，以與第三方服務整合，例如簽帳金融卡簽署。 |
|
|
F2F直接網址
|
F2FRedirectUrl | string |
在所有欄位都以「面對面」簽署後，或當所有欄位都被拒絕時，一般使用者會重新導向至的URL。 |
|
|
通知CallBackUrl
|
NotificationCallBackUrl | string |
REST API URL，當使用者要求接收通知時，將呼叫該 URL。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
套件的唯一識別碼。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根據伺服器建立套件的日期和時間。 |
從外部來源新增校訂
此呼叫可讓API使用者從外部來源將額外的校訂新增至檔案上的位置。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一ID
|
packageId | True | string |
套件的唯一ID |
|
Content
|
Content | string |
校訂的實際內容。 |
|
|
位置標識符
|
LocationId | string |
產生校訂內容的簽章位置。 |
|
|
名稱
|
Name | string |
校訂的名稱。 |
|
|
類型
|
Type | string |
機器可讀的「類型」鍵。 可以自由選擇。 |
|
|
Description
|
Description | string |
人類可讀的校訂簡短描述。 |
|
|
IP地址
|
IpAddress | string |
新增校訂之外部來源一般使用者的IP位址。 |
從套件下載文件
外部系統可以使用此呼叫逐一下載套件中已簽署的文件。 每個文件都會下載為 PDF 或 XML 檔案串流，視 DocumentType 參數的值而定。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽署套件的唯一識別碼
|
id | True | string |
簽署套件的唯一識別碼 |
|
封裝中包含的文件的唯一 ID
|
documentId | True | string |
封裝中包含的文件的唯一 ID |
傳回
- response
- binary
文檔關聯審計證明下載
關聯 ID 可用來追蹤透過 eSignatures 應用程式的多個傳遞中的封裝或文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
相關性識別碼。
|
correlationId | True | string |
相關性識別碼。 |
傳回
- 身體
- Content
略過簽署者
此呼叫會略過所有尚未簽署的簽署者，並將其狀態設定為「已跳過」，這會導致完整套件標示為「已完成」。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一ID
|
PackageId | True | string |
套件的唯一ID |
發送包裹提醒
公司原則可能要求在指定的時間範圍內處理文件。 觸發「發送提醒」呼叫將查找所有尚未簽名的人，並向他們發送額外的通知作為提醒。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
PackageId | True | string |
套件的唯一 ID |
設定套件狀態
透過「設定封裝狀態」呼叫，您可以變更封裝的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽署套件的唯一識別碼
|
Id | True | string |
簽署套件的唯一識別碼 |
|
地位
|
Status | string |
待處理/撤銷 |
傳回
以檔案名稱形式向 eSignatures 入口網站使用者顯示的封裝說明。
設定流程資訊
此 Web 服務方法會更新參與流程的人員 （利害關係人） ，並為他們指派需要採取的步驟。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套件的唯一 ID
|
id | True | string |
套件的唯一 ID |
|
類型
|
Type | string |
類型 |
|
|
訂單索引
|
OrderIndex | string |
此數字指定參與者需要執行其動作的順序。 |
|
|
位置標識符
|
LocationIds | array of string |
此人必須放置簽名的位置識別碼。 |
|
|
簽署類型
|
SigningType | string |
此動作項目工作階段中使用的簽署類型。 |
|
|
承諾類型
|
CommitmentTypes | array of string |
一或多個承諾類型的 OID。 只有在使用簽章原則時才能傳遞。 |
|
|
MandatedSigner驗證
|
MandatedSignerValidation | string |
在 eID 其他智慧卡或 itsme 簽署會話期間執行的驗證類型。 |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
定義允許在此工作階段期間簽署哪些 eID 或其他智慧卡。 |
|
|
簽名原則標識符
|
SignaturePolicyId | string |
簽章的簽署原則詳細資料。 |
|
|
電話號碼
|
Phonenumber | string |
用於接收短信 OTP 的電話號碼。 |
|
|
重新導向網址
|
RedirectURL | string |
使用者在簽署或拒絕後重新導向至的 URL。 重新導向會在簽署或拒絕之後立即發生。 |
|
|
傳送通知
|
SendNotifications | boolean |
電子簽名可以傳送電子郵件給需要執行動作（例如簽署）的執行者 |
|
|
使用者角色
|
UserRoles | array of string |
此人必須放置簽名的位置識別碼。 |
|
|
法律聲明代碼
|
LegalNoticeCode | string |
這 3 個值將指向應用程式內建的 3 個法律聲明。 這些可以在配置索引中更改。 |
|
|
法律聲明文本
|
LegalNoticetext | string |
自訂法律聲明文字，以防三個預先定義的法律聲明均不適用 |
|
|
電子郵件地址
|
EmailAddress | string |
電子郵件地址 |
|
|
FirstName
|
FirstName | string |
名字 |
|
|
語言
|
Language | string |
此利害關係人的 UI 語言。 目前支援：en、nl、de、fr、es。 |
|
|
姓氏
|
LastName | string |
姓氏 |
|
|
出生日期
|
BirthDate | string |
出生日期格式：YYYY-MM-DD |
|
|
外部利害關係人參考
|
ExternalStakeholderReference | string |
呼叫端應用程式所提供的參考。 電子簽章入口網站不會使用此參數。 |
定義
Package
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
Id | string | |
|
套件狀態
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
封裝文件
包裹中每個文件的詳細信息
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
文件的唯一ID |
|
外部文件參考
|
ExternalDocumentReference | string |
傳回此檔的外部參考，因為它是透過 [將檔新增至套件] 呼叫傳入的。 |
|
文件名稱
|
DocumentName | string |
文件名稱 |
|
DocumentType
|
DocumentType | string |
套件中的文件類型。 |
套件狀態
以檔案名稱形式向 eSignatures 入口網站使用者顯示的封裝說明。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
以檔案名稱形式向 eSignatures 入口網站使用者顯示的封裝說明。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根據伺服器建立套件的日期和時間。 |
|
Initiator
|
Initiator | string |
Initiator 欄位，因為它在建立時傳入。 |
|
到期時間戳記
|
ExpiryTimestamp | string |
文件到期的 UTC 格式時間。 可以是 null。 |
|
ExternalPackageReference
|
ExternalPackageReference | string |
傳回套件的外部參考識別碼，因為它在建立時傳入。 |
|
F2FSigningUrl
|
F2FSigningUrl | string |
連結至套件，可一次從所有簽署會話中挑選。 |
|
套件狀態
|
PackageStatus | string |
整個包裹的狀態： |
|
套件文件
|
PackageDocuments | array of PackageDocument |
套件中每個文件的詳細資料。 |
|
利害關係人
|
Stakeholders | array of object |
將與包裹互動的每個人的詳細信息。 |
|
類型
|
Stakeholders.Type | string |
利害關係人類型：Person、PersonGroup 或 ContactGroup。 |
|
人員群組名稱
|
Stakeholders.PersonGroupName | string |
人員群組的名稱。 只有在要求中將 Type 設定為 PersonGroup 時才會傳回。 |
|
聯絡群組代碼
|
Stakeholders.ContactGroupCode | string |
聯絡人群組的代碼。 只有在要求中將 Type 設定為 ContactGroup 時才會傳回。 |
|
電子郵件地址
|
Stakeholders.EmailAddress | string |
簽署者的電子郵件地址。 |
|
外部利害關係人參考
|
Stakeholders.ExternalStakeholderReference | string |
在外部系統中識別此人的外部參考。 |
|
利害關係人標識碼
|
Stakeholders.StakeholderId | string |
唯一 ID。 |
|
Actors
|
Stakeholders.Actors | array of object |
要採取的所有步驟的詳細信息。 |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
此動作、利害關係人和檔組合的唯一識別碼。 |
|
動作網址
|
Stakeholders.Actors.ActionUrl | string |
此人員可以開啟以與套件互動的URL。 |
|
動作網址
|
Stakeholders.Actors.ActionUrls | array of object |
PersonGroup 或 ContactGroup 的不同人員可以開啟以與套件互動的 URL 陣列。 |
|
電子郵件地址
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
此人的電子郵件地址。 |
|
網址
|
Stakeholders.Actors.ActionUrls.Url | string |
此人員可以開啟以與套件互動的URL。 |
|
Actor狀態
|
Stakeholders.Actors.ActorStatus | string |
草稿 （套件狀態為草稿） |
|
類型
|
Stakeholders.Actors.Type | string |
簽署者/接收者 |
|
完成者
|
Stakeholders.Actors.CompletedBy | string |
完成動作的一般使用者名稱。 |
|
已完成時間戳記
|
Stakeholders.Actors.CompletedTimestamp | string |
完成此動作的時刻時間戳記。 |
|
原因
|
Stakeholders.Actors.Reason | string |
傳回將封裝狀態變更為最終狀態 （例如拒絕） 的人員輸入的文字。 |
|
位置
|
Stakeholders.Actors.Locations | array of object |
代表簽章的可能位置。 |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
此位置的唯一識別碼 |
|
UsedSigning類型
|
Stakeholders.Actors.Locations.UsedSigningType | string |
傳回用來簽署文件的簽署類型。 |
Content
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
上傳
|
uploads | array of object | |
|
上傳
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
結束
|
uploads.upload.end | date-time | |
|
簽名
|
uploads.upload.signatures | array of object | |
|
校訂
|
uploads.upload.signatures.proofs | array of object | |
|
名稱
|
uploads.upload.signatures.proofs.proof.name | string | |
|
型別
|
uploads.upload.signatures.proofs.proof.type | string | |
|
索引
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
位置標識符
|
uploads.upload.signatures.locationId | string | |
|
索引
|
uploads.indexes | array of object | |
|
識別碼
|
uploads.indexes.index.identifier | boolean | |
|
內容
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
軟體包ID
|
uploads.packageId | string |
二進位
這是基本數據類型 『binary』。