通过

Lex Power Sign （预览版）

Lex Persona 是一家欧洲合格的信托服务提供商，提供一系列电子签名解决方案。 借助 Lex Enterprise，你可以访问所有 eIDAS 签名级别以及大量签名者身份验证方法。 您的签名书籍嵌入到数字工作流中。 自动连接 Lex Enterprise 和所有工具，以消除重复任务、提高效率并加速业务。

此连接器在以下产品和区域中可用：

服务 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 Lex 角色支持
URL https://support.lex-persona.com
Email support@lex-persona.com
连接器元数据
发布者 Lex 角色
网站 https://www.lex-persona.com
隐私策略 https://www.lex-persona.com/politique-de-confidentialite/
类别 人工智能;网站

Lex Persona 是一家欧洲合格的信托服务提供商，提供一系列电子签名解决方案。 使用此连接器，可以轻松地将电子签名功能添加到基于Microsoft的应用程序（PowerApp、基于 .NET 的 Web 应用、Dynamics...）和环境（Outlook、Sharepoint、Teams...）。连接器由 Lex Enterprise 工作流管理器提供支持。 可以创建由不同类型的步骤组成的电子签名工作流，这些步骤可以按顺序和/或并行执行。 连接器支持所有 eIDAS 签名级别，并提供各种签名者身份验证方法（OTP、SSO、France Connect、Identité Numérique La Poste、硬件令牌...）

先决条件

需要满足以下条件才能继续作：

  • Lex Enterprise 订阅。 使用试用计划进行测试

环境要求如下：

  • 具有自定义连接器功能的Microsoft Power Apps 或 Power Automate 计划
  • Power Platform CLI 工具

如何获取凭据

请联系我们的销售代表， commercial@lex-persona.com 获取试用系统上的 Lex Enteprise 订阅或帐户。

使用帐户连接到 Lex Enterprise 门户，并生成 API 密钥。

连接器入门

首先，为连接器创建连接。 将身份验证方法设置为 API 密钥，提供 API 密钥（“Bearer act_XXXXXXX”），并指定 API 密钥必须放置在 API 调用的 Autrorization 标头中。

创建简单签名工作流的步骤如下：

  • 在 tigger 之后，使用 “检索我 ”作检索连接的 Lex Enterprise 用户 ID（需要此 ID 才能创建工作流）
  • 使用搜索许可页action_搜索同意页。 可以使用 文本 参数按名称搜索许可页（许可页定义签名级别并在 Lex Enterprise 环境中预配置）
  • 使用 “创建工作流 ”作创建签名工作流。 在此步骤中，必须提供签名者的信息。
  • 使用 “搜索签名配置文件”作搜索签名配置文件。 可以使用 文本 参数按名称搜索签名配置文件（签名配置文件控制同意页面行为的一些方面）。例如，强制签名者滚动到文档底部，
  • 从环境检索文档（Sharepoint、Outlook、OneDrive...）
  • 使用 “创建部件 ”作将文档添加到工作流，将 createDocument 参数设置为 true
  • 使用“更新”工作流作启动工作流，将工作流状态设置为“已启动”

请注意： 默认情况下，连接器与试用服务器配对。 如果要将连接器与自己的租户配对，则必须在连接器的安全定义或 apiDefinitions.json 文件中更改主机 URL：

-   "host": "yourtenant.lexpersona.com",

了解问题和限制

创建文档作接受其有效负载中的文档部件列表。 但是，如果提供多个部分，则只会考虑第一个部分（这是因为 API 中存在 bug）。将在下一版本中修复连接器。

因此，如果要向工作流添加多个文档，则必须对 Create 部件 执行调用，并将 createDocument 参数设置为 true，以便为每个文档设置 true 。

常见错误和补救措施

对于 API 调用失败，API 调用响应包含连接器运行历史记录中显示的全面错误消息。 该消息还包含日志 ID，因此，如果需要有关错误的详细信息，可以连接到 Lex Enteprise 门户并查阅服务器日志文件。 交替者，你可以设置 Postman 请求来搜索我们的服务器日志（plase 咨询文档： https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs） 。

API 返回的较常见的 HTTP 错误代码如下：

  • 错误 400 - 错误请求。 请求付款中存在问题。 查阅日志以查找有关错误原因的信息
  • 错误 401 - 未授权。 Yo 没有执行此作的访问权限。 检查 Lex 角色用户访问权限
  • 错误 403 - 禁止访问。 API 密钥已嵌入或禁用
  • 错误 404 - 找不到。 请求 URL 中存在错误

还可以查看我们的文档，详细了解每个 API 调用可能的错误代码（https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html）

FAQ

连接器支持的文档格式是什么

可以发送签名的文档可以包含 pdf、docx、pptx 和 xlsx 格式。 如果需要，连接器会将文档转换为 pdf，签名将采用 PAdES 格式。

还可以对 XML 文档进行签名。 在这种情况下，不会应用任何转换，签名将采用 XAdES 格式。

还可以上传 zip 文件。 连接器将解压缩存档并将每个文档添加到工作流。

还可以向签名工作流添加附件。 附件未签名，可以采用任何格式。

文档可以有多个签名者

是的。 文档的签名者数量不受限制。

是否可以同时对多个文档进行签名

是的。 可以将多个文档添加到工作流，并且所有文档都将同时签名。 但请注意，在这种情况下，文档集将进行司法链接，并且系统将生成唯一的证据文件。

还可以创建同一签名者的 mutlpiple workglows。 在签名时，文档列表将呈现给签名者，签名者将有机会选择她鞭打签名的文档。 在这种情况下，文档将独立，每个文档将生成证据文件。

是否可以脱机对文档进行签名

否。 访问许可页需要一个 intenet 连接。

是否可以向签名者发送自动签名代理

是的。 可以配置提醒期和要发送的最大提醒数。

是否可以修改已启动的签名工作流

是的。 在任何签名之前，可以修改工作流中的任何内容。 第一个签名后，无法修改文档，但仍可以修改工作流步骤。

一次性密码的有效性持续时间是什么

一次性密码有效期为两分钟（在同意页面上显示 countdow）。

是否可以验证电子签名有效性

可以使用 Adobe Acrobat 的 “签名”窗格 检查 pdf 文档中包含的签名的有效性。 或者，可以使用受信任的签名验证 Web 服务（https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation 例如）

什么是 Lex 角色文档存储条件

默认情况下，我们将文档保留服务器中的证据文件。 Tou 可以随时搜索和下载文档。 如果已请求，我们可以从服务器中以原始方式删除文档。

Lex 角色是否保留时间戳令牌

否。 我们不会保留时间戳令牌。 如果需要，可以从已签名的文档中附加这些令牌。

签名文档是否有取款期

是的。 提取依据取决于适用于文档的法律条件。

是否可以取消签名工作流

是的。 授权用户可以随时取消已启动的签名工作流。 不会生成任何授权文件，如果文档已由一个或多个签名者签名，则会失效。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥 securestring 此 API 的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

下载工作流文档

下载工作流文档
下载证据文件

下载工作流证据文件
创建元数据布局

创建元数据布局
创建工作流

创建工作流
创建文档

从预先创建的部件创建文档
创建签名配置文件

创建签名配置文件
创建联系人

将联系人添加到当前用户的联系人列表
创建部件

创建文档部件
删除工作流

删除工作流
删除文档

删除文档
删除联系人

从当前用户的 contects 列表中删除联系人
搜索元数据布局

搜索工作流布局
搜索工作流

搜索工作流
搜索文档

搜索文档
搜索签名配置文件

搜索签名配置文件
搜索联系人

搜索联系人
搜索许可页

搜索许可页
更新元数据布局

更新元数据布局
更新工作流

更新工作流
更新文档

更新文档
更新签名配置文件

更新签名配置文件
更新联系人

修改现有联系人信息
检索元数据布局

检索工作流布局
检索元数据映射

检索指定租户的元数据映射
检索工作流

从工作流 ID 检索工作流
检索常量页 URL

创建和检索收件人的同意页面 URL
检索我

检索连接的用户 ID
检索文档

检索文档
检索签名配置文件

检索签名配置文件
检索联系人

从联系人 ID 检索联系人信息
检索许可页

从许可页 ID 检索许可页信息

下载工作流文档

操作 ID:
DownloadDocuments

下载工作流文档

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

工作流的 ID

返回

response
binary

下载证据文件

操作 ID:
WorkflowEvidences

下载工作流证据文件

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

工作流的 ID
接受
 Accept True string

接受

返回

response
binary

创建元数据布局

操作 ID:
CreateLayout

创建元数据布局

参数

名称 密钥 必需 类型 说明
租户 ID
 tenantId True string

布局的 ID
内容类型
 Content-Type True string

Content-Type
Name
 name True string

布局名称
已禁用
 isDisabled boolean

如果设置为 true，将禁用布局
槽
 slot string

元数据项（data1 到 data8）
默认
 default string

此布局中的元数据默认值
optional
 optional boolean

如果为 true，则提供值不是必需的
只读
 readonly boolean

可以重写该值
rememberLastValue
 rememberLastValue boolean

如果设置为 true，则该值会跨工作流保留

返回

元数据布局

Body
layout

创建工作流

操作 ID:
CreateWorkflow

创建工作流

参数

名称 密钥 必需 类型 说明
用户 ID
 userId True string

工作流拥有者的用户 ID
内容类型
 Content-Type string

内容类型
Name
 name True string

工作流的名称
Description
 description string

工作流的说明
id
 id string

步骤 ID
stepType
 stepType string

签名或审批
consentPageId
 consentPageId True string

与此收件人关联的同意页（签名级别）的 ID
电子邮件
 email True string

收件人的电子邮件
userId
 userId string

引用 LE 用户，而不是动态创建收件人
电话号码
 phoneNumber string

reicpient 的手机号
firstName
 firstName string

收件人的名字
lastName
 lastName string

收件人的姓氏
country
 country string

收件人的国家/地区代码
preferredLocale
 preferredLocale string

recipient 的区域设置代码
organizationId
 organizationId string

收件人 LE 组织的 ID
requiredRecipients
 requiredRecipients number

必须签名才能执行下一步的最小签名者数
validityPeriod
 validityPeriod number

步骤有效期
inviteperiod
 inviteperiod number

签名提醒频率
maxInvites
 maxInvites number

签名提醒的最大数目
sendDownloadLink
 sendDownloadLink boolean

控制已签名文档的传送给签名者
allowComments
 allowComments boolean

允许/禁止在此步骤中注释
hideAttachments
 hideAttachments boolean

控制对签名者的附件的显示
hideWorkflowRecipients
 hideWorkflowRecipients boolean

控制向签名者显示其他签名者
通知事件
 notifiedEvents array of string

通知工作流事件
userId
 userId string

观察程序的用户 ID
notifiedEvents
 notifiedEvents array of string

将通知给此观察程序的工作流事件
电子邮件
 email string

观察程序的电子邮件
模板 ID
 templateId string

工作流从中派生的模板的 ID
布局 ID
 layoutId string

工作洛使用的元数据布局
data1
 data1 string

第一个元数据
data2
 data2 string

第二个元数据
data3
 data3 string

第三个元数据
data4
 data4 string

第四个元数据
data5
 data5 string

第五个元数据
data6
 data6 string

第六个元数据
data7
 data7 string

第七个元数据
data8
 data8 string

Heighth 元数据

返回

Body
workflow

创建文档

操作 ID:
CreateDocument

从预先创建的部件创建文档

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

相关工作流的 ID
内容类型
 Content-Type True string

Content-Type
内容类型
 contentType string

内容类型
filename
 filename string

filename
哈希
 hash string

哈希
size
 size integer

size
signatureProfileId
 signatureProfileId string

本文档的签名配置文件

返回

Body
document

创建签名配置文件

操作 ID:
CreateSignatureProfile

创建签名配置文件

参数

名称 密钥 必需 类型 说明
租户 ID
 tenantId True string

租户的 ID
内容类型
 Content-Type True string

Content-Type
为默认值
 isDefault True string

将此签名配置文件设为默认的签名配置文件
已禁用
 isDisabled string

禁用此签名配置文件
Name
 name True string

签名配置文件名称
文档类型
 documentType True string

pdf， xml， word， excel， powerpoint， 其他
签名类型
 signatureType True string

pades，xades，xadesDetached，xadesDetachedManifest，cades，helios
强制滚动到文档底部
 forceScrollDocument True boolean

强制签名者滚动到文档底部
可见签名模式
 pdfVisibleSignatureMode string

可见签名模式（允许、禁用、noImage）
签名文本
 pdfSignatureImageText string

签名板中显示的文本
签名文本颜色
 pdfSignatureImageTextColor string

在天体垫中显示的文本的颜色
签名文本大小
 pdfSignatureImageTextSize number

在天体垫中显示的文本的大小

返回

Body
signatureProfile

创建联系人

操作 ID:
CreateContact

将联系人添加到当前用户的联系人列表

参数

名称 密钥 必需 类型 说明
用户 ID
 userId True string

联系人所属的用户
内容类型
 Content-Type True string

Content-Type
联系人电子邮件
 email True string

联系人电子邮件
Contatct 电话号码
 phoneNumber string

电话号码
联系人名字
 firstName True string

firstName
联系人姓氏
 lastName True string

lastName
联系人国家/地区
 country string

country

返回

Body
contact

创建部件

操作 ID:
CreatePart

创建文档部件

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

相关工作流的 ID
内容类型
 Content-Type True string

Content-Type
科特处置
 Content-Disposition True string

Content-Dispotion
创建文档
 createDocuments string

从此部件创建文档
忽略附件
 ignoreAttachments string

将忽略附件
签名配置文件 ID
 signatureProfileId string

如果省略，则被视为附件的部件
解 压缩
 unzip string

解压缩文件
Pdf 到 PdfA
 pdf2pdfa string

将 pdf 转换为 pdf/A
文档
 document True binary

上传的文件数据

返回

名称 路径 类型 说明
文件
 documents array of document

已创建文档
ignoredAttachments
 ignoredAttachments integer

ignoredAttachments
部件
 parts array of part

部件

删除工作流

操作 ID:
DeleteWorkflow

删除工作流

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

要删除的工作流的 ID

返回

Body
workflow

删除文档

操作 ID:
DeleteDocument

删除文档

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

文档的 ID

返回

Body
document

删除联系人

操作 ID:
DeleteContact

从当前用户的 contects 列表中删除联系人

参数

名称 密钥 必需 类型 说明
联系人 ID
 contactId True string

联系人的 ID
内容类型
 Content-Type True string

Content-Type

返回

Body
contact

搜索元数据布局

操作 ID:
SearchLayouts

搜索工作流布局

参数

名称 密钥 必需 类型 说明
搜索文本
 text string

搜索文本
已禁用搜索
 items.isDisabled string

搜索禁用的布局
搜索名称
 items.name string

按布局名称搜索
搜索元数据
 items.dataConfigurations.slot string

按元数据的状态进行搜索
搜索创建日期
 items.created string

按创建日期搜索
搜索更新日期
 items.updated string

按上次更新日期搜索
排序依据
 sortBy string

用于对搜索结果进行排序的字段
排序方式
 sortOrder string

排序的方向
每页的项数
 itemsPerPage string

响应中每页的项目数
页面索引
 pageIndex string

返回页的索引

返回

名称 路径 类型 说明
items
 items layouts

搜索工作流

操作 ID:
SearchWorkflows

搜索工作流

参数

名称 密钥 必需 类型 说明
接受
 Accept string

接受
搜索文本
 text string

搜索文本
搜索元数据布局
 items.layoutId string

按元数据布局搜索
搜索模板
 items.templateId string

按工作流模板搜索
搜索组
 items.groupId string

按用户组搜索
搜索用户
 items.userId string

按所有者搜索
搜索电子邮件
 items.email string

按所有者的电子邮件搜索
搜索名字
 items.firstname string

按所有者的名字搜索
搜索姓氏
 items.lastname string

按所有者的姓氏搜索
搜索状态
 items.workflowStatus string

按工作流状态搜索
搜索元数据 1
 items.data1 string

按元数据值搜索 1
搜索元数据 2
 items.data2 string

按元数据值 2 进行搜索
搜索元数据 3
 items.data3 string

按元数据值搜索 3
搜索元数据 4
 items.data4 string

按元数据值搜索 4
搜索元数据 5
 items.data5 string

按元数据值 5 进行搜索
搜索元数据 6
 items.data6 string

按元数据值搜索 6
搜索元数据 7
 items.data7 string

按元数据值搜索 7
搜索元数据 8
 items.data8 string

按元数据值搜索 8
搜索创建日期
 items.created string

按创建日期搜索
搜索更新日期
 items.updated string

按上次更新日期搜索
搜索开始日期
 items.started string

按开始日期搜索
排序依据
 sortBy string

用于对搜索结果进行排序的字段
排序方式
 sortOrder string

排序的方向
每页的项数
 itemsPerPage string

响应中每页的项目数
页面索引
 pageIndex string

返回页的索引

返回

Body
workflows

搜索文档

操作 ID:
SearchDocuments

搜索文档

参数

名称 密钥 必需 类型 说明
搜索文本
 text string

搜索文本
搜索元数据布局
 items.layoutId string

按元数据布局搜索
搜索组
 items.groupId string

按用户组搜索
搜索用户
 items.userId string

按所有者搜索
搜索工作流 ID
 items.workflowId string

按工作流 ID 搜索
搜索工作流名称
 items.workflowName string

按工作流名称搜索
搜索元数据 1
 items.data1 string

按元数据值搜索 1
搜索元数据 2
 items.data2 string

按元数据值 2 进行搜索
搜索元数据 3
 items.data3 string

按元数据值搜索 3
搜索元数据 4
 items.data4 string

按元数据值搜索 4
搜索元数据 5
 items.data5 string

按元数据值 5 进行搜索
搜索元数据 6
 items.data6 string

按元数据值搜索 6
搜索元数据 7
 items.data7 string

按元数据值搜索 7
搜索元数据 8
 items.data8 string

按元数据值搜索 8
搜索签名配置文件
 items.signatureProfileId string

按签名配置文件搜索
搜索创建日期
 items.created string

按创建日期搜索
搜索更新日期
 items.updated string

按上次更新日期搜索
排序依据
 sortBy string

用于对搜索结果进行排序的字段
排序方式
 sortOrder string

排序的方向
每页的项数
 itemsPerPage string

响应中每页的项目数
页面索引
 pageIndex string

返回页的索引

返回

名称 路径 类型 说明
items
 items documents

搜索签名配置文件

操作 ID:
SearchSignatureProfiles

搜索签名配置文件

参数

名称 密钥 必需 类型 说明
搜索文本
 text string

搜索文本
搜索默认值
 items.isDefault string

搜索默认签名配置文件
已禁用搜索
 items.isDisabled string

搜索禁用的签名配置文件
搜索名称
 items.name string

按签名配置文件名称进行搜索
搜索文档。
 items.documentType string

按文档类型搜索
搜索签名类型
 items.signatureType string

按签名类型搜索
搜索创建日期
 items.created string

按创建日期搜索
搜索更新日期
 items.updated string

按上次更新日期搜索
排序依据
 sortBy string

用于对搜索结果进行排序的字段
排序方式
 sortOrder string

排序的方向
每页的项数
 itemsPerPage string

响应中每页的项目数
页面索引
 pageIndex string

返回页的索引

返回

Body
signatureProfiles

搜索联系人

操作 ID:
SearchContacts

搜索联系人

参数

名称 密钥 必需 类型 说明
搜索文本
 text string

按文本搜索
搜索电子邮件
 items.email string

通过电子邮件搜索
搜索电话号码
 items.phoneNumber string

按电话号码搜索
搜索名字
 items.fisrtName string

按名字搜索
搜索姓氏
 items.lastName string

按姓氏搜索
搜索国家/地区
 items.country string

按国家/地区搜索
每页的项数
 itemsPerPage number

响应中每页的项目数
页面索引
 pageIndex number

返回页的索引

返回

Body
contacts

搜索许可页

操作 ID:
SearchConsentPages

搜索许可页

参数

名称 密钥 必需 类型 说明
搜索文本
 text string

搜索文本
搜索默认值
 items.isDefault string

搜索默认许可页
已禁用搜索
 items.isDisabled string

搜索禁用的许可页
搜索名称
 items.name string

按许可页名称搜索
搜索步骤类型
 items.stepType string

按步骤类型搜索
搜索客户端 ID
 items.clientId string

按客户端 ID 搜索
搜索创建日期
 items.created string

按创建日期搜索
搜索更新日期
 items.updated string

按上次更新日期搜索
排序依据
 sortBy string

要对其排序搜索结果的字段
排序方式
 sortOrder string

排序的方向
每页的项数
 itemsPerPage string

响应中每页的项目数
页面索引
 pageIndex string

返回页的索引

返回

Body
consentPages

更新元数据布局

操作 ID:
UpdateLayout

更新元数据布局

参数

名称 密钥 必需 类型 说明
租户 ID
 layoutId True string

布局的 ID
内容类型
 Content-Type True string

Content-Type
Name
 name True string

布局名称
已禁用
 isDisabled boolean

如果设置为 true，将禁用布局
槽
 slot string

元数据项（data1 到 data8）
默认
 default string

此布局中的元数据默认值
optional
 optional boolean

如果为 true，则提供值不是必需的
只读
 readonly boolean

可以重写该值
rememberLastValue
 rememberLastValue boolean

如果设置为 true，则该值会跨工作流保留

返回

元数据布局

Body
layout

更新工作流

操作 ID:
UpdateWorkflow

更新工作流

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

要更新的工作流的 ID
内容类型
 Content-Type string

内容类型
用户 ID
 userId string

工作流所有者的 ID
Name
 name string

工作流的名称
Description
 description string

工作流的说明
id
 id string

步骤 ID
stepType
 stepType string

签名或审批
consentPageId
 consentPageId True string

与此收件人关联的同意页（签名级别）的 ID
电子邮件
 email True string

收件人的电子邮件
userId
 userId string

引用 LE 用户，而不是动态创建收件人
电话号码
 phoneNumber string

reicpient 的手机号
firstName
 firstName string

收件人的名字
lastName
 lastName string

收件人的姓氏
country
 country string

收件人的国家/地区代码
preferredLocale
 preferredLocale string

recipient 的区域设置代码
organizationId
 organizationId string

收件人 LE 组织的 ID
requiredRecipients
 requiredRecipients number

必须签名才能执行下一步的最小签名者数
validityPeriod
 validityPeriod number

步骤有效期
inviteperiod
 inviteperiod number

签名提醒频率
maxInvites
 maxInvites number

签名提醒的最大数目
sendDownloadLink
 sendDownloadLink boolean

控制已签名文档的传送给签名者
allowComments
 allowComments boolean

允许/禁止在此步骤中注释
hideAttachments
 hideAttachments boolean

控制对签名者的附件的显示
hideWorkflowRecipients
 hideWorkflowRecipients boolean

控制向签名者显示其他签名者
通知事件
 notifiedEvents array of string

通知工作流事件
userId
 userId string

观察程序用户 ID
notifiedEvents
 notifiedEvents array of string

将通知给此观察程序的工作流事件
电子邮件
 email string

电子邮件
工作流状态
 workflowStatus string

工作流的当前状态
data1
 data1 string

第一个元数据
data2
 data2 string

second metadata
data3
 data3 string

第三个元数据
data4
 data4 string

第四个元数据
data5
 data5 string

第五个元数据
data6
 data6 string

第六个元数据
data7
 data7 string

第七个元数据
data8
 data8 string

heighth 元数据

返回

Body
workflow

更新文档

操作 ID:
UpdateDocument

更新文档

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

文档的 ID
内容类型
 Content-Type True string

Content-Type
signatureProfileId
 signatureProfileId string

要指向本文档的签名配置文件
imageHeight
 imageHeight float

imageHeight
imagePage
 imagePage float

imagePage
imageWidth
 imageWidth float

imageWidth
imageX
 imageX float

imageX
imageY
 imageY float

imageY

返回

Body
document

更新签名配置文件

操作 ID:
UpdateSignatureProfile

更新签名配置文件

参数

名称 密钥 必需 类型 说明
签名配置文件 ID
 spId True string

签名配置文件的 ID
内容类型
 Content-Type True string

Content-Type
为默认值
 isDefault string

将此签名配置文件设为默认的签名配置文件
已禁用
 isDisabled string

禁用此签名配置文件
Name
 name string

签名配置文件名称
签名类型
 signatureType string

pades，xades，xadesDetached，xadesDetachedManifest，cades，helios
强制滚动到文档底部
 forceScrollDocument boolean

强制签名者滚动到文档底部
可见签名模式
 pdfVisibleSignatureMode string

可见签名模式（允许、禁用、noImage）
签名文本
 pdfSignatureImageText string

签名板中显示的文本
签名文本颜色
 pdfSignatureImageTextColor string

在天体垫中显示的文本的颜色
签名文本大小
 pdfSignatureImageTextSize number

在天体垫中显示的文本的大小

返回

Body
signatureProfile

更新联系人

操作 ID:
UpdateContact

修改现有联系人信息

参数

名称 密钥 必需 类型 说明
联系人 ID
 contactId True string

联系人的 ID
内容类型
 Content-Type True string

Content-Type
联系人的电子邮件
 email string

联系人的电子邮件
联系人的电话号码
 phoneNumber string

联系人的电话号码
联系人的名字
 firstName string

联系人的名字
联系人的姓氏
 lastName string

联系人的姓氏
联系人的国家/地区
 country string

联系人的国家/地区

返回

Body
contact

检索元数据布局

操作 ID:
RetrieveLayout

检索工作流布局

参数

名称 密钥 必需 类型 说明
布局 ID
 layoutId True string

布局的 ID

返回

元数据布局

Body
layout

检索元数据映射

操作 ID:
getDataMapping

检索指定租户的元数据映射

参数

名称 密钥 必需 类型 说明
租户 ID
 tenantId True string

租户的 ID

返回

Body
dataMapping

检索工作流

操作 ID:
RetrieveWorkflow

从工作流 ID 检索工作流

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

工作流的 ID

返回

Body
workflow

检索常量页 URL

操作 ID:
WorkflowInvite

创建和检索收件人的同意页面 URL

参数

名称 密钥 必需 类型 说明
工作流 ID
 workflowId True string

工作流的 ID
收件人电子邮件
 recipientEmail string

相关收件人的电子邮件

返回

名称 路径 类型 说明
相关收件人的同意页 URL
 inviteUrl string

相关收件人的同意页 URL

检索我

操作 ID:
RetrieveMe

检索连接的用户 ID

返回

Body
user

检索文档

操作 ID:
RetrieveDocument

检索文档

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

文档的 ID

返回

Body
document

检索签名配置文件

操作 ID:
RetrieveSignatureProfile

检索签名配置文件

参数

名称 密钥 必需 类型 说明
签名配置文件 ID
 spId True string

签名配置文件的 ID

返回

Body
signatureProfile

检索联系人

操作 ID:
RetrieveContact

从联系人 ID 检索联系人信息

参数

名称 密钥 必需 类型 说明
联系人 ID
 contactId True string

联系人的 ID
内容类型
 Content-Type True string

Content-Type

返回

Body
contact

检索许可页

操作 ID:
RetrieveConsentPage

从许可页 ID 检索许可页信息

参数

名称 密钥 必需 类型 说明
许可页 ID
 cpId True string

同意页的 ID
内容类型
 Content-Type True string

Content-Type

返回

Body
consentPage

定义

consentPage

名称 路径 类型 说明
allowOrganization
 allowOrganization boolean

允许使用组织
authenticateUser
 authenticateUser boolean

强制实施签名者身份验证
clientId
 clientId string

客户端 ID
已创建
 created number

创建日期
emUrl
 emUrl string

Evidences manager Url
hideDownloads
 hideDownloads boolean

同意页面上不会播放文档下载链接
hideMobileQrCode
 hideMobileQrCode boolean

隐藏常量页面上的 QR 码
id
 id string

许可页 ID
isCountryRequired
 isCountryRequired boolean

使国家/地区在登录者信息中是必需的
isDisabled （已禁用）
 isDisabled boolean

“许可”页已禁用
logoResourceId
 logoResourceId string

同意页徽标资源的 ID
姓名
 name string

许可页名称
primaryColor
 primaryColor string

同意页面主颜色
secondaryColor
 secondaryColor string

同意页辅助颜色
sharedPassphrase
 sharedPassphrase string

共享通行短语
签名模式
 signing mode string

签名模式（本地或服务器）
stepType
 stepType string

步骤类型（签名或审批）
tenantId
 tenantId string

租户 ID
tsaUrl
 tsaUrl string

时间戳颁发机构 URL
更新
 updated number

上次修改日期
verifyEmail
 verifyEmail boolean

如果设置为 tue，则签名者将通过电子邮件接收 OTP
verifyPhoneNumber
 verifyPhoneNumber boolean

如果设置为 true，则签名者将通过短信接收 OTP

consentPages

名称 路径 类型 说明
items
 items array of consentPage

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
总项目数
 totalItems integer

总项目数

联系

名称 路径 类型 说明
country
 country string

联系人国家/地区
已创建
 created integer

联系人创建日期
电子邮件
 email string

联系人电子邮件
firstName
 firstName string

Contact firstName
id
 id string

联系人 ID
lastName
 lastName string

Contact lastName
姓名
 name string

联系人姓名（名字 + 姓氏）
电话号码
 phoneNumber string

联系人电话号码
tenantId
 tenantId string

租户 ID
更新
 updated integer

联系上次修改日期
userId
 userId string

联系人所有者的 ID

contacts

名称 路径 类型 说明
items
 items array of contact

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
总项目数
 totalItems integer

总项目数

dataMapping

名称 路径 类型 说明
描述
 data1.description string

元数据说明
姓名
 data1.name string

元数据名称
模式
 data1.pattern string

元数据模式
options
 data1.options array of object

options
value
 data1.options.value string

元数据值
类型
 data1.type string

类型
描述
 data2.description string

元数据说明
姓名
 data2.name string

元数据名称
模式
 data2.pattern string

元数据模式
options
 data2.options array of object

options
value
 data2.options.value string

元数据值
类型
 data2.type string

类型
描述
 data3.description string

元数据说明
姓名
 data3.name string

元数据名称
模式
 data3.pattern string

元数据模式
options
 data3.options array of object

options
value
 data3.options.value string

元数据值
类型
 data3.type string

类型
描述
 data4.description string

元数据说明
姓名
 data4.name string

元数据名称
模式
 data4.pattern string

元数据模式
options
 data4.options array of object

options
value
 data4.options.value string

元数据值
类型
 data4.type string

类型
描述
 data5.description string

元数据说明
姓名
 data5.name string

元数据名称
模式
 data5.pattern string

元数据模式
options
 data5.options array of object

options
value
 data5.options.value string

元数据值
类型
 data5.type string

类型
描述
 data6.description string

元数据说明
姓名
 data6.name string

元数据名称
模式
 data6.pattern string

元数据模式
options
 data6.options array of object

options
value
 data6.options.value string

元数据值
类型
 data6.type string

类型
描述
 data7.description string

元数据说明
姓名
 data7.name string

Metadataname
模式
 data7.pattern string

元数据模式
options
 data7.options array of object

options
value
 data7.options.value string

Metadatavalue
类型
 data7.type string

类型
描述
 data8.description string

元数据说明
姓名
 data8.name string

元数据名称
模式
 data8.pattern string

元数据模式
options
 data8.options array of object

options
value
 data8.options.value string

元数据值
类型
 data8.type string

类型

文档

名称 路径 类型 说明
已创建
 created integer

创建日期
groupId
 groupId string

文档所有者组的 ID
id
 id string

文档的 ID
部件
 parts array of part

部件
pdfSignatureFields
 pdfSignatureFields array of pdfSigField

pdfSignatureFields
signatureProfileId
 signatureProfileId string

文档的签名配置文件的 ID
tenantId
 tenantId string

租户 ID
更新
 updated integer

上次修改日期
userId
 userId string

文档所有者用户 ID
viewAuthorizedGroups
 viewAuthorizedGroups array of string

允许查看文档的组列表
viewAuthorizedUsers
 viewAuthorizedUsers array of string

允许用户查看文档的列表
workflowId
 workflowId string

文档所属的工作流的 ID
工作流名称
 workflowName string

文档所属的工作流的名称

文件

名称 路径 类型 说明
items
 items array of document

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
总项目数
 totalItems integer

总项目数

布局

元数据布局

名称 路径 类型 说明
已创建
 created number

创建日期
id
 id string

布局 ID
isDisabled （已禁用）
 isDisabled boolean

如果设置为 true，则布局已解除
姓名
 name string

布局的名称
tenantId
 tenantId string

租户的 ID
更新
 updated number

上次修改日期
dataConfigurations
 dataConfigurations array of object
槽
 dataConfigurations.slot string

元数据项（data1 到 data8）
默认
 dataConfigurations.default string

此布局中的元数据默认值
optional
 dataConfigurations.optional boolean

如果为 true，则不强制为此元数据提供值
只读
 dataConfigurations.readonly boolean

可以重写该值
rememberLastValue
 dataConfigurations.rememberLastValue boolean

如果设置为 true，则该值会跨工作流保留

布局

名称 路径 类型 说明
items
 items array of object
已创建
 items.created number

创建日期
dataConfigurations
 items.dataConfigurations array of layout
itemsPerPage
 itemsPerPage number

每页项数
pageIndex
 pageIndex number

返回页的索引
总项目数
 totalItems number

请求涉及的项总数

部件

文档部件

名称 路径 类型 说明
内容类型
 contentType string

内容类型
filename
 filename string

filename
哈希
 hash string

哈希
size
 size integer

size

pdfSigField

名称 路径 类型 说明
imageHeight
 imageHeight float

imageHeight
imagePage
 imagePage float

imagePage
imageWidth
 imageWidth float

imageWidth
imageX
 imageX float

imageX
imageY
 imageY float

imageY

signatureProfile

名称 路径 类型 说明
已创建
 created number

创建日期
documentType
 documentType string

文档的类型
forceScrollDocument
 forceScrollDocument boolean

强制签名者滚动到文档底部
id
 id string

签名配置文件 ID
isDefault
 isDefault boolean

将此签名配置文件设为默认的签名配置文件
isDisabled （已禁用）
 isDisabled boolean

禁用此签名配置文件
姓名
 name string

签名配置文件名称
pdfSignatureImageText
 pdfSignatureImageText string

签名板中显示的文本
pdfSignatureImageTextColor
 pdfSignatureImageTextColor string

在天体垫中显示的文本的颜色
pdfSignatureImageTextSize
 pdfSignatureImageTextSize number

在天体垫中显示的文本的大小
pdfVisibleSignatureMode
 pdfVisibleSignatureMode string

可见签名模式（允许、禁用、noImage）
签名类型
 signatureType string

pades， xades， xadesDetached， xadesDetachedManifest， cades， helios
tenantId
 tenantId string

租户 ID
更新
 updated number

上次修改日期

signatureProfiles

名称 路径 类型 说明
items
 items array of signatureProfile
itemsPerPage
 itemsPerPage number

每页项数
pageIndex
 pageIndex number

返回页的索引
总项目数
 totalItems number

请求涉及的项总数

用户

名称 路径 类型 说明
approveAllowed
 approveAllowed boolean

如果设置为 true，则用户可以批准文档
country
 country string

用户的国家/地区
已创建
 created integer

创建日期
电子邮件
 email string

用户的电子邮件
firstName
 firstName string

用户的 FirstName
groupId
 groupId string

用户的组的 ID
id
 id string

用户的 ID
isDisabled （已禁用）
 isDisabled boolean

如果为 true，则禁用用户
lastLogin
 lastLogin integer

用户上次登录日期
lastName
 lastName string

用户的 LastName
姓名
 name string

用户的名称（名字 + 姓氏）
organizationTitles
 organizationTitles array of

用户在其组织中的功能
电话号码
 phoneNumber string

用户的电话号码
signAllowed
 signAllowed boolean

如果设置为 true，用户可以对文档进行签名
主题
 subject string

用户的内部子项代码
tenantId
 tenantId string

租户的 ID
更新
 updated integer

上次修改日期
viewAuthorizedGroups
 viewAuthorizedGroups array of string

用户可以充当观察者的组列表

工作流

名称 路径 类型 说明
已创建
 created integer

已创建
currentRecipientEmails
 currentRecipientEmails array of

currentRecipientEmails
currentRecipientUsers
 currentRecipientUsers array of

currentRecipientUsers
data1
 data1 string

元数据 1
data2
 data2 string

元数据 2
data3
 data3 string

元数据 3
data4
 data4 string

元数据 4
data5
 data5 string

元数据 5
data6
 data6 string

元数据 6
data7
 data7 string

元数据 7
data8
 data8 string

元数据 8
描述
 description string

工作流的说明
电子邮件
 email string

工作流所有者的电子邮件
firstName
 firstName string

工作流所有者的名字
groupId
 groupId string

工作流所有者组的 ID
id
 id string

工作流的 ID
lastName
 lastName string

工作流所有者的姓氏
layoutId
 layoutId string

工作流的元数据布局的 ID
日志
 logs array of

记录 wokflow 的项
姓名
 name string

工作流所有者的名称（名字 + 姓氏）
notifiedEvents
 notifiedEvents array of string

工作流通知的事件的 Lis
进展
 progress integer

工作流进度（百分比）
steps
 steps array of object

steps
allowComments
 steps.allowComments boolean

允许/禁止在步骤中允许的交互式注释 ara
hideAttachments
 steps.hideAttachments boolean

控制对签名者的附件的显示
hideWorkflowRecipients
 steps.hideWorkflowRecipients boolean

控制向签名者显示其他签名者
id
 steps.id string

步骤 ID
invitePeriod
 steps.invitePeriod integer

invitePeriod
isFinished
 steps.isFinished boolean

isFinished
isStarted （已启动）
 steps.isStarted boolean

isStarted （已启动）
日志
 steps.logs array of

日志
maxInvites
 steps.maxInvites integer

maxInvites
recipients
 steps.recipients array of object

recipients
consentPageId
 steps.recipients.consentPageId string

consentPageId
country
 steps.recipients.country string

country
电子邮件
 steps.recipients.email string

电子邮件
firstName
 steps.recipients.firstName string

firstName
lastName
 steps.recipients.lastName string

lastName
电话号码
 steps.recipients.phoneNumber string

电话号码
userId
 steps.recipients.userId string

userId
requiredRecipients
 steps.requiredRecipients integer

requiredRecipients
sendDownloadLink
 steps.sendDownloadLink boolean

sendDownloadLink
stepType
 steps.stepType string

stepType
validityPeriod
 steps.validityPeriod integer

validityPeriod
tenantId
 tenantId string

tenantId
更新
 updated integer

更新
userId
 userId string

userId
viewAuthorizedGroups
 viewAuthorizedGroups array of string

用户可以充当观察程序的组列表
viewAuthorizedUsers
 viewAuthorizedUsers array of string

viewAuthorizedUsers
watchers
 watchers array of object

watchers
电子邮件
 watchers.email string

电子邮件
notifiedEvents
 watchers.notifiedEvents array of string

notifiedEvents
userId
 watchers.userId string

userId
workflowStatus
 workflowStatus string

workflowStatus

workflows

名称 路径 类型 说明
items
 items array of workflow

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
总项目数
 totalItems integer

总项目数

二进制

这是基本数据类型“binary”。