Connective eSignatures
Connective eSignatures 是一种著名的数字签名解决方案,提供大量签名方法和符合最严格的(间)国家法规。 eSignatures 允许你将任何基于纸张的过程转换为具有无与伦比的用户体验的端到端数字流。 简化签名过程,并直接从你喜欢的业务应用程序发送和发送、签名和跟踪所有类型的文档。 加入超过 500 个满意的客户。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 连接支持 |
| URL | https://connective.eu/contact-support/ |
| service@connective.eu |
| 连接器元数据 | |
|---|---|
| 发布者 | 连接 |
| 网站 | https://www.connective.eu |
| 隐私策略 | https://connective.eu/privacy-policy/ |
| 类别 | IT作;生产力 |
Connective 是数字签名、标识服务和智能文档生成方面的专家,它使适用于 Power Automate 的 Connective eSignatures 连接器可供使用。 连接器允许公司直接从自己喜欢的 Microsoft 365 个应用程序(从 Microsoft Teams 到 Word、SharePoint、Dynamics、OneDrive 等)转发需要数字签名的文档。
如何开始使用连接器
若要开始使用连接器,请在 Connective 联系关系经理,或转到网站上的 联系人页面 来接收凭据。
本页将进一步详细说明可用的不同作,并提供有关这些作的不同实现方式的见解。
请毫不犹豫地查看 我们的文档网站 ,了解详细信息,或通过 支持联系人表单 或支持邮箱联系支持团队: service@connective.eu
术语 表 可用于说明本文档中使用的不同术语
行动
Connective eSignatures 连接器基于 eSignatures 的 API v3。 eSignatures API 是一个 REST API,允许外部应用程序与本文档中列出的功能集成并使用这些功能来创建和管理签名流。
可用作可以分组到不同的组中
| 作组 | 可用操作 |
|---|---|
| 上传文档 | 创建包 |
| 将文档添加到包 | |
| 获取签名位置 | |
| 设置进程信息 | |
| 设置包状态 | |
| 创建即时包 | |
| 检索文档的状态 | 获取包状态 |
| 获取包列表 | |
| 其他作 | 跳过签名者 |
| 下载包 | |
| 程序包到期扩展 | |
| 发送包提醒 | |
| 删除包 | |
| 检索审核证明 | 检索包审核证明 |
| 检索文档审核证明 | |
| 使用关联 ID 检索包审核证明 | |
| 使用关联 ID 检索文档审核证明 | |
| 从外部源添加校对 |
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| Connective eSignatures 环境 URL | 字符串 | Connective eSignatures 环境的 URL,例如esignatures.connective.eu | True |
| API 用户名 | securestring | 用于访问 API 的 API 用户名 | True |
| API 密码 | securestring | 用于访问 API 的 API 密码 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 下载包 |
使用此调用,外部系统可以下载包含已签名文档的包。 |
| 从包下载文档 |
可以使用此调用逐个下载包中的已签名文档。 每个文档将下载为 PDF 或 XML 文件流,具体取决于 DocumentType 参数的值。 |
| 从外部源添加校对 |
此调用允许 API 用户将外部源的额外校对添加到文档上的某个位置。 |
| 创建包 |
此调用将创建一个空包,允许向其中添加文档 |
| 创建即时包 |
此调用将创建包含单个文档的包,并立即准备用于签名的包 |
| 删除包 |
eSignatures 在达到最终状态后不会自动从数据库中删除包。 它们无限期存储。 若要从数据库中删除包,用户可以使用“删除包”调用。 |
| 到期时间戳 |
当包在创建包调用中传递 ExpiryTimestamp 参数的值时,包的状态可能已过期。 无法再对此类包进行签名。 |
| 包列表 |
获取其当前状态的包列表 |
| 包含文档 ID 的包审核证明 |
当包完全签名时,可以检索包的审核证明 xml。 这同样适用于文档:仅当包含包已完全签名时,它才有效。 |
| 包审核证明 |
当包完全签名时,可以检索包的审核证明 xml。 这同样适用于文档:仅当包含包已完全签名时,它才有效。 |
| 包相关审核证明下载 |
关联 ID 用于跟踪通过 eSignatures 应用程序的多个传递的包或文档。 |
| 发送程序包提醒 |
公司策略可能要求在给定时间跨度内处理文档。 触发“发送提醒”呼叫将查找尚未签名并向其发送额外通知的每个人提醒。 |
| 将文档添加到包 |
此调用会将文档添加到现有包。 |
| 文档相关审核证明下载 |
关联 ID 用于跟踪通过 eSignatures 应用程序的多个传递的包或文档。 |
| 获取包状态 |
检索包及其文档的当前状态。 |
| 获取签名位置 |
此调用概述了包内文档内的所有签名位置。 |
| 设置包状态 |
通过“设置包状态”调用,可以更改包的状态。 |
| 设置进程信息 |
此 Webservice 方法更新流程中涉及的人员(利益干系人),并分配需要执行的步骤。 |
| 跳过签名者 |
此调用将跳过尚未签名的所有签名者,并将其状态设置为“已跳过”,这将导致完整包标记为“已完成”。 |
下载包
从包下载文档
可以使用此调用逐个下载包中的已签名文档。 每个文档将下载为 PDF 或 XML 文件流,具体取决于 DocumentType 参数的值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
签名包的唯一 ID
|
id | True | string |
签名包的唯一 ID |
|
包中包含的文档的唯一 ID
|
documentId | True | string |
包中包含的文档的唯一 ID |
返回
- response
- binary
从外部源添加校对
此调用允许 API 用户将外部源的额外校对添加到文档上的某个位置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
packageId | True | string |
包的唯一 ID |
|
Content
|
Content | string |
证明的实际内容。 |
|
|
LocationId
|
LocationId | string |
为其生成证明内容的签名的位置。 |
|
|
Name
|
Name | string |
证明的名称。 |
|
|
类型
|
Type | string |
计算机可读的“type”键。 可以自由选择。 |
|
|
Description
|
Description | string |
对校对证据的简要可读说明。 |
|
|
IP地址
|
IpAddress | string |
为其添加了证据的外部源的最终用户的 IP 地址。 |
创建包
此调用将创建一个空包,允许向其中添加文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
Initiator
|
Initiator | string |
已注册用户的电子邮件地址。 |
|
|
PackageName
|
PackageName | string |
包名称,显示在 eSignatures 门户中,下载为 zip 文件时。 |
|
|
CallBackUrl
|
CallBackUrl | string |
每次完成此包的作时都会调用的 REST API URL。 |
|
|
CorrelationId
|
CorrelationId | string |
指示哪些包相关 ID。 |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
标识应在其中显示包的文档组的“代码”。 |
|
|
ThemeCode
|
ThemeCode | string |
必须应用于包的主题 |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
此参数确定在签名之前是否可以从 WYSIWYS 下载包。 |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
此参数确定是否可以将包从 WYSIWYS 重新分配给另一个审批者/签名者。 |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
此参数确定在不使用作 URL 时必须过期多少天。 |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
此包过期且无法再签名的日期和时间。 |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
调用应用程序提供的引用。 eSignatures 门户不会使用此参数。 |
|
|
ExternalPackageData
|
ExternalPackageData | string |
此字段保留供将来使用。 它可用于客户特定的扩展来与第三方服务(如借记卡签名)集成。 |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
使用“面对面”签名或拒绝所有字段后,最终用户将重定向到的 URL。 |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
在最终用户请求通知时调用的 REST API URL。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
PackageId
|
PackageId | string |
包的唯一标识符。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根据服务器创建包的日期和时间。 |
创建即时包
此调用将创建包含单个文档的包,并立即准备用于签名的包
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档
|
Document | byte |
以 base64 编码格式附加的文档。 除非使用多部分格式,否则是必需的。 |
|
|
DocumentLanguage
|
DocumentLanguage | string |
签名文本中使用的语言。 当前支持:en、nl、de、fr、es。 |
|
|
文档名称
|
DocumentName | string |
要显示在 eSignatures 门户中的文档和包的名称。 |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
已注册用户的电子邮件地址 |
|
|
类型
|
Type | string |
签名者/接收方 |
|
|
OrderIndex
|
OrderIndex | integer |
此数字指定执行组件执行其作的顺序。 |
|
|
PageNumber
|
PageNumber | integer |
要在其中添加签名位置的页码 |
|
|
宽度
|
Width | string |
宽度 |
|
|
高度
|
Height | string |
高度 |
|
|
Left
|
Left | string |
页面左侧的位置 |
|
|
Top
|
Top | string |
页面顶部的位置 |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
对签名字段、文本标记或文本字段的唯一引用。 |
|
|
SigningType
|
SigningType | string |
此执行组件的会话中使用的签名类型。 |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
一个或多个承诺类型的 OID。 只能在使用签名策略时传递。 |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
在 eID 其他智能卡或其me 签名会话期间要执行的验证类型。 |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
定义在此会话期间允许哪些 eID 或其他智能卡进行签名。 |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
签名策略详细信息。 |
|
|
Phonenumber
|
Phonenumber | string |
用于接收短信 OTP 的电话号码。 |
|
|
RedirectUrl
|
RedirectUrl | string |
签名后最终用户重定向到的 URL。 |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures 可以向允许签名的所有人员发送电子邮件。 |
|
|
UserRoles
|
UserRoles | array of string |
签名者的角色或函数。 |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
法律声明 |
|
|
LegalNoticeText
|
LegalNoticeText | string |
自定义法律声明文本(如果三个预定义的法律声明均不适用)。 |
|
|
电子邮件地址
|
EmailAddress | string |
电子邮件地址 |
|
|
名字
|
FirstName | string |
名字 |
|
|
姓
|
LastName | string |
姓 |
|
|
BirthDate
|
BirthDate | string |
BirthDate |
|
|
语言
|
Language | string |
语言 |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
每次完成此包的作时都会调用的 REST API URL |
|
|
CorrelationId
|
CorrelationId | string |
指示哪些包或文档相关 ID |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
标识应在其中显示文档的文档组的“代码” |
|
|
ThemeCode
|
ThemeCode | string |
必须应用于包的主题 |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
此参数确定在签名之前是否可以从 WYSIWYS 下载包 |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
此参数确定是否可以将包从 WYSIWYS 重新分配给另一个审批者/签名者。 |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
此参数确定在不使用作 URL 时必须过期多少天。 |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
调用应用程序提供的引用。 eSignatures 门户不会使用此参数 |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
调用应用程序提供的引用,eSignatures 门户不会使用此参数 |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
调用应用程序提供的引用,eSignatures 门户不会使用此参数 |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
使用“面对面”签名或拒绝所有字段后,最终用户将重定向到的 URL。 |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
在最终用户请求通知时调用的 REST API URL。 如果未提供任何 URL,则不执行回叫 |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
如何处理包含轻微缺陷的 PDF |
|
|
表示法
|
Representation | string |
base64 格式的附加表示形式文档 |
|
|
RepresentationType
|
RepresentationType | string |
填充表示形式时,必须存在表示文档的类型。 仅支持“application/pdf”。 |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
门户中配置的模板将提供所有必要的信息 |
|
|
目标类型
|
TargetType | string |
TargetType 定义在签名之前是否需要执行到 PDF/A 的额外转换 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
PackageId
|
PackageId | string |
包的唯一标识符。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根据服务器创建包的日期和时间。 |
删除包
eSignatures 在达到最终状态后不会自动从数据库中删除包。 它们无限期存储。 若要从数据库中删除包,用户可以使用“删除包”调用。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
id | True | string |
包的唯一 ID |
到期时间戳
当包在创建包调用中传递 ExpiryTimestamp 参数的值时,包的状态可能已过期。 无法再对此类包进行签名。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
id | True | string |
包的唯一 ID |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
包列表
获取其当前状态的包列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
要知道要返回的页面的继续标记/guid。
|
ContinuationToken | string |
要知道要返回的页面的继续标记/guid。 必须为 EMPTY 或从 PREVIOUS 调用返回的令牌。 |
|
|
获取或设置最大数量。
|
MaxQuantity | integer |
获取或设置最大数量。 |
|
|
获取或设置排序字段。
|
SortField | string |
获取或设置排序字段。 |
|
|
获取或设置排序字段。
|
SortOrder | string |
获取或设置排序字段。 |
|
|
获取或设置在日期之前创建的日期。
|
CreatedBeforeDate | string |
获取或设置在日期之前创建的日期。 |
|
|
获取或设置状态。
|
Status | string |
获取或设置状态。 |
|
|
获取或设置在日期后创建的日期。
|
createdAfterDate | string |
获取或设置在日期后创建的日期。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ContinuationToken(续传令牌)
|
ContinuationToken | string |
ContinuationToken(续传令牌) |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
物品
|
Items | array of Package |
包含文档 ID 的包审核证明
当包完全签名时,可以检索包的审核证明 xml。 这同样适用于文档:仅当包含包已完全签名时,它才有效。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
packageId | True | string |
包的唯一 ID |
|
文档的唯一 ID
|
documentId | True | string |
文档的唯一 ID |
返回
- Body
- Content
包审核证明
当包完全签名时,可以检索包的审核证明 xml。 这同样适用于文档:仅当包含包已完全签名时,它才有效。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
packageId | True | string |
包的唯一 ID |
返回
- Body
- Content
包相关审核证明下载
关联 ID 用于跟踪通过 eSignatures 应用程序的多个传递的包或文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
相关标识符。
|
correlationId | True | string |
相关标识符。 |
返回
- Body
- Content
发送程序包提醒
公司策略可能要求在给定时间跨度内处理文档。 触发“发送提醒”呼叫将查找尚未签名并向其发送额外通知的每个人提醒。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
PackageId | True | string |
包的唯一 ID |
将文档添加到包
此调用会将文档添加到现有包。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包标识符。
|
PackageId | True | string |
包唯一 ID |
|
文档
|
Document | string |
以 base64 编码格式附加的文档。 |
|
|
DocumentLanguage
|
DocumentLanguage | string |
签名文本中使用的语言。 |
|
|
文档名称
|
DocumentName | string |
要显示在 eSignatures 门户中的文档的名称。 |
|
|
PageNumber
|
PageNumber | integer |
要在其中添加签名位置的页码 |
|
|
宽度
|
Width | string |
宽度 |
|
|
高度
|
Height | string |
高度 |
|
|
Left
|
Left | string |
页面左侧的位置 |
|
|
Top
|
Top | string |
页面顶部的位置 |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
对签名字段、文本标记或文本字段的唯一引用。 |
|
|
CorrelationId
|
CorrelationId | string |
指示此包中的哪些文档与其他包中过去签名的文档相关 ID。 |
|
|
文档类型
|
DocumentType | string |
要签名的文档的类型。 |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
调用应用程序提供的引用。 |
|
|
ErrorCode
|
ErrorCode | string |
包含变量信息的错误代码。 |
|
|
Message
|
Message | string |
错误消息详细信息文本,未本地化 |
|
|
表示法
|
Representation | string |
以 base64 格式附加的表示形式文档。 这必须是 PDF 数据。 |
|
|
RepresentationType
|
RepresentationType | string |
表示形式文档的类型。 |
|
|
目标类型
|
TargetType | string |
TargetType 定义是否需要在签名之前完成对 PDF/A 的额外转换。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
文档的唯一 ID |
|
CreationTimestamp
|
CreationTimestamp | string |
流的创建日期和时间。 格式:YYYY-MM-DDThh:mm:ss+zz:zz |
|
位置
|
Locations | array of object |
表示签名的可能位置 |
|
Id
|
Locations.Id | string |
此位置的唯一 ID |
|
标签
|
Locations.Label | string |
检测到或指定标签 |
|
PageNumber
|
Locations.PageNumber | integer |
找到位置的页面。 |
文档相关审核证明下载
关联 ID 用于跟踪通过 eSignatures 应用程序的多个传递的包或文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
相关标识符。
|
correlationId | True | string |
相关标识符。 |
返回
- Body
- Content
获取包状态
检索包及其文档的当前状态。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
签名包的唯一 ID
|
Id | True | string |
签名包的唯一 ID |
返回
显示为 eSignatures 门户用户的包的说明作为文件名。
- Body
- PackageStatus
获取签名位置
此调用概述了包内文档内的所有签名位置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
签名字段的 ID
|
Id | True | string |
签名字段的 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文档
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
文档的唯一 ID |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
用于标识的外部参考。 请确保使用唯一值。 |
|
位置
|
Documents.Locations | array of object |
表示签名的可能位置 |
|
Id
|
Documents.Locations.Id | string |
此位置的唯一 ID。 |
|
标签
|
Documents.Locations.Label | string |
输入为 Request 参数的值。 |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
可找到签名的页码。 |
设置包状态
通过“设置包状态”调用,可以更改包的状态。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
签名包的唯一 ID
|
Id | True | string |
签名包的唯一 ID |
|
状态
|
Status | string |
挂起/撤销 |
返回
显示为 eSignatures 门户用户的包的说明作为文件名。
- Body
- PackageStatus
设置进程信息
此 Webservice 方法更新流程中涉及的人员(利益干系人),并分配需要执行的步骤。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
id | True | string |
包的唯一 ID |
|
类型
|
Type | string |
类型 |
|
|
OrderIndex
|
OrderIndex | string |
此数字指定执行组件执行其作的顺序。 |
|
|
LocationIds
|
LocationIds | array of string |
此人必须放置签名的位置 ID。 |
|
|
SigningType
|
SigningType | string |
此执行组件的会话中使用的签名类型。 |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
一个或多个承诺类型的 OID。 只能在使用签名策略时传递。 |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
在 eID 其他智能卡或其me 签名会话期间要执行的验证类型。 |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
定义在此会话期间允许哪些 eID 或其他智能卡进行签名。 |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
签名策略详细信息。 |
|
|
Phonenumber
|
Phonenumber | string |
用于接收短信 OTP 的电话号码。 |
|
|
RedirectURL
|
RedirectURL | string |
在签名或拒绝后,最终用户重定向到的 URL。 重定向在签名或拒绝后立即发生。 |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures 可以向需要其作的执行组件发送电子邮件,例如签名 |
|
|
UserRoles
|
UserRoles | array of string |
此人必须放置签名的位置 ID。 |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
3 个值将指向应用程序中内置的 3 个法律声明。 可以在配置索引中更改这些更改。 |
|
|
LegalNoticetext
|
LegalNoticetext | string |
自定义法律声明文本(如果三个预定义的法律声明均不适用) |
|
|
电子邮件地址
|
EmailAddress | string |
电子邮件地址 |
|
|
名字
|
FirstName | string |
名字 |
|
|
语言
|
Language | string |
此利益干系人的 UI 语言。 当前支持:en、nl、de、fr、es。 |
|
|
姓
|
LastName | string |
姓氏 |
|
|
BirthDate
|
BirthDate | string |
出生日期格式:YYYY-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
调用应用程序提供的引用。 eSignatures 门户不会使用此参数。 |
跳过签名者
此调用将跳过尚未签名的所有签名者,并将其状态设置为“已跳过”,这将导致完整包标记为“已完成”。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
包的唯一 ID
|
PackageId | True | string |
包的唯一 ID |
定义
Package
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
包中每个文档的详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
文档的唯一 ID |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
返回此文档的外部引用,因为它通过“添加文档到包”调用传递。 |
|
文档名称
|
DocumentName | string |
文档的名称 |
|
文档类型
|
DocumentType | string |
包中的文档类型。 |
PackageStatus
显示为 eSignatures 门户用户的包的说明作为文件名。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
PackageName
|
PackageName | string |
显示为 eSignatures 门户用户的包的说明作为文件名。 |
|
CreationTimestamp
|
CreationTimestamp | string |
根据服务器创建包的日期和时间。 |
|
Initiator
|
Initiator | string |
在创建时传入包的发起程序字段。 |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
文档过期的 UTC 格式时间。 可以为 null。 |
|
ExternalPackageReference
|
ExternalPackageReference | string |
返回包在创建时传入时的外部引用 ID。 |
|
F2FSigningUrl
|
F2FSigningUrl | string |
链接到允许同时从所有签名会话中选取的包。 |
|
PackageStatus
|
PackageStatus | string |
整个包的状态: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
包中每个文档的详细信息。 |
|
利益干系人
|
Stakeholders | array of object |
与包交互的每个人员的详细信息。 |
|
类型
|
Stakeholders.Type | string |
利益干系人类型:Person、PersonGroup 或 ContactGroup。 |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
人员组的名称。 仅在请求中将 Type 设置为 PersonGroup 时返回。 |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
联系人组的代码。 仅在请求中将 Type 设置为 ContactGroup 时返回。 |
|
电子邮件地址
|
Stakeholders.EmailAddress | string |
签名者的电子邮件地址。 |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
在外部系统中标识此人的外部引用。 |
|
StakeholderId
|
Stakeholders.StakeholderId | string |
唯一 ID。 |
|
Actors
|
Stakeholders.Actors | array of object |
要执行的所有步骤的详细信息。 |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
此作、利益干系人和文档组合的唯一 ID。 |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
此人可以打开的 URL 以与包交互。 |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
PersonGroup 或 ContactGroup 的不同人员可以打开的 URL 数组,以便与包进行交互。 |
|
电子邮件地址
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
此人的电子邮件地址。 |
|
网址
|
Stakeholders.Actors.ActionUrls.Url | string |
此人可以打开的 URL 以与包交互。 |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
草稿 (包状态为草稿) |
|
类型
|
Stakeholders.Actors.Type | string |
签名者/接收方 |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
完成作的最终用户的名称。 |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
完成此作的时刻的时间戳。 |
|
原因
|
Stakeholders.Actors.Reason | string |
返回将包状态更改为最终状态(例如拒绝)的人员输入的文本。 |
|
位置
|
Stakeholders.Actors.Locations | array of object |
表示签名的可能位置。 |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
此位置的唯一 ID |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
返回用于对文档进行签名的签名类型。 |
Content
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
上传
|
uploads | array of object | |
|
上传
|
uploads.upload | array of object | |
|
开始
|
uploads.upload.start | date-time | |
|
end
|
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 | |
|
locationId
|
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”。