Certinal eSign （Preview）
Certinal eSign 使企業能夠安全地發送、簽署及管理具備全球合規電子簽章的文件。 Certinal 專為受管制產業設計，提供即時工作流程追蹤、防篡改稽核追蹤及無縫自動化。 在您的工作流程中使用 Certinal eSign，數位化核准流程、加速流程，並確保在 70+ 個國家的簽名具有合法效力。
此連接器適用於以下產品和區域：
| 服務 | 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.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Certinal 公司 |
| 網站 | https://www.certinal.com/ |
| 隱私策略 | https://www.certinal.com/privacy-policy |
| 類別 | 生產力;企業管理 |
Certinal eSign
概觀
Certinal eSign 為全球企業提供安全、合規的電子簽章與電子同意工作流程——直接從 Power Automate 發送、簽署、追蹤及管理文件。
先決條件
你需要有 Certinal 管理員帳號才能使用 Connector 觸發器。 若要在此整合中使用 Connector 觸發器，必須在你的 Certinal Admin 設定中啟用 Power Connector。
如何取得認證
Certinal 使用 API 金鑰來驗證服務。 你需要從 Certinal Admin 帳號產生 API 金鑰。
支援的作業
連接器支援下列作業：
取得交易詳情
依交易 ID 取得交易詳情
下載交易文件
下載指定交易ID的文件
建立交易
建立交易
使用範本建立交易
使用指定的模板 ID 建立交易
列出使用者
列出使用者
取得使用者資訊
取得特定使用者 ID 的使用者資料
建立使用者
建立使用者
支援的觸發器
連接器支援下列觸發程式：
當交易狀態變更時
為特定交易事件註冊回調
API 文件：
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
求助與支持
https://esign.certinal.com/esign/certinal-docs/help-support
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有地區 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | 安全字串 | 此 API 的 API 金鑰 | 對 |
| 基礎 API 端點 | 字串 | API 端點的基礎網址（例如 api.certinal.com） | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載交易文件 |
下載指定交易ID的文件 |
| 使用範本建立交易 |
使用指定的模板 ID 建立交易 |
| 列出使用者 |
列出使用者 |
| 刪除訂閱 |
刪除訂閱 |
| 取得交易詳情 |
依交易 ID 取得交易詳情 |
| 取得使用者資訊 |
取得特定使用者 ID 的使用者資料 |
| 建立交易 |
建立交易 |
| 建立使用者 |
建立使用者 |
下載交易文件
下載指定交易ID的文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易識別碼
|
transactionId | True | string |
唯一交易識別碼 |
|
文件類型
|
documentType | True | string |
可下載文件類型 |
傳回
- response
- file
使用範本建立交易
使用指定的模板 ID 建立交易
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易名稱
|
name | string |
交易名稱 |
|
|
交易狀態
|
status | string |
交易狀態 |
|
|
外部識別碼
|
externalId | string |
外部識別碼 |
|
|
範本識別碼
|
templateId | string |
範本識別碼 |
|
|
次要模板 ID
|
secondaryTemplateIds | array of string |
次要模板 ID |
|
|
Message
|
message | string |
給所有參與者的電子郵件訊息。 |
|
|
回調網址
|
url | string |
回調網址 |
|
|
交易事件
|
transactionEvents | array of string |
交易事件 |
|
|
參與活動
|
participantEvents | array of string |
參與活動 |
|
|
參與者順序
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
是自動處理嗎？
|
autoProcess | boolean |
是自動處理嗎？ |
|
|
欄位名稱
|
fieldName | string |
欄位名稱 |
|
|
欄位值
|
value | string |
欄位值 |
|
|
名稱
|
name | string |
候選人姓名 |
|
|
電子郵件地址
|
emailAddress | string |
候選人電子郵件地址 |
|
|
Message
|
message | string |
Message |
|
|
語言
|
language | string |
語言 |
|
|
傳遞管道
|
deliveryChannels | array of string |
傳遞管道 |
|
|
客製化 SMS 車身
|
customSMSBody | string |
客製化 SMS 車身 |
|
|
名稱
|
name | string |
名稱 |
|
|
Message
|
message | string |
Message |
|
|
是必須的嗎？
|
required | boolean |
是必須的嗎？ |
|
|
名稱
|
name | string |
名稱 |
|
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
|
語言
|
language | string |
語言 |
|
|
欄位值
|
value | string |
欄位值 |
|
|
欄位名稱
|
fieldName | string |
欄位名稱 |
|
|
Code
|
code | string |
Code |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
交易識別碼
|
data.transactionId | string |
交易識別碼 |
列出使用者
列出使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頁碼
|
pageNo | True | integer | |
|
每頁記錄數
|
perPageRecords | True | integer |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
記錄總數
|
data.totalRecords | integer |
記錄總數 |
|
總頁數
|
data.totalPages | integer |
總頁數 |
|
佩奇唱片公司
|
data.perPageRecords | integer |
佩奇唱片公司 |
|
頁碼
|
data.pageNo | integer |
頁碼 |
|
記錄
|
data.records | array of object |
使用者紀錄 |
|
名字
|
data.records.firstName | string |
名字 |
|
姓氏
|
data.records.lastName | string |
姓氏 |
|
公司
|
data.records.company | string |
公司 |
|
時區
|
data.records.timezone | string |
時區 |
|
語言
|
data.records.language | string |
語言 |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
職稱
|
data.records.jobTitle | string |
職稱 |
|
電話號碼
|
data.records.phoneNumber | string |
電話號碼 |
|
國碼 (地區碼)
|
data.records.phoneCountryCode | string |
國碼 (地區碼) |
|
角色
|
data.records.roles | array of string |
角色 |
|
最終郵件被停用了嗎？
|
data.records.finalMailDisabled | boolean |
最終郵件被停用了嗎？ |
|
提醒郵件被關閉了嗎？
|
data.records.reminderMailDisabled | boolean |
提醒郵件被關閉了嗎？ |
|
寄件人郵件被停用了嗎？
|
data.records.senderMailDisabled | boolean |
寄件人郵件被停用了嗎？ |
|
是整合使用者嗎？
|
data.records.integrationUser | boolean |
是整合使用者嗎？ |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
是活躍的
|
data.records.active | boolean |
是活躍的 |
|
身份識別碼
|
data.records.id | string |
身份識別碼 |
|
電子郵件地址
|
data.records.emailAddress | string |
電子郵件地址 |
刪除訂閱
刪除訂閱
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
Webhook 訂閱唯一識別碼，需刪除 |
取得交易詳情
依交易 ID 取得交易詳情
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易識別碼
|
transactionId | True | string |
唯一交易識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
交易名稱
|
data.name | string |
交易名稱 |
|
交易狀態
|
data.status | string |
交易狀態 |
|
交易識別碼
|
data.transactionId | string |
交易識別碼 |
|
Message
|
data.mail.message | string |
給所有參與者的電子郵件訊息。 |
|
最後更新日期
|
data.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.createdDate | string |
建立日期 |
|
使用者識別碼
|
data.createdBy.id | string |
由使用者ID建立 |
|
用戶名稱
|
data.createdBy.username | string |
由用戶名創建 |
|
電子郵件地址
|
data.createdBy.emailAddress | string |
由電子郵件地址建立 |
|
傳送日期
|
data.sentDate | string |
傳送日期 |
|
使用者識別碼
|
data.lastActionPerformedBy.userId | string |
使用者識別碼 |
|
使用者名
|
data.lastActionPerformedBy.userName | string |
使用者名 |
|
電子郵件地址
|
data.lastActionPerformedBy.emailAddress | string |
電子郵件地址 |
|
候選人編號
|
data.lastActionPerformedBy.candidateId | string |
候選人編號 |
|
參與者識別
|
data.lastActionPerformedBy.participantId | string |
參與者識別 |
|
於時間戳記處到期
|
data.expiryAndReminders.expiresAtTimestamp | string |
交易於時間戳記時到期 |
|
到期日
|
data.expiryAndReminders.expiryDays | integer |
到期日 |
|
提醒自己
|
data.expiryAndReminders.remindFromReminderDays | integer |
提醒自己 |
|
提醒時間
|
data.expiryAndReminders.remindFromReminderTime | string |
提醒時間 |
|
提醒頻率
|
data.expiryAndReminders.reminderFrequency | integer |
提醒頻率 |
|
參與者
|
data.participants | array of object |
參與者 |
|
參與者識別
|
data.participants.id | string |
參與者識別 |
|
參與者身份
|
data.participants.status | string |
參與者身份 |
|
最後更新日期
|
data.participants.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.participants.createdDate | string |
建立日期 |
|
參與者順序
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
簽署方式
|
data.participants.signingMethodDTO | array of string |
簽署方式細節 |
|
由使用者提交
|
data.participants.submittedBys | array of object |
由使用者資料提交 |
|
使用者識別碼
|
data.participants.submittedBys.userId | string |
由使用者ID提交 |
|
使用者名
|
data.participants.submittedBys.userName | string |
由使用者姓名提交 |
|
電子郵件地址
|
data.participants.submittedBys.emailAddress | string |
由使用者電子郵件地址提交 |
|
候選人編號
|
data.participants.submittedBys.candidateId | string |
候選人編號 |
|
候選人
|
data.participants.candidates | array of object |
候選人 |
|
候選人編號
|
data.participants.candidates.id | string |
候選人編號 |
|
名稱
|
data.participants.candidates.name | string |
候選人姓名 |
|
電子郵件地址
|
data.participants.candidates.emailAddress | string |
候選人電子郵件地址 |
|
語言
|
data.participants.candidates.language | string |
語言 |
|
類型
|
data.participants.candidates.type | string |
類型 |
|
行動
|
data.participants.candidates.action | string |
行動 |
|
行動日期
|
data.participants.candidates.actionDate | string |
行動日期 |
|
建立日期
|
data.participants.candidates.createdDate | string |
建立日期 |
|
認證模式值
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
認證模式值 |
|
簽署方法細節
|
data.participants.candidates.signingMethodDTO | array of string |
簽署方法細節 |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
傳遞管道
|
data.participants.candidates.deliveryChannels | array of string |
傳遞管道 |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
身份識別碼
|
data.participants.fields.id | string |
身份識別碼 |
|
最後更新日期
|
data.participants.fields.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.participants.fields.createdDate | string |
建立日期 |
|
欄位識別碼
|
data.participants.fields.fieldId | string |
欄位識別碼 |
|
頁碼
|
data.participants.fields.pageNo | integer |
頁碼 |
|
文件標識碼
|
data.participants.fields.documentId | string |
文件標識碼 |
|
場地寬度
|
data.participants.fields.width | float |
場地寬度 |
|
場地高度
|
data.participants.fields.height | float |
場地高度 |
|
工具提示
|
data.participants.fields.tooltip | string |
工具提示 |
|
價值觀
|
data.participants.fields.value | string |
價值觀 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
命名風格
|
data.participants.fields.nameStyle | string |
命名風格 |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
展示標籤
|
data.participants.fields.displayLabel | string |
展示標籤 |
|
連結類型
|
data.participants.fields.linkType | string |
連結類型 |
|
廣播本能
|
data.participants.fields.radioId | integer |
廣播本能 |
|
無線電組別編號
|
data.participants.fields.radioGroupId | string |
無線電組別編號 |
|
勾選框識別碼
|
data.participants.fields.checkboxId | integer |
勾選框識別碼 |
|
欄位名稱
|
data.participants.fields.fieldName | string |
欄位名稱 |
|
X 位置
|
data.participants.fields.xposition | float |
X 場的位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
場的 Y 位置 |
|
是必須的嗎？
|
data.participants.fields.required | boolean |
這是必填欄位嗎？ |
|
是只讀嗎？
|
data.participants.fields.readOnly | boolean |
這是只讀欄位嗎？ |
|
文字區域
|
data.participants.fields.textarea | boolean |
文字區域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
頂端 底層
|
data.participants.fields.topBottom | boolean |
頂端 底層 |
|
預設值
|
data.participants.fields.defaultValue | string |
預設值 |
|
格式
|
data.participants.signatureBlock.format | array of object |
格式 |
|
身份識別碼
|
data.participants.signatureBlock.format.id | string |
身份識別碼 |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
是必須的嗎？
|
data.participants.signatureBlock.format.required | boolean |
是必須的嗎？ |
|
預設
|
data.participants.signatureBlock.default | boolean |
預設 |
|
啟用代表
|
data.participants.enableDelegate | boolean |
啟用代表 |
|
自動製程
|
data.participants.autoProcess | boolean |
自動製程 |
|
CC 使用者
|
data.ccUsers | array of object |
CC 使用者 |
|
名稱
|
data.ccUsers.name | string |
名稱 |
|
電子郵件地址
|
data.ccUsers.emailAddress | string |
電子郵件地址 |
|
語言
|
data.ccUsers.language | string |
語言 |
|
Documents
|
data.documents | array of object |
Documents |
|
文件標識碼
|
data.documents.id | string |
文件標識碼 |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
檔案名稱
|
data.documents.fileName | string |
檔案名稱 |
|
頁數
|
data.documents.pageCount | integer |
頁數 |
|
可控訴嗎？
|
data.documents.deletable | boolean |
可控訴嗎？ |
|
是私人
|
data.documents.private | boolean |
是私人 |
|
自訂欄位
|
data.customFields | array of object |
自訂欄位 |
|
自訂欄位識別碼
|
data.customFields.customFieldId | string |
自訂欄位識別碼 |
|
欄位值
|
data.customFields.value | string |
欄位值 |
|
欄位名稱
|
data.customFields.fieldName | string |
欄位名稱 |
|
欄位類型
|
data.customFields.fieldType | string |
欄位類型 |
|
通知訂閱
|
data.notificationSubscriptions | array of |
通知訂閱 |
|
tags
|
data.tags | array of |
tags |
|
附加文件
|
data.additionalDocuments | array of object |
附加文件 |
|
身份識別碼
|
data.additionalDocuments.id | string |
身份識別碼 |
|
檔案名稱
|
data.additionalDocuments.fileName | string |
檔案名稱 |
|
類型
|
data.additionalDocuments.type | string |
類型 |
|
候選人編號
|
data.additionalDocuments.candidateId | string |
候選人編號 |
|
獨立協議
|
data.separateAgreements | boolean |
獨立協議 |
取得使用者資訊
取得特定使用者 ID 的使用者資料
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者識別碼
|
userId | True | string |
唯一使用者ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
名字
|
data.firstName | string |
名字 |
|
姓氏
|
data.lastName | string |
姓氏 |
|
公司
|
data.company | string |
公司 |
|
時區
|
data.timezone | string |
時區 |
|
語言
|
data.language | string |
語言 |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
職稱
|
data.jobTitle | string |
職稱 |
|
電話號碼
|
data.phoneNumber | string |
電話號碼 |
|
國碼 (地區碼)
|
data.phoneCountryCode | string |
國碼 (地區碼) |
|
角色
|
data.roles | array of string |
角色 |
|
最終郵件被停用了嗎？
|
data.finalMailDisabled | boolean |
最終郵件被停用了嗎？ |
|
提醒郵件被關閉了嗎？
|
data.reminderMailDisabled | boolean |
提醒郵件被關閉了嗎？ |
|
寄件人郵件被停用了嗎？
|
data.senderMailDisabled | boolean |
寄件人郵件被停用了嗎？ |
|
是整合使用者嗎？
|
data.integrationUser | boolean |
是整合使用者嗎？ |
|
Salutation
|
data.salutation | string |
Salutation |
|
是活躍的
|
data.active | boolean |
是活躍的 |
|
身份識別碼
|
data.id | string |
身份識別碼 |
|
電子郵件地址
|
data.emailAddress | string |
電子郵件地址 |
建立交易
建立交易
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易名稱
|
name | True | string |
交易名稱 |
|
Message
|
message | string |
給所有參與者的電子郵件訊息。 |
|
|
回調網址
|
url | string |
回調網址 |
|
|
交易事件
|
transactionEvents | array of string |
交易事件 |
|
|
參與活動
|
participantEvents | array of string |
參與活動 |
|
|
交易狀態
|
status | string |
交易狀態 |
|
|
外部識別碼
|
externalId | string |
外部識別碼 |
|
|
於時間戳記處到期
|
expiresAtTimestamp | string |
交易於時間戳記時到期 |
|
|
從時間戳記提醒
|
remindFromTimestamp | string |
從時間戳記提醒 |
|
|
提醒頻率
|
reminderFrequency | integer |
提醒頻率 |
|
|
預設欄位
|
default | boolean |
預設簽章區塊欄位 |
|
|
參與者順序
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
名稱
|
name | string |
候選人姓名 |
|
|
電子郵件地址
|
emailAddress | string |
候選人電子郵件地址 |
|
|
語言
|
language | string |
語言 |
|
|
驗證模式
|
authenticationMode | string |
驗證模式 |
|
|
認證模式值
|
authenticationModeValue | string |
認證模式值 |
|
|
傳遞管道
|
deliveryChannels | array of string |
傳遞管道 |
|
|
欄位識別碼
|
fieldId | string |
欄位識別碼 |
|
|
頁面
|
pages | array of string |
頁面 |
|
|
文件標識碼
|
documentId | string |
文件標識碼 |
|
|
場地寬度
|
width | float |
場地寬度 |
|
|
場地高度
|
height | float |
場地高度 |
|
|
工具提示
|
tooltip | string |
工具提示 |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
文字區域行數
|
textareaLineCount | string |
文字區域行數 |
|
|
欄位名稱
|
fieldName | string |
欄位名稱 |
|
|
X 位置
|
xposition | float |
X 場的位置 |
|
|
Y 位置
|
yposition | float |
場的 Y 位置 |
|
|
是必須的嗎？
|
required | boolean |
這是必填欄位嗎？ |
|
|
是只讀嗎？
|
readOnly | boolean |
這是只讀欄位嗎？ |
|
|
文字區域
|
textarea | boolean |
文字區域 |
|
|
頂端 底層
|
topBottom | boolean |
頂端 底層 |
|
|
垂直
|
vertical | boolean |
垂直 |
|
|
無線電組別編號
|
radioGroupId | string |
無線電組別編號 |
|
|
預設值
|
defaultValue | string |
預設值 |
|
|
價值觀
|
value | string |
價值觀 |
|
|
展示標籤
|
displayLabel | string |
展示標籤 |
|
|
名稱
|
name | string |
名稱 |
|
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
|
語言
|
language | string |
語言 |
|
|
文件標識碼
|
id | string |
文件標識碼 |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
可控訴嗎？
|
deletable | boolean |
可控訴嗎？ |
|
|
是私人
|
private | boolean |
是私人 |
|
|
欄位值
|
value | string |
欄位值 |
|
|
欄位名稱
|
fieldName | string |
欄位名稱 |
|
|
Code
|
code | string |
Code |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
交易識別碼
|
data.transactionId | string |
交易識別碼 |
建立使用者
建立使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
|
名字
|
firstName | string |
名字 |
|
|
姓氏
|
lastName | string |
姓氏 |
|
|
公司
|
company | string |
公司 |
|
|
時區
|
timezone | string |
時區 |
|
|
語言
|
language | string |
語言 |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
職稱
|
jobTitle | string |
職稱 |
|
|
電話號碼
|
phoneNumber | string |
電話號碼 |
|
|
國碼 (地區碼)
|
phoneCountryCode | string |
國碼 (地區碼) |
|
|
角色
|
roles | array of string |
角色 |
|
|
最終郵件被停用了嗎？
|
finalMailDisabled | boolean |
最終郵件被停用了嗎？ |
|
|
提醒郵件被關閉了嗎？
|
reminderMailDisabled | boolean |
提醒郵件被關閉了嗎？ |
|
|
寄件人郵件被停用了嗎？
|
senderMailDisabled | boolean |
寄件人郵件被停用了嗎？ |
|
|
是整合使用者嗎？
|
integrationUser | boolean |
是整合使用者嗎？ |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
使用者識別碼
|
data.user_id | string |
使用者識別碼 |
觸發程序
| 當交易狀態變更時 |
為特定交易事件註冊回調 |
當交易狀態變更時
為特定交易事件註冊回調
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件類型
|
eventType | True | array |
要註冊的交易事件類型 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間戳
|
timestamp | integer |
時間戳 |
|
狀態代碼
|
statusCode | integer |
狀態代碼 |
|
Message
|
message | string |
Message |
|
交易名稱
|
data.name | string |
交易名稱 |
|
交易狀態
|
data.status | string |
交易狀態 |
|
交易識別碼
|
data.transactionId | string |
交易識別碼 |
|
Message
|
data.mail.message | string |
給所有參與者的電子郵件訊息。 |
|
最後更新日期
|
data.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.createdDate | string |
建立日期 |
|
使用者識別碼
|
data.createdBy.id | string |
由使用者ID建立 |
|
用戶名稱
|
data.createdBy.username | string |
由用戶名創建 |
|
電子郵件地址
|
data.createdBy.emailAddress | string |
由電子郵件地址建立 |
|
傳送日期
|
data.sentDate | string |
傳送日期 |
|
使用者識別碼
|
data.lastActionPerformedBy.userId | string |
使用者識別碼 |
|
使用者名
|
data.lastActionPerformedBy.userName | string |
使用者名 |
|
電子郵件地址
|
data.lastActionPerformedBy.emailAddress | string |
電子郵件地址 |
|
候選人編號
|
data.lastActionPerformedBy.candidateId | string |
候選人編號 |
|
參與者識別
|
data.lastActionPerformedBy.participantId | string |
參與者識別 |
|
於時間戳記處到期
|
data.expiryAndReminders.expiresAtTimestamp | string |
交易於時間戳記時到期 |
|
到期日
|
data.expiryAndReminders.expiryDays | integer |
到期日 |
|
提醒自己
|
data.expiryAndReminders.remindFromReminderDays | integer |
提醒自己 |
|
提醒時間
|
data.expiryAndReminders.remindFromReminderTime | string |
提醒時間 |
|
提醒頻率
|
data.expiryAndReminders.reminderFrequency | integer |
提醒頻率 |
|
參與者
|
data.participants | array of object |
參與者 |
|
參與者識別
|
data.participants.id | string |
參與者識別 |
|
參與者身份
|
data.participants.status | string |
參與者身份 |
|
最後更新日期
|
data.participants.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.participants.createdDate | string |
建立日期 |
|
參與者順序
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
簽署方式
|
data.participants.signingMethodDTO | array of string |
簽署方式細節 |
|
由使用者提交
|
data.participants.submittedBys | array of object |
由使用者資料提交 |
|
使用者識別碼
|
data.participants.submittedBys.userId | string |
由使用者ID提交 |
|
使用者名
|
data.participants.submittedBys.userName | string |
由使用者姓名提交 |
|
電子郵件地址
|
data.participants.submittedBys.emailAddress | string |
由使用者電子郵件地址提交 |
|
候選人編號
|
data.participants.submittedBys.candidateId | string |
候選人編號 |
|
候選人
|
data.participants.candidates | array of object |
候選人 |
|
候選人編號
|
data.participants.candidates.id | string |
候選人編號 |
|
名稱
|
data.participants.candidates.name | string |
候選人姓名 |
|
電子郵件地址
|
data.participants.candidates.emailAddress | string |
候選人電子郵件地址 |
|
語言
|
data.participants.candidates.language | string |
語言 |
|
類型
|
data.participants.candidates.type | string |
類型 |
|
行動
|
data.participants.candidates.action | string |
行動 |
|
行動日期
|
data.participants.candidates.actionDate | string |
行動日期 |
|
建立日期
|
data.participants.candidates.createdDate | string |
建立日期 |
|
認證模式值
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
認證模式值 |
|
簽署方法細節
|
data.participants.candidates.signingMethodDTO | array of string |
簽署方法細節 |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
傳遞管道
|
data.participants.candidates.deliveryChannels | array of string |
傳遞管道 |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
身份識別碼
|
data.participants.fields.id | string |
身份識別碼 |
|
最後更新日期
|
data.participants.fields.lastUpdatedDate | string |
最後更新日期 |
|
建立日期
|
data.participants.fields.createdDate | string |
建立日期 |
|
欄位識別碼
|
data.participants.fields.fieldId | string |
欄位識別碼 |
|
頁碼
|
data.participants.fields.pageNo | integer |
頁碼 |
|
文件標識碼
|
data.participants.fields.documentId | string |
文件標識碼 |
|
場地寬度
|
data.participants.fields.width | float |
場地寬度 |
|
場地高度
|
data.participants.fields.height | float |
場地高度 |
|
工具提示
|
data.participants.fields.tooltip | string |
工具提示 |
|
價值觀
|
data.participants.fields.value | string |
價值觀 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
命名風格
|
data.participants.fields.nameStyle | string |
命名風格 |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
展示標籤
|
data.participants.fields.displayLabel | string |
展示標籤 |
|
連結類型
|
data.participants.fields.linkType | string |
連結類型 |
|
廣播本能
|
data.participants.fields.radioId | integer |
廣播本能 |
|
無線電組別編號
|
data.participants.fields.radioGroupId | string |
無線電組別編號 |
|
勾選框識別碼
|
data.participants.fields.checkboxId | integer |
勾選框識別碼 |
|
欄位名稱
|
data.participants.fields.fieldName | string |
欄位名稱 |
|
X 位置
|
data.participants.fields.xposition | float |
X 場的位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
場的 Y 位置 |
|
是必須的嗎？
|
data.participants.fields.required | boolean |
這是必填欄位嗎？ |
|
是只讀嗎？
|
data.participants.fields.readOnly | boolean |
這是只讀欄位嗎？ |
|
文字區域
|
data.participants.fields.textarea | boolean |
文字區域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
頂端 底層
|
data.participants.fields.topBottom | boolean |
頂端 底層 |
|
預設值
|
data.participants.fields.defaultValue | string |
預設值 |
|
格式
|
data.participants.signatureBlock.format | array of object |
格式 |
|
身份識別碼
|
data.participants.signatureBlock.format.id | string |
身份識別碼 |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
是必須的嗎？
|
data.participants.signatureBlock.format.required | boolean |
是必須的嗎？ |
|
預設
|
data.participants.signatureBlock.default | boolean |
預設 |
|
啟用代表
|
data.participants.enableDelegate | boolean |
啟用代表 |
|
自動製程
|
data.participants.autoProcess | boolean |
自動製程 |
|
CC 使用者
|
data.ccUsers | array of object |
CC 使用者 |
|
名稱
|
data.ccUsers.name | string |
名稱 |
|
電子郵件地址
|
data.ccUsers.emailAddress | string |
電子郵件地址 |
|
語言
|
data.ccUsers.language | string |
語言 |
|
Documents
|
data.documents | array of object |
Documents |
|
文件標識碼
|
data.documents.id | string |
文件標識碼 |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
檔案名稱
|
data.documents.fileName | string |
檔案名稱 |
|
頁數
|
data.documents.pageCount | integer |
頁數 |
|
可控訴嗎？
|
data.documents.deletable | boolean |
可控訴嗎？ |
|
是私人
|
data.documents.private | boolean |
是私人 |
|
自訂欄位
|
data.customFields | array of object |
自訂欄位 |
|
自訂欄位識別碼
|
data.customFields.customFieldId | string |
自訂欄位識別碼 |
|
欄位值
|
data.customFields.value | string |
欄位值 |
|
欄位名稱
|
data.customFields.fieldName | string |
欄位名稱 |
|
欄位類型
|
data.customFields.fieldType | string |
欄位類型 |
|
通知訂閱
|
data.notificationSubscriptions | array of |
通知訂閱 |
|
tags
|
data.tags | array of |
tags |
|
附加文件
|
data.additionalDocuments | array of object |
附加文件 |
|
身份識別碼
|
data.additionalDocuments.id | string |
身份識別碼 |
|
檔案名稱
|
data.additionalDocuments.fileName | string |
檔案名稱 |
|
類型
|
data.additionalDocuments.type | string |
類型 |
|
候選人編號
|
data.additionalDocuments.candidateId | string |
候選人編號 |
|
獨立協議
|
data.separateAgreements | boolean |
獨立協議 |
定義
檔案
這是基本資料類型「檔案」。