共用方式為


PKIsigning (預覽版)

使用 PKIsigning 平台連接器自動化您的文件簽署需求。 將文件傳送至 PKIsigning 平台;發送邀請並檢索已簽署的文件。

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

服務 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)
連絡人​​
名稱 PKIsigning 支援
URL https://pkisigning.nl/support
Email support@pkisigning.nl
連接器中繼資料
Publisher SBRS B.V.
網站 https://pkisigning.nl
隱私策略 https://pkisigning.nl/privacy
類別 通敵;生產力

PKIsigning 使組織能夠自動化、簡化和保護批准、簽署和向客戶和第三方發送文檔的過程。 該平台支持來自荷蘭合格可信服務提供商的所有 eIDAS 個人簽名證書,並通過ISO27001認證。 這使得 PKIsigning 成為法律、金融和醫療保健組織和政府的理想合作夥伴。 與 PKisigning 連接,自動化、簡化和保護您的文件簽署流程。

先決條件

若要使用 PKIsigning 連接器,需要在「專業」訂閱中擁有 PKIsigning 平台的帳戶。 請 聯絡 PKIsigning 註冊付費訂閱。

如何取得認證

註冊訂閱後,用戶將收到一封電子郵件,其中包含設置帳戶的邀請。 註冊後,該帳戶可以直接與此連接器一起使用。

開始使用連接器

開始簽署文件的預設流程如下:

  1. 建立檔案
  2. 新增文件
  3. 新增演員
  4. 開始工作流程
  5. 使用觸發程序來取得狀態變更的通知
  6. 下載檔案

檔案

PKIsigning 希望您始終先建立檔案。 檔案充當文件和參與者的容器。 可以使用Dossiers_Create動作建立備案。 建立檔案後,請使用傳回的 PkisId 作為未來操作的參考。

Documents

建立檔案之後,您可以使用正確的檔案 Id 來新增具有Documents_Add動作的文件。 該動作不需要任何其他參數,因為它們會分散對文件檔案本身的注意力。 檔案中的文件數量沒有限制。 所有添加的演員都可以查看和下載所有文檔。

重要事項: 文件需要一或多個唯一的文字預留位置 (視簽名數目而定),以指出必須放置簽名的位置,以及由哪個執行者放置。 這可以是文件中任何位置的任何文字。 新增動作者時,您可以使用預留位置參數來定義佔位符。 例如:signature1、signature2 等...

Actors

第三步包括將演員添加到文檔中。 這是使用正確的 dossierId 和 documentId 的 Actor_Create 動作來完成的。

開始工作流程

若要啟動工作流程,並有效地傳送邀請給所有參與者,以依提供的順序簽署或下載文件,請使用具有正確 dossierId 的 Dossiers_StartWorkflow 動作。

使用觸發程序來取得狀態變更的通知

若要在簽署文件後取得文件,請使用觸發器訂閱通知。 若要接收狀態通知,請在「事件」欄位中指定「狀態」。

下載檔案

當觸發程序收到狀態更新通知時,請檢查文件的狀態是否為「已完成」。 從那時起,可以在單個 zip 文件中下載檔案中的所有文件。 如果在 PKIsigning 平台內的設定中指定應產生稽核追蹤,則也會包含此專案。

已知問題與限制

截至發佈時尚無已知問題。

常見錯誤和補救措施

沒有透過觸發程式更新狀態

如果觸發程式未回應狀態更新,請檢查是否在「事件」欄位中提供了值「status」。

HTTP 錯誤 402 需要付款

PKIsigning 平台需要積分才能執行操作。 添加演員時,會保留積分以確保可以進行操作,並且受邀者不會遇到可用積分數量不足的問題。 如果向演員發送了大量邀請,則可能會發生點數組合沒有更多可供保留的點數。 此時,將傳回 HTTP 402 錯誤。

若要解決此問題,請 PKIsigning 支援來 充值信用餘額,或清除平台上回收站中參與者的任何未發送的檔案。 然後,未使用的積分將再次可用。

FAQ

請參閱我們的 知識庫 或聯絡我們: support@pkisigning.nl

節流限制

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

動作

下載請求

將要求及其內容下載為 .zip 檔案。

依文件取得動作者資料

傳回特定文件的所有動作者的所有資料。

依要求取得動作者資料

傳回特定要求的所有動作者的所有資料。

傳送要求

啟動工作流程,並將邀請傳送給排隊的第一個執行者,以處理特定要求。

刪除文件

永久刪除特定文件。

刪除演員

永久刪除特定動作者。

刪除請求

永久刪除特定請求。

取得使用者的工作群組

傳回特定組織特定使用者的所有工作群組清單。

取得動作項目資料

傳回特定動作項目的所有資料。

取得工作群組以進行組織

傳回特定組織的所有工作群組清單。

取得文件資料

傳回特定文件的所有 (meta) 資料。

取得要求資料

傳回特定請求的所有 (meta) 資料。

建立文件

建立新文件並將其新增至特定請求。

建立演員

建立新的動作者,並將其新增至文件。

建立要求

建立新的請求。

撤回邀請

撤回目前執行者對特定要求的邀請。

更新文件

變更特定文件的資料。

更新演員

變更特定動作項目的資料。

更新要求

變更特定要求的資料。

重新傳送邀請

重新傳送目前執行者的特定要求的邀請。

下載請求

將要求及其內容下載為 .zip 檔案。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

傳回

response
file

依文件取得動作者資料

傳回特定文件的所有動作者的所有資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

動作已完成
hasActed boolean

只會傳回已完成或尚未完成動作的動作者,保留空白以傳回所有動作者。

傳回

依要求取得動作者資料

傳回特定要求的所有動作者的所有資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

動作者是否已根據要求採取行動
hasActed boolean

Read only 值,以檢查執行者是否已對文件執行動作。

傳回

傳送要求

啟動工作流程,並將邀請傳送給排隊的第一個執行者,以處理特定要求。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

刪除文件

永久刪除特定文件。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

刪除演員

永久刪除特定動作者。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

執行者ID
actorId True guid

動作者的唯一識別碼。

刪除請求

永久刪除特定請求。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

取得使用者的工作群組

傳回特定組織特定使用者的所有工作群組清單。

參數

名稱 機碼 必要 類型 Description
組織 ID
organisationId True guid

組織的唯一 ID。

用戶名稱
username True email

使用者的電子郵件地址

傳回

取得動作項目資料

傳回特定動作項目的所有資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

執行者ID
actorId True guid

動作者的唯一識別碼。

傳回

取得工作群組以進行組織

傳回特定組織的所有工作群組清單。

參數

名稱 機碼 必要 類型 Description
組織 ID
organisationId True guid

組織的唯一 ID。

傳回

取得文件資料

傳回特定文件的所有 (meta) 資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

傳回

文件的一般中繼資料

取得要求資料

傳回特定請求的所有 (meta) 資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

驗證金鑰
callbackAuthenticationKey string

觸發程序提供的驗證金鑰。

傳回

身體
RequestModel

建立文件

建立新文件並將其新增至特定請求。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

此文件所屬請求的唯一 ID。

檔案
file True file

要處理的檔案(僅限特定檔案類型)。

傳回

文件的一般中繼資料

建立演員

建立新的動作者,並將其新增至文件。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

行動
action True string

動作者必須執行的動作。

名字
firstname True string

演員的名字。

前綴
prefix string

演員的前置詞。

姓氏
lastname True string

演員的姓氏。

電子郵件地址
email True string

演員的電子郵件地址。

手機號碼
mobile True string

演員的手機號碼。

Deadline
deadline True date-time

動作者必須執行動作的日期和時間。

語言
language True string

邀請的語言。

使用強效驗證
validateRealIdentity True boolean

對此動作者使用更強的識別方法。

dossierPersonId
dossierPersonId integer
訊息
message string
簽署欄位
fieldName string

文件中現有簽署欄位的名稱,供此執行者簽署。

Placeholder
placeholder string

文件中特定預留位置的文字,參與者必須在其中放置簽名。

傳回

建立要求

建立新的請求。

參數

名稱 機碼 必要 類型 Description
要求名稱
name True string

特定要求的名稱。

工作群組識別碼
workgroupId guid

工作群組的唯一識別碼。

安全許可級別
clearancelevel True integer

特定要求的安全許可層級。

要求擁有者
owner email

作為特定請求所有者的用戶。

傳回

身體
RequestModel

撤回邀請

撤回目前執行者對特定要求的邀請。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

更新文件

變更特定文件的資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

文件名稱
name string

特定文件的名稱

文件檔名
filename string

特定文件的檔案名稱

文件類型
documentType True string

特定文件的類型。 (例如常規 PDF、財務報表、審計報告等)。

傳回

文件的一般中繼資料

更新演員

變更特定動作項目的資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

文件 ID
documentId True guid

文件的唯一 ID。

執行者ID
actorId True guid

動作者的唯一識別碼。

行動
action True string

動作者必須執行的動作。

名字
firstname True string

演員的名字。

前綴
prefix string

演員的前置詞。

姓氏
lastname True string

演員的姓氏。

電子郵件地址
email True string

演員的電子郵件地址。

手機號碼
mobile True string

演員的手機號碼。

Deadline
deadline True date-time

動作者必須執行動作的日期和時間。

語言
language True string

邀請的語言。

使用強效驗證
validateRealIdentity True boolean

對此動作者使用更強的識別方法。

dossierPersonId
dossierPersonId integer
訊息
message string

傳回

更新要求

變更特定要求的資料。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

要求名稱
name True string

特定要求的名稱。

工作群組識別碼
workgroupId guid

工作群組的唯一識別碼。

安全許可級別
clearancelevel True integer

特定要求的安全許可層級。

要求擁有者
owner email

作為特定請求所有者的用戶。

傳回

身體
RequestModel

重新傳送邀請

重新傳送目前執行者的特定要求的邀請。

參數

名稱 機碼 必要 類型 Description
請求編號
requestId True guid

請求的唯一 ID。

觸發程序

當請求發生事件時

註冊 URL 以在狀態變更時回呼。 PKIsigning 平台將向此 url 報告該組織內檔案的任何狀態更新。

當請求發生事件時

註冊 URL 以在狀態變更時回呼。 PKIsigning 平台將向此 url 報告該組織內檔案的任何狀態更新。

參數

名稱 機碼 必要 類型 Description
事件類型
Events True array of string

在要求上發生的事件類型清單,將通知此觸發程式

組織 ID
organisationId True guid

組織的唯一 ID。

傳回

名稱 路徑 類型 Description
請求編號
PkisId guid

請求的唯一 ID。

請求狀態
DossierStatus string

檔案的狀態。

原因
Reason string

變更的原因。

驗證金鑰
AuthenticationKey string

Header 來取得請求的中繼資料。

定義

ExtendedSigner模型

名稱 路徑 類型 Description
簽署欄位
fieldName string

文件中現有簽署欄位的名稱,供此執行者簽署。

Placeholder
placeholder string

文件中特定預留位置的文字,參與者必須在其中放置簽名。

行動
action string

動作者必須執行的動作。

名字
firstname string

演員的名字。

前綴
prefix string

演員的前置詞。

姓氏
lastname string

演員的姓氏。

電子郵件地址
email string

演員的電子郵件地址。

手機號碼
mobile string

演員的手機號碼。

Deadline
deadline date-time

動作者必須執行動作的日期和時間。

語言
language string

邀請的語言。

使用強效驗證
validateRealIdentity boolean

對此動作者使用更強的識別方法。

dossierPersonId
dossierPersonId integer
訊息
message string
執行者ID
id guid

特定動作者的唯一識別碼。

完成日期
signingDate date-time

動作項目執行動作的日期和時間。

動作已完成
hasSigned boolean
完整名稱
fullName string

演員的名字、前綴和姓氏的組合。

狀態資訊
emailActivity array of EmailActivity

有關動作者執行動作的過程的狀態資訊。

documentId
documentId guid

電子郵件活動

傳送給執行者的電子郵件訊息中繼資料

名稱 路徑 類型 Description
電子郵件活動
event string

特定請求和動作者的電子郵件活動。

SMTP 資訊
reason string

作為請求的一部分傳送給特定參與者的電子郵件的 SMTP 資訊。

電子郵件日期
timestamp date-time

作為請求的一部分傳送給特定參與者的電子郵件的日期。

電子郵件類型
pkisMessageType string

輸入作為請求的一部分傳送給特定參與者的電子郵件(例如邀請、提醒等)。

電子郵件請求 ID
pkisInviteId string

作為請求的一部分傳送給特定參與者的電子郵件的唯一 ID。

電子郵件地址
email string

作為請求的一部分傳送給特定參與者的電子郵件的電子郵件地址。

簽署者模型

特殊類型的演員

名稱 路徑 類型 Description
行動
action string

動作者必須執行的動作。

名字
firstname string

演員的名字。

前綴
prefix string

演員的前置詞。

姓氏
lastname string

演員的姓氏。

電子郵件地址
email string

演員的電子郵件地址。

手機號碼
mobile string

演員的手機號碼。

Deadline
deadline date-time

動作者必須執行動作的日期和時間。

語言
language string

邀請的語言。

使用強效驗證
validateRealIdentity boolean

對此動作者使用更強的識別方法。

dossierPersonId
dossierPersonId integer
訊息
message string
簽署欄位
fieldName string

文件中現有簽署欄位的名稱,供此執行者簽署。

Placeholder
placeholder string

文件中特定預留位置的文字,參與者必須在其中放置簽名。

DocumentMetaDataModel

文件的一般中繼資料

名稱 路徑 類型 Description
文件名稱
name string

特定文件的名稱。

上次文件更新
lastUpdate date-time

特定文件的上次更新日期。

文件頁數
pages integer

特定文件的頁數。

文件建立日期
created date-time

特定文件的建立日期。

文件 ID
id guid

文件的唯一 ID。

文件狀態
status string

特定文件的狀態。 (例如新的、已完成的等)。

文件包含簽名
signed boolean

指出特定文件是否已包含一或多個簽名。

文件簽名
signatures array of SignatureData

特定文件的所有簽名清單。

文件空白簽名欄位
emptySignatureFields array of SignatureField

特定文件的所有空白簽名欄位清單。

空白簽名欄位
containsBlankSignatureFields boolean

指出特定文件是否包含空白簽名欄位。

文件執行者
actors array of ExtendedSignerModel

特定文件的所有參與者清單。

請求編號
requestId guid

請求的唯一 ID。

請求索引
dossierIndex integer

屬於特定要求之所有文件的索引。

文件大小
documentSize integer

屬於特定請求的文件大小。

文件類型
documentType string

屬於特定要求的文件類型。

簽名數據

名稱 路徑 類型 Description
憑證主旨欄位
subject array of KeyValuePairOfStringAndString

用於特定簽章之憑證主旨行的欄位。

憑證簽發者欄位
issuer array of KeyValuePairOfStringAndString

用於特定簽章之憑證之簽發者行中的欄位。

簽名日期
date date-time

放置特定簽名的日期和時間。

簽署地點
location string

簽署時特定參與者的地理位置。

簽約原因
reason string

簽署時由特定參與者提供的簽署原因。

合格電子簽名
euQualified boolean

指出特定簽章是否合格 (QeS) 符合 eIDAS 法規。

進階電子簽章
advanced boolean

指出特定簽章是否進階 (AeS) 符合 eIDAS 法規。

合格的 eSeal
eSeal boolean

指出用於簽署或蓋章的特定憑證是否符合 eIDAS 法規的合格 eSeal。

動作者 IP 位址
ipAddress string

特定動作者的 IP 位址

簽名欄位
signatureField string

已簽署的欄位

簽名圖片
signatureImage string

用於演員選擇的特定簽名的影像檔案。

KeyValuePairOfStringAndString

名稱 路徑 類型 Description
Key
key string
value
value string

簽章欄位

名稱 路徑 類型 Description
簽章欄位名稱
name string

特定簽章欄位的名稱

簽名欄位頁面
page integer

為特定文件放置特定簽名欄位的頁面。

簽章欄位寬度座標
x double

特定簽名欄位相對於放置在特定文件中的頁面的位置的寬度值。

簽名欄位高座標
y double

特定簽名欄位相對於放置在特定文件中的頁面的位置的最高值。

簽名字段高度
height double

特定簽章欄位的Hight值。

簽名欄位寬度
width double

特定簽章欄位的寬度值。

組織工作組

在檔案中使用的工作群組

名稱 路徑 類型 Description
工作群組識別碼
id guid

工作群組的唯一識別碼

工作群組名稱
name string

特定工作群組的名稱

請求模型

名稱 路徑 類型 Description
請求編號
id guid

請求的唯一 ID

要求名稱
dossierName string

特定要求的名稱。

索取文件
documents array of DocumentModel

此請求中包含的文件清單。

請求狀態
status string

特定要求的狀態。 (例如新的、已完成的等)。

請求執行者
actors array of ExtendedSignerModel

特定請求的所有參與者清單。

文件簽名
signatures array of SignatureData

特定請求的所有簽名清單。

要求類型
dossierType string

特定請求的類型。 (E.g. PDF、SBR Assurance 等)。

取消原因
reasons string

使用者或動作者取消特定要求的原因。

簽署者附註
signerNote string

請注意,除了符號之外沒有其他動作的一個或多個動作者。

收件人備註
recipientNote string

請注意,除了下載之外沒有其他動作的一或多個執行者。

核准者附註
accorderNote string

請注意,除了核准請求之外沒有其他動作的一或多個執行者。

請求到期日
expires date-time

特定請求的到期日期和時間。

狀態資訊
emailActivity array of EmailActivity

有關動作者執行動作的過程的狀態資訊。

我的請求
myDossier boolean

指出您是否是特定請求的擁有者。

工作群組識別碼
workgroup guid

工作群組的唯一識別碼。

安全許可級別
clearancelevel integer

特定要求的安全許可層級。

文件模型

名稱 路徑 類型 Description
文件 ID
id guid

文件的唯一 ID

文件名稱
name string

特定文件的名稱

文件類型
documentType string

特定文件的類型。

請求索引
dossierIndex integer

屬於特定要求之所有文件的索引。

文件狀態
documentstatus string

特定文件的狀態。 (例如新的、已完成的等)。

文件執行者
actors array of SignerModel

特定文件的所有參與者清單。

檔案

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