OK dokument (獨立發行者) (預覽版)
OK dokument 提供易於使用且可定制的電子簽名和數字文檔分發平台,可無縫集成到您現有的系統中
此連接器適用於以下產品和區域:
| 服務 | 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) |
| 連絡人 | |
|---|---|
| 名稱 | 塞福爾·斯洛文斯科 a.s. |
| URL | https://www.seyfor.com |
| tomas.szarka@seyfor.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 塞福爾·斯洛文斯科,a.s. |
| 網站 | https://okdokument.com/ |
| 隱私策略 | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| 類別 | 生產力 |
OK dokument - 電子簽名
OK dokument 提供易於使用且可定制的電子簽名和數字內容分發平台,可與您現有系統無縫集成。
Publisher
塞福爾·斯洛文斯科,a.s.
先決條件
您需要擁有 OK https://app.okdokument.comdokument 服務產生的帳戶和有效的 API 金鑰。
支援的作業
1. 文件上傳
用於將 PDF 檔案上傳至文件簽名服務的動作。 此動作會採用 base64 字串,並將其上傳至 OK dokument API 平台。
文件在其存留期內會傳遞數個狀態。 OK dokument API 使用下列文件狀態:
- 標籤 — 搜尋文字標籤並插入簽名 acrofields 的狀態。 成功插入 acrofields 後,它會自動將狀態變更為 tosign
- tostamp – 將數字圖章插入文檔的狀態
- ToSign – 準備簽署的文件
- 已簽署 – 已簽署的文件 (在指定的 signatureRequestID 內)
- ErrorSendInfo – 呼叫資訊服務時出錯
- 已取消 – 已取消文件 – 簽署者按下文件中的「取消」按鈕
標誌性的尾聲
Acrofield 是 PDF 中支援的一種作用中欄位。 簽名 acrofield 是一種特殊類型的活動欄位,允許將簽名插入到文件的固定位置。 Acrofields 可以使用專用的 PDF 工具 (例如 Adobe PRO) 或範本工具 (例如 JasperReport) 插入 PDF 中。
Tags
標籤代表 API 伺服器掃描的唯一文字值。 如果找到它,它會在其位置插入簽名十字場。 標籤查閱是由「標籤」文件狀態提供,必須在呼叫JSON/文件服務時設定。 OKdokument API 支援下列標籤的選用簽章:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OKdokument API 支援以下強制簽名標籤: _SC1__SC2__SC3_ _SC4__SC5_
如果使用強制標籤,則所有可見的強制簽名 acrofields 都必須在提交文件之前簽署。
如果在註冊 signatureRequest 時無法準備帶有簽名 acrofields 或標籤的文件,則可以啟用“隨處簽名”功能,這將允許用戶在任何位置簽署文檔,用戶單擊/點擊即可簡單
將文件轉換為 PDF
OKdokument API支援將.doc、.docx、.xls.xlsx 轉換為PDF檔案格式。 源文件也可以包含標籤,OKdokument API 將首先進行文件轉換,然後自動插入簽名 acrofields。
要將文件轉換為 PDF,您必須填寫文檔的名稱。 如果您想要將檔案轉換為 PDF 格式,則此參數是必填的。 若要轉換,檔案後綴必須為:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
儲存和刪除文件
OK dokument API 不充當已簽署文件的永久存檔。 適用下列規則:
- 簽署的文件會在簽署後 10 天自動刪除
- 未簽名的文件在上傳後 30 天後自動刪除
2. 簽名請求
此動作用於產生簽章要求 ID。 在此動作中,您必須使用文件 ID。 文件ID是文件上傳動作的結果。
在此動作中,您可以將簽章程序轉換為多階段簽章程序。 新增其他參數「簽名欄位」可讓您管理每個簽名請求中應提供的內容。 您可以使用具有內部名稱的 acrofields
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
此動作可以在您的程序中多次使用。 簽名請求操作在 OK dokument 服務中生成為“簽名請求”,並且此 ID 對於每個“簽名”操作都是唯一的。
若要傳送文件簽名請求,您可以使用回應屬性 URL,並在電子郵件、推播通知或 MS Teams 中使用它來要求某人簽署特定文件。
簽署文件後,您可以使用「簽名請求」將文件狀態變更為「tosign」,並建立新的 signatureRequestId,並為下一次簽名準備文件。 然後該過程重複步驟 3 – 5。
具有一個強制尾場的簽名請求範例
_SC1_
在一個簽名請求中具有一個強制 acrofield 和選擇性 acrofield 的簽名請求範例_SC1_;_SO2_
簽名請求中的其他規則
其他規則可用於:
- 停用或啟用 Sign Anywhere 功能
- 預先定義簽署者名稱的值
- 啟用簽署者名稱的輸入
- 啟用從 OK Dokument 傳送簽名請求
- 啟用電子郵件提醒
- 透過電子郵件或簡訊進行 OTP(一次性密碼)設定
- 使用 OTP 簽署文件
- 停用滑鼠簽署
| 規則名稱 | 參數 | Description |
|---|---|---|
| signAnywhere已啟用 | 對/錯 | 停用 sign anywhere 函數的參數 |
| guiRequestSigner名稱 | 對/錯 | 啟用簽署者名稱輸入的參數 |
| guiSigner名稱 | 簽署者名稱 | 簽署者名稱的預先定義值,最多 40 個字元。 如果已啟用 guiRequestSignerName,則簽署者可以變更簽署者名稱。 |
| signAnywhere已啟用 | 對/錯 | 停用 sign anywhere 函數的參數 |
| 電子郵件至 | 簽署者電子郵件 | 簽署者會傳送電子郵件,將簽署要求 URL 傳送至哪個 |
| 被交付。 | ||
| 電子郵件來源 | 寄件者電子郵件 | 寄件者電子郵件。 如果使用 emailTo 規則,則為必要 |
| name來自 | 寄件者名稱 | 寄件者名稱,將用於電子郵件範本 |
| 電子郵件通知 | 啟用電子郵件提醒的規則。 電子郵件提醒會在每天早上 7:00 傳送電子郵件,以處理未簽署的簽名要求。 電子郵件會傳送至 emailTo 和 emailFrom – 根據 - signatureRequest 設定。 | |
| 電子郵件最終 | 簽署者電子郵件 | 傳送電子郵件以遞送已簽署的文件。 如果 emailFinal 沒有參數,則已簽署的文件將傳送至 emailTo。 |
| openOtp電話 | 簽署者電話 | 用於存取文件的一次性密碼將傳送到的簽署人電話號碼。 要使用短信一次性密碼,您必須購買帶有短信的簽名請求包。 |
| openOtp電子郵件 | 簽署者電子郵件 | 將存取文件的一次性密碼傳送到的簽署者電子郵件。 |
| signOtpPhone | 簽署者電話 | 簽署人電話號碼,用於簽署文件的一次性密碼將傳送到該電話號碼。 OTP 簽章需要簽章 acrofield。 |
| signOtp電子郵件 | 簽署者電子郵件 | 簽署者電子郵件,用於簽署文件的一次性密碼將傳送到該電子郵件。 OTP 簽章需要簽章 acrofield。 |
| lang | SK、CS、EN、RO、英國、PL、PT、HU | 電子郵件和簡訊範本的語言,如果未設定規則,則使用斯洛伐克語作為預設語言。 |
| mouse簽名 | 假的 | 停用滑鼠簽署的規則。 |
用於編寫簽名請求規則的語法
RuleName-Value
編寫多個簽名請求規則的語法
RuleName1-Value_RuleName2-Value_RuleName3-Value
已啟用 Sign Anywhere 的簽名請求範例
signAnywhereEnabled-true
已停用 Sign Anywhere 並已啟用具有預填值的簽署者名稱的簽名請求範例
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
已停用 Sign Anywhere 的簽名請求範例、已啟用具有預先填入值的簽署者名稱、定義要開啟簽名請求的 OTP 電子郵件、傳送簽名請求的電子郵件、電子郵件範本語言、簽名請求寄件者電子郵件
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false
到期時間
簽名請求到期的預設值為 24 小時。 您可以使用此參數 expirationTime 將此時間範圍延長至 10 天。 簽章請求 ID 到期時間。 自 1970 年 1 月 1 日 00:00:00 UTC 以來的時間(以毫秒為單位)
OKdokument API 允許您通過電子郵件共享簽名請求 url。 要發送電子郵件,您必須使用規則:
- emailTo – 簽署者的電子郵件
- emailFrom – 寄件者的電子郵件
- nameFrom – 寄件者的名稱
電子郵件將從 okdokument@okdokument.sk傳遞,但當簽名者點擊 回复/全部回复 按鈕時,回复將直接發送給發件人 (emailFrom)。 我們也建議在簽署程式中使用下列規則進行其他設定:
- emailFinal – 用於傳送已簽署文件的電子郵件。 依預設,會使用 emailTo,但可以變更。 如果是多輪簽名,請在最後一輪簽名中使用此規則並填寫所有歌手的電子郵件地址。 範例: emailFinalemail@address.com|email2@address.com
- emailNotification - 用於傳送文件正在等待簽署的提醒的電子郵件。
- language – 電子郵件範本的語言
- 檔案名稱 — 文件名稱,將用於電子郵件範本。 如果未填寫檔案名稱,則技術文件 ID 將用作文件名稱
3. 等待簽名
觸發動作「等待簽章」可用於您的流程。 “等待簽名”操作正在通過單擊提交按鈕等待文檔簽名在 確定文檔 服務中得到確認。 提交簽名後,此觸發操作即完成。 如果您需要在程序中等待文件簽名確認,可以使用此動作。
4. 下載已簽署的文件
此動作可讓您下載已簽署的文件,並在系統中的其他步驟中處理文件,或將它儲存到 SharePoint 或其他文件儲存系統。
5. 刪除文檔
簽署文件後,您可以使用手動刪除操作從 OK dokument 服務中刪除文件。 所有上傳的文件將在 60 天后自動刪除,已簽署的文件將在 10 天後刪除。
取得憑證
您可以透過訂閱 來取得 使用 OK dokument 服務 https://okdokument.com/en/about/api/所需的 API 金鑰。
已知問題和限制
目前,使用acrofields和標籤有限制。 標籤或 acrofield 的唯一可能用途是處理程序中預先定義的字串格式: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ 或 _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ 。
目前正在使用自訂 acrofield 內部名稱:
| 複選框 | 阿克羅菲爾德 |
|---|---|
| 選用核取方塊 | 一氧化碳 |
| 強制核取方塊 | 鉻 |
| 文字欄位 | 阿克羅菲爾德 |
|---|---|
| 選擇性 TextField | TO |
| 必填文字欄位 | TC |
| 選項按鈕群組 | 阿克羅菲爾德 |
|---|---|
| 選用的選項按鈕群組 | RO |
| 強制單選按鈕群組 | RC |
| 組合盒 | 阿克羅菲爾德 |
|---|---|
| 可選的組合框 | 國會企業組織 |
| 強制組合盒 | 加拿大廣播公司 |
部署指示
請使用 此處 的指示,在 Microsoft Power Automate、Power Apps 或 Azure LogicApps 中將此連接器部署為自訂連接器。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| OK dokument API 金鑰 | securestring | Anasoft 發出的應用程式/訂閱 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載已簽署的文件 |
下載已簽署的文件 |
| 文件上傳 |
文件上傳 |
| 文件刪除 |
文件刪除 |
| 簽名請求 |
簽名請求 |
下載已簽署的文件
下載已簽署的文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
Document ID | True | string |
「文件上傳」動作中的文件 ID |
傳回
文件內容
- 文件內容
- binary
文件上傳
文件上傳
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件操作
|
state | string |
文件操作 |
|
|
檔案
|
file | True | binary |
檔案內容 |
|
檔名
|
filename | string |
副檔名的檔案名稱 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件 ID
|
result | string |
文件 ID |
文件刪除
文件刪除
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
Document ID | True | string |
文件 ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
字碼 |
|
訊息
|
message | string |
訊息 |
|
StatusCode
|
statusCode | integer |
StatusCode |
簽名請求
簽名請求
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
id | True | string |
「文件上傳」動作中的文件 ID |
|
簽名欄位
|
SIGNATURE | string |
文件中的簽名欄位 |
|
|
到期時間
|
expirationTime | string |
到期時間(以毫秒為單位) |
|
|
名稱
|
name | string |
十字場的名稱 |
|
|
價值觀
|
value | string |
Acrofield 值 |
|
|
唯讀
|
readOnly | boolean |
Acrofield 是唯讀的 |
|
|
附加規則
|
rules | string |
定義簽名請求程序的規則 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
簽名請求 ID
|
result | string |
簽名請求 ID |
|
簽名請求 URL
|
url | string |
url |
觸發程序
| 等待文件簽名 |
等待文件簽名 |
等待文件簽名
等待文件簽名
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽名請求 ID
|
signatureRequestId | True | string |
簽名請求動作中的簽名請求 ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
字碼 |
|
StatusCode
|
statusCode | integer |
StatusCode |
定義
二進位
這是基本數據類型 『binary』。