SignatureAPI

发送用于签名的文档，跟踪其进度，并使用为自动化构建的电子签名平台 SignatureAPI 更快地完成工作。 https://signatureapi.com/docs/integrations/power-automate/getting-started

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

服务	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	签名 API， Inc.
URL	https://signatureapi.com
Email	support@signatureapi.com

连接器元数据
发布者	SignatureAPI
网站	https://signatureapi.com/power-automate
隐私策略	https://signatureapi.com/privacy
类别	协作;生产力

SignatureAPI

SignatureAPI 是一个专为自动化而构建的电子签名平台。

使用适用于 Power Automate 的电子签名平台发送文档进行签名和跟踪进度，该平台提供各种作和触发器来帮助创建简单和复杂的工作流。

使用 SignatureAPI 制作的电子签名具有法律约束力，全球接受，就像大多数司法管辖区的传统墨水签名一样。

SignatureAPI 为大容量自动化提供经济高效的定价。请参阅我们的定价详细信息。

主要功能

多个收件人：在单个事务中向最多 10 个登录者发送文档。
并行或顺序签名：选择一次性或按特定顺序向所有收件人发送文档。
文档模板：使用模板和动态数据以编程方式生成文档。
语言和本地化：使用不同语言、日期时间格式和时区自定义签名界面。
无帐户签名：允许收件人在不创建或登录到帐户的情况下对文档进行签名。
审核日志：维护文档访问、审阅和签名事件的详细日志。
防篡改：确保文档完整性，确保签名后经过验证、不可修改的证明。
跟踪信封：通过用户友好的仪表板监视签名进度。
Real-Time 通知：通过电子邮件和 Webhook 接收有关签名活动的即时更新。

先决条件

若要使用此连接器，请注册 SignatureAPI 帐户并生成 API 密钥。获取免费测试 API 密钥并设置连接。

入门

最常见的工作流涉及向收件人发送一个或多个文档进行签名。收件人会收到一封电子邮件，其中包含用于访问签名界面的链接。

SignatureAPI 支持高级工作流。浏览连接器指南，了解分步说明、用例和自动化策略。

步骤 1：创建信封

首先创建一个空信封。信封是一个容器，用于保存文档和管理签名过程。

作：创建信封

选项包括：

定义收件人是并行登录还是按顺序登录（收件人路由）
自定义语言、时区和日期时间格式（信封本地化）
设置发件人的姓名和电子邮件

步骤 2：添加收件人

通过向信封添加收件人来指定谁需要对文档进行签名。目前仅支持签名者，但将来将提供其他收件人类型。

作：添加收件人 — 签名者

步骤 3：添加文档

将需要签名的文档添加到信封。可以使用数据上传 PDF 或 DOCX 文件，或者从模板生成文档。

步骤 4：定义文档中的位置

位置是收件人交互的文档中的指定区域，例如签名、提供缩写或添加文本。它们还可以包含静态值或计算值，例如完成日期。

步骤 5：启动签名过程

完全准备好信封后，启动签名过程。

作：启动信封

步骤 6：等待信封完成

若要使整个工作流保持在同一流中，可以等待信封完成。这可确保所有收件人都已签名并生成可交付结果（已签名文档）。

作：等待信封

或者，可以在信封完成并生成可交付结果时触发单独的工作流。

触发器：生成可交付结果时

步骤 7：检索已签名的文档

完成此过程后，检索已签名的文档（可交付结果）。

作：获取可交付结果

使用触发器

SignatureAPI 提供触发器来自动执行工作流并简化流程。了解触发器的完整列表以及如何使用它们。

常用触发器

生成可交付结果时

当信封完成且签名的文档（可交付结果）准备就绪时触发。

收件人完成信封时

每次收件人完成签名过程的一部分时触发。

触发器：收件人完成时

收件人电子邮件弹跳时

当收件人的电子邮件地址无法收到请求时触发。

已知问题和限制

使用测试 API 密钥创建测试信封。这些信封不会发送真实电子邮件，也不会计费，因此非常适合测试。详细了解测试信封。
“等待信封”作在 30 天后超时。如果预期收件人需要更长的时间，请改用以“生成可交付结果时”触发器开头的新工作流。

常见错误和解决方案

确保 “获取可交付结果 ”作在 等待信封 作后运行。只有在所有收件人完成其部分后，可交付结果才可用。
如果从测试 API 密钥切换到实时 API 密钥，请更新触发器以确保在正确的环境中（实时或测试）中创建 Webhook。有关详细信息，请参阅我们的故障排除指南。

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

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

Name	类型	Description	必选
API 密钥	securestring	SignatureAPI 帐户的 API 密钥。	True

限制

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

操作

创建仪式 - 电子邮件链接身份验证	创建一个仪式，其中收件人通过发送到其电子邮件的链接进行身份验证。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
创建仪式 - 自定义身份验证	创建一个仪式，其中收件人在 SignatureAPI 外部进行身份验证。使用此 URL 获取与收件人共享的仪式 URL。使用自定义身份验证读取之前 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
创建信封	创建可向其添加收件人和文档的新信封。准备就绪后，使用“启动信封”作启动签名过程。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
删除信封	删除信封和所有关联信息。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
启动信封	启动信封的签名过程。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
将数据添加到模板	将数据添加到模板。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
添加位置 - 文本	向文档添加文本位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
添加位置 - 文本输入	向文档添加文本输入位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
添加位置 - 缩写	向文档添加首字母缩写位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
添加位置 — 信封完成日期	向文档添加信封完成日期位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
添加位置 — 收件人已完成日期	将收件人完成的日期位置添加到文档。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
添加位置 — 签名	向文档添加签名位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
添加收件人 - 签名者	将收件人添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
添加文档 - DOCX	将 DOCX 文档添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
添加文档 - PDF	将 PDF 文档添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document
添加模板 - DOCX	将 DOCX 模板添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template
等待信封	等待信封到达已完成状态或其他最终状态。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
获取信封	按信封 ID 检索信封详细信息。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
获取可交付结果	使用其 ID 检索可交付结果。使用它下载信封的签名副本。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
获取捕获的值	检索签名期间收件人在输入位置输入的值。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
获取收件人	按其 ID 检索收件人详细信息。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

创建仪式 - 电子邮件链接身份验证

操作 ID:: CreateCeremonyEmailLink

创建一个仪式，其中收件人通过发送到其电子邮件的链接进行身份验证。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

参数

名称	密钥	必需	类型	说明
收件人 ID	recipientId	True	string	收件人的 ID。
重定向 URL	redirect_url		string	在完成仪式后将收件人重定向到的 URL。了解以下内容的详细信息： https://signatureapi.com/docs/resources/ceremonies/redirect-url
其他属性	extra		string	扩展性的额外属性

response: object

创建仪式 - 自定义身份验证

操作 ID:: CreateCeremonyCustom

创建一个仪式，其中收件人在 SignatureAPI 外部进行身份验证。使用此 URL 获取与收件人共享的仪式 URL。使用自定义身份验证读取之前 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

参数

名称	密钥	必需	类型	说明
收件人 ID	recipientId	True	string	收件人的 ID。
身份验证提供程序	provider	True	string	身份验证提供程序的名称。此值是任意的，将显示在信封的审核日志中。
身份验证数据	data	True	array of string	键：包含身份验证元数据的值对。这些详细信息将包含在信封的审核日志中。
重定向 URL	redirect_url		string	在完成仪式后将收件人重定向到的 URL。了解以下内容的详细信息： https://signatureapi.com/docs/resources/ceremonies/redirect-url
其他属性	extra		string	扩展性的额外属性

Body: CreateCeremonyCustomOutput

创建信封

操作 ID:: CreateEnvelope

创建可向其添加收件人和文档的新信封。准备就绪后，使用“启动信封”作启动签名过程。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

参数

名称	密钥	必需	类型	说明
信封标题	title	True	string	此信封的标题。这可能向收件人显示。
信封标签	label		string	为信封提供的自定义标签，以便于识别。标签供内部使用，不会向收件人显示。
信封邮件	message		string	将发送给收件人的邮件。
信封模式	mode		string	测试模式信封是非绑定的，不会计费。
信封路由	routing		string	收件人签署信封的顺序。它可以是并行的，其中所有收件人可以同时签名，也可以是连续的，其中收件人一个接一个地签名。
语言	language		string	在签名仪式和可交付结果中使用的默认语言。如果未指定，则使用帐户的默认语言。 https://signatureapi.com/docs/localization/language
时区	timezone		string	要用于可交付结果中的时间戳的时区。如果未指定，则使用帐户的默认时区偏移量。 https://signatureapi.com/docs/localization/timezone
时间戳格式	timestamp_format		string	在可交付结果的时间戳中使用的日期和时间格式。如果未指定，则使用帐户的默认时间戳格式。 https://signatureapi.com/docs/localization/timestamp_format
信封证明	attestation		string	法规或合规性证明
Name	name		string	发送方的名称。
Email	email		string	发件人的电子邮件地址。
信封主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。
其他属性	extra		string	扩展性的额外属性

Body: CreateEnvelopeOutput

删除信封

操作 ID:: DeleteEnvelope

删除信封和所有关联信息。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。

启动信封

操作 ID:: StartEnvelope

启动信封的签名过程。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。

Body: StartEnvelopeOutput

将数据添加到模板

操作 ID:: AddTemplateData

将数据添加到模板。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
字段名称	field_name	True	string	模板中字段的名称。
价值	value	True	string	模板中字段的值。

添加位置 - 文本

操作 ID:: AddPlaceText

向文档添加文本位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
价值	value	True	string	此文本位置的值。
字号	font_size		number	字号（以磅为单位）。
字体颜色	font_color		string	十六进制表示法中的字体颜色。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加位置 - 文本输入

操作 ID:: AddPlaceTextInput

向文档添加文本输入位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
收件人密钥	recipient_key	True	string	收件人的密钥是指此位置。
捕获为	capture_as		string	存储收件人输入并包含在信封捕获中的密钥。
Hint	hint		string	在收件人的输入字段中显示的工具提示消息。
Prompt	prompt		string	签名仪式期间输入文本字段中显示的占位符消息。
Requirement	requirement		string	指定收件人是否必须填写此字段才能完成签名仪式。
Format	format		string	指定用户输入的有效格式。有关允许的值，请参阅文档。
设置消息格式	format_message		string	当用户的输入与所需格式不匹配时显示的消息。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加位置 - 缩写

操作 ID:: AddPlaceInitials

向文档添加首字母缩写位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
收件人密钥	recipient_key	True	string	收件人的密钥是指此位置。
放置高度	height		number	设置自定义高度，宽度按比例调整。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加位置 — 信封完成日期

操作 ID:: AddPlaceEnvelopeCompletedDate

向文档添加信封完成日期位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
日期格式	date_format		string	定义日期和时间的格式。有关允许的值，请参阅文档。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加位置 — 收件人已完成日期

操作 ID:: AddPlaceRecipientCompletedDate

将收件人完成的日期位置添加到文档。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
收件人密钥	recipient_key	True	string	收件人的密钥是指此位置。
日期格式	date_format		string	定义日期和时间的格式。有关允许的值，请参阅文档。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加位置 — 签名

操作 ID:: AddPlaceSignature

向文档添加签名位置。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档的 ID。
放置键	key	True	string	在文档中标识此位置的键。
收件人密钥	recipient_key	True	string	收件人的密钥是指此位置。
放置高度	height		number	设置自定义高度，宽度按比例调整。
页码	page		number	要定位此位置的页码。
与顶部的距离	top		number	从页面顶部到位置底部的距离（以磅为单位）。
从左距离	left		number	从页面左侧到位置的距离（以磅为单位）。
其他属性	extra		string	扩展性的额外属性

添加收件人 - 签名者

操作 ID:: AddRecipient

将收件人添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。
收件人姓名	name	True	string	收件人的名称。
收件人电子邮件	email	True	string	收件人的电子邮件地址。
收件人密钥	key	True	string	标识信封中收件人的密钥。
收件人仪式创建	ceremony_creation		string	如何创建收件人的仪式。
收件人送达类型	delivery_type		string	如何向收件人发送可交付结果。
其他属性	extra		string	扩展性的额外属性

Body: AddRecipientSignerOutput

添加文档 - DOCX

操作 ID:: AddDocumentDocx

将 DOCX 文档添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。
文档标题	title		string	本文档的标题。这可能向收件人显示。
文件内容	file_content	True	byte	文档文件的内容。
其他属性	extra		string	扩展性的额外属性

Body: AddDocumentOutput

添加文档 - PDF

操作 ID:: AddDocument

将 PDF 文档添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。
文档标题	title		string	本文档的标题。这可能向收件人显示。
文件内容	file_content	True	byte	文档文件的内容。
其他属性	extra		string	扩展性的额外属性

Body: AddDocumentOutput

添加模板 - DOCX

操作 ID:: AddTemplate

将 DOCX 模板添加到信封。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。
文档标题	title		string	本文档的标题。这可能向收件人显示。
文件内容	file_content	True	byte	文档文件的内容。
模板数据	data		array of string	字段：包含要填充到模板中的数据的值对。
其他属性	extra		string	扩展性的额外属性

Body: AddDocumentOutput

等待信封

操作 ID:: WaitEnvelope

等待信封到达已完成状态或其他最终状态。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。

Body: Envelope

获取信封

操作 ID:: GetEnvelope

按信封 ID 检索信封详细信息。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。

Body: Envelope

获取可交付结果

操作 ID:: GetDeliverable

使用其 ID 检索可交付结果。使用它下载信封的签名副本。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

参数

名称	密钥	必需	类型	说明
可交付结果 ID	deliverableId	True	string	可交付结果的 ID。

Body: Deliverable

获取捕获的值

操作 ID:: GetCapture

检索签名期间收件人在输入位置输入的值。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeId	True	string	信封的 ID。
捕获密钥	captureKey	True	string	捕获值的键。

Body: Capture

获取收件人

操作 ID:: GetRecipient

按其 ID 检索收件人详细信息。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

参数

名称	密钥	必需	类型	说明
收件人 ID	recipientId	True	string	收件人的 ID。

Body: Recipient

触发器

信封失败时	当信封失败时发生此事件，导致信封状态失败。
信封完成后	当信封状态从in_progress转换到完成时，将发生此事件，表明信封状态已由所有收件人完成。
创建信封时	每当创建信封时，将发生此事件。
发布收件人时	当收件人准备好发送请求以完成信封时，将发生此事件。
发送收件人时	当向收件人发送请求时，将发生此事件。
取消信封时	如果在完成之前有意停止签名过程，导致信封状态已取消，则会发生此事件。
当信封已启动时	当信封状态从处理转换到in_progress时，将发生此事件，表明它已准备好发送给收件人。
当可交付结果失败时	生成可交付结果失败时发生此事件，导致可交付结果状态失败。
当收件人弹跳时	当电子邮件无法交付（暂时（软弹跳）或永久（硬弹跳）时，将发生此事件。
当收件人重新发送时	当请求重新发送给收件人时，将发生此事件。
拒绝收件人时	当收件人拒绝信封时，将发生此事件。
收件人失败时	当与收件人相关的失败导致收件人状态失败时，会发生此事件。
收件人完成时	当收件人已完成签名过程的一部分时，将发生此事件。
替换收件人时	当收件人替换为新收件人时，将发生此事件。
生成可交付结果时	成功生成可交付结果（如审核日志）时，会发生此事件。

信封失败时

操作 ID:: CreateEndpointForEnvelopeFailed

当信封失败时发生此事件，导致信封状态失败。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForEnvelopeFailed

信封完成后

操作 ID:: CreateEndpointForEnvelopeCompleted

当信封状态从in_progress转换到完成时，将发生此事件，表明信封状态已由所有收件人完成。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForEnvelopeCompleted

创建信封时

操作 ID:: CreateEndpointForEnvelopeCreated

每当创建信封时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForEnvelopeCreated

发布收件人时

操作 ID:: CreateEndpointForRecipientReleased

当收件人准备好发送请求以完成信封时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientReleased

发送收件人时

操作 ID:: CreateEndpointForRecipientSent

当向收件人发送请求时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientSent

取消信封时

操作 ID:: CreateEndpointForEnvelopeCanceled

如果在完成之前有意停止签名过程，导致信封状态已取消，则会发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForEnvelopeCanceled

当信封已启动时

操作 ID:: CreateEndpointForEnvelopeStarted

当信封状态从处理转换到in_progress时，将发生此事件，表明它已准备好发送给收件人。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForEnvelopeStarted

当可交付结果失败时

操作 ID:: CreateEndpointForDeliverableFailed

生成可交付结果失败时发生此事件，导致可交付结果状态失败。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForDeliverableFailed

当收件人弹跳时

操作 ID:: CreateEndpointForRecipientBounced

当电子邮件无法交付（暂时（软弹跳）或永久（硬弹跳）时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientBounced

当收件人重新发送时

操作 ID:: CreateEndpointForRecipientResent

当请求重新发送给收件人时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientResent

拒绝收件人时

操作 ID:: CreateEndpointForRecipientRejected

当收件人拒绝信封时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientRejected

收件人失败时

操作 ID:: CreateEndpointForRecipientFailed

当与收件人相关的失败导致收件人状态失败时，会发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientFailed

收件人完成时

操作 ID:: CreateEndpointForRecipientCompleted

当收件人已完成签名过程的一部分时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientCompleted

替换收件人时

操作 ID:: CreateEndpointForRecipientReplaced

当收件人替换为新收件人时，将发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForRecipientReplaced

生成可交付结果时

操作 ID:: CreateEndpointForDeliverableGenerated

成功生成可交付结果（如审核日志）时，会发生此事件。

参数

名称	密钥	必需	类型	说明
主题	topics		array of string	用于对信封进行分类和筛选 Webhook 通知。

Body: NotificationForDeliverableGenerated

定义

信封

名称	路径	类型	说明
信封 ID	id	EnvelopeId	信封的 ID。
信封标题	title	EnvelopeTitle	此信封的标题。这可能向收件人显示。
信封标签	label	EnvelopeLabel	为信封提供的自定义标签，以便于识别。标签供内部使用，不会向收件人显示。
信封邮件	message	EnvelopeMessage	将发送给收件人的邮件。
发送方	sender	EnvelopeSender
信封状态	status	EnvelopeStatus	信封的状态。
交付	deliverable	EnvelopeDeliverable
信封已完成时间	completed_at	EnvelopeCompletedAt	所有收件人完成信封的时间。
信封模式	mode	EnvelopeMode	测试模式信封是非绑定的，不会计费。
信封路由	routing	EnvelopeRouting	收件人签署信封的顺序。它可以是并行的，其中所有收件人可以同时签名，也可以是连续的，其中收件人一个接一个地签名。
时区	timezone	EnvelopeTimezone	要用于可交付结果中的时间戳的时区。如果未指定，则使用帐户的默认时区偏移量。 https://signatureapi.com/docs/localization/timezone
时间戳格式	timestamp_format	EnvelopeTimestampFormat	在可交付结果的时间戳中使用的日期和时间格式。如果未指定，则使用帐户的默认时间戳格式。 https://signatureapi.com/docs/localization/timestamp_format
信封证明	attestation	EnvelopeAttestation	法规或合规性证明
信封主题	topics	EnvelopeTopics	用于对信封进行分类和筛选 Webhook 通知。

Recipient

名称	路径	类型	说明
收件人 ID	id	RecipientId	收件人的 ID。
信封 ID	envelope_id	EnvelopeId	信封的 ID。
收件人类型	type	RecipientType	收件人的类型。
收件人密钥	key	RecipientKey	标识信封中收件人的密钥。
收件人姓名	name	RecipientName	收件人的名称。
收件人电子邮件	email	RecipientEmail	收件人的电子邮件地址。
收件人状态	status	RecipientStatus	收件人的状态。
收件人仪式创建	ceremony_creation	RecipientCeremonyCreation	如何创建收件人的仪式。
收件人送达类型	delivery_type	RecipientDeliveryType	如何向收件人发送可交付结果。
收件人已完成时间	completed_at	RecipientCompletedAt	收件人完成信封的时间。

交付

名称	路径	类型	说明
可交付结果 ID	id	DeliverableId	可交付结果的 ID。
可交付结果类型	type	DeliverableType	可交付结果的类型。
可交付结果状态	status	DeliverableStatus	可交付结果的状态。
文件内容	file_content	DeliverableFileContent	可交付结果的文件内容。使用它保存信封的签名副本。

捕获

名称	路径	类型	说明
捕获值	value	CaptureValue	收件人输入捕获的值

CreateEnvelopeOutput

名称	路径	类型	说明
信封 ID	id	EnvelopeId	信封的 ID。
信封标题	title	EnvelopeTitle	此信封的标题。这可能向收件人显示。
信封标签	label	EnvelopeLabel	为信封提供的自定义标签，以便于识别。标签供内部使用，不会向收件人显示。
信封邮件	message	EnvelopeMessage	将发送给收件人的邮件。
发送方	sender	EnvelopeSender
信封模式	mode	EnvelopeMode	测试模式信封是非绑定的，不会计费。
信封路由	routing	EnvelopeRouting	收件人签署信封的顺序。它可以是并行的，其中所有收件人可以同时签名，也可以是连续的，其中收件人一个接一个地签名。
时区	timezone	EnvelopeTimezone	要用于可交付结果中的时间戳的时区。如果未指定，则使用帐户的默认时区偏移量。 https://signatureapi.com/docs/localization/timezone
时间戳格式	timestamp_format	EnvelopeTimestampFormat	在可交付结果的时间戳中使用的日期和时间格式。如果未指定，则使用帐户的默认时间戳格式。 https://signatureapi.com/docs/localization/timestamp_format
信封证明	attestation	EnvelopeAttestation	法规或合规性证明
信封主题	topics	EnvelopeTopics	用于对信封进行分类和筛选 Webhook 通知。

StartEnvelopeOutput

名称	路径	类型	说明
信封状态	status	EnvelopeStatus	信封的状态。

AddDocumentOutput

名称	路径	类型	说明
文档 ID	id	DocumentId	文档的 ID

AddRecipientSignerOutput

名称	路径	类型	说明
收件人 ID	id	RecipientId	收件人的 ID。
收件人姓名	name	RecipientName	收件人的名称。
收件人电子邮件	email	RecipientEmail	收件人的电子邮件地址。
收件人密钥	key	RecipientKey	标识信封中收件人的密钥。
收件人仪式创建	ceremony_creation	RecipientCeremonyCreation	如何创建收件人的仪式。
收件人送达类型	delivery_type	RecipientDeliveryType	如何向收件人发送可交付结果。

CreateCeremonyCustomOutput

名称	路径	类型	说明
仪式 URL	url	CeremonyUrl	收件人必须访问的 URL 以启动仪式

EnvelopeId

信封的 ID。

信封 ID: string

EnvelopeTitle

此信封的标题。这可能向收件人显示。

信封标题: string

EnvelopeLabel

为信封提供的自定义标签，以便于识别。标签供内部使用，不会向收件人显示。

信封标签: string

EnvelopeMessage

将发送给收件人的邮件。

信封邮件: string

EnvelopeRouting

收件人签署信封的顺序。它可以是并行的，其中所有收件人可以同时签名，也可以是连续的，其中收件人一个接一个地签名。

信封路由: string

EnvelopeTimezone

要用于可交付结果中的时间戳的时区。如果未指定，则使用帐户的默认时区偏移量。 https://signatureapi.com/docs/localization/timezone

时区: string

EnvelopeTimestampFormat

在可交付结果的时间戳中使用的日期和时间格式。如果未指定，则使用帐户的默认时间戳格式。 https://signatureapi.com/docs/localization/timestamp_format

时间戳格式: string

EnvelopeSender

名称	路径	类型	说明
发件人姓名	name	string	发送方的名称。
发件人电子邮件	email	string	发件人的电子邮件地址。

EnvelopeStatus

信封的状态。

信封状态: string

EnvelopeMode

测试模式信封是非绑定的，不会计费。

信封模式: string

EnvelopeTopics

用于对信封进行分类和筛选 Webhook 通知。

名称	路径	类型	说明
物品		string

EnvelopeAttestation

法规或合规性证明

信封证明: string

EnvelopeDeliverable

名称	路径	类型	说明
可交付结果 ID	id	string	可交付结果的 ID。使用此包下载已签名的信封副本。

EnvelopeCompletedAt

所有收件人完成信封的时间。

信封已完成时间: date-time

DocumentId

文档的 ID

文档 ID: string

RecipientId

收件人的 ID。

收件人 ID: string

RecipientType

收件人的类型。

收件人类型: string

RecipientName

收件人的名称。

收件人姓名: string

RecipientEmail

收件人的电子邮件地址。

收件人电子邮件: string

RecipientKey

标识信封中收件人的密钥。

收件人密钥: string

RecipientStatus

收件人的状态。

收件人状态: string

RecipientCeremonyCreation

如何创建收件人的仪式。

收件人仪式创建: string

RecipientDeliveryType

如何向收件人发送可交付结果。

收件人送达类型: string

RecipientCompletedAt

收件人完成信封的时间。

收件人已完成时间: date-time

DeliverableId

可交付结果的 ID。

可交付结果 ID: string

DeliverableType

可交付结果的类型。

可交付结果类型: string

DeliverableStatus

可交付结果的状态。

可交付结果状态: string

DeliverableFileContent

可交付结果的文件内容。使用它保存信封的签名副本。

文件内容: byte

CeremonyUrl

收件人必须访问的 URL 以启动仪式

仪式 URL: string

CaptureValue

收件人输入捕获的值

捕获值: string

NotificationForEnvelopeCreated

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。

NotificationForEnvelopeStarted

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。

NotificationForEnvelopeCompleted

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。

NotificationForEnvelopeFailed

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
详细信息	data.detail	string	有关失败的信息。

NotificationForEnvelopeCanceled

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。

NotificationForRecipientReleased

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。

NotificationForRecipientSent

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。

NotificationForRecipientCompleted

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。

NotificationForRecipientRejected

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。
原因	data.reason	string	收件人对拒绝的解释。

NotificationForRecipientBounced

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。
详细信息	data.detail	string	有关弹跳的信息。

NotificationForRecipientFailed

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。
详细信息	data.detail	string	有关失败的信息。

NotificationForRecipientReplaced

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。
新建收件人 ID	data.new_recipient_id	string	新收件人的 ID。

NotificationForRecipientResent

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
收件人 ID	data.object_id	EventRecipientId	此事件引用的收件人的 ID。
收件人类型	data.recipient_type	EventRecipientType	此事件引用的收件人类型。
收件人密钥	data.recipient_key	EventRecipientKey	此事件引用的收件人密钥。

NotificationForDeliverableGenerated

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
可交付结果 ID	data.object_id	EventDeliverableId	此事件所引用的可交付结果的 ID。

NotificationForDeliverableFailed

名称	路径	类型	说明
事件编号	id	EventId	事件的 ID。
事件时间戳	timestamp	EventTimestamp	事件的日期和时间，采用 ISO 8601 格式。
事件类型	type	EventType	事件类型。
信封 ID	data.envelope_id	EventEnvelopeId	此事件引用的信封的 ID。
可交付结果 ID	data.object_id	EventDeliverableId	此事件所引用的可交付结果的 ID。
详细信息	data.detail	string	有关失败的信息。

EventId

事件的 ID。

事件编号: string

事件时间戳

事件的日期和时间，采用 ISO 8601 格式。

事件时间戳: date-time

事件类型

事件类型。

事件类型: string

EventEnvelopeId

此事件引用的信封的 ID。

信封 ID: string

EventRecipientId

此事件引用的收件人的 ID。

收件人 ID: string

EventRecipientType

此事件引用的收件人类型。

收件人类型: string

EventRecipientKey

此事件引用的收件人密钥。

收件人密钥: string

EventDeliverableId

此事件所引用的可交付结果的 ID。

可交付结果 ID: string

对象

这是类型“object”。

通过

SignatureAPI

SignatureAPI

主要功能

先决条件

入门

步骤 1：创建信封

步骤 2：添加收件人

步骤 3：添加文档

步骤 4：定义文档中的位置

步骤 5：启动签名过程

步骤 6：等待信封完成

步骤 7：检索已签名的文档

使用触发器

常用触发器

生成可交付结果时

收件人完成信封时

收件人电子邮件弹跳时

已知问题和限制

常见错误和解决方案

正在创建连接

违约

限制

操作

创建仪式 - 电子邮件链接身份验证

参数

返回

创建仪式 - 自定义身份验证

参数

返回

创建信封

参数

返回

删除信封

参数

启动信封

参数

返回

将数据添加到模板

参数

添加位置 - 文本

参数

添加位置 - 文本输入

参数

添加位置 - 缩写

参数

添加位置 — 信封完成日期

参数

添加位置 — 收件人已完成日期

参数

添加位置 — 签名

参数

添加收件人 - 签名者

参数

返回

添加文档 - DOCX

参数

返回

添加文档 - PDF

参数

返回

添加模板 - DOCX

参数

返回

等待信封

参数

返回

获取信封

参数

返回

获取可交付结果

参数

返回

获取捕获的值

参数

返回

获取收件人

参数

返回

触发器