Nitro Sign （预览版）

Nitro Sign API 允许应用程序创建、管理和跟踪数字签名过程，从而实现安全的端到端 eSignature 工作流。它提供创建信封、上传文档、添加参与者、定义签名顺序以及通过完全自动化的 API 驱动方法发送文档以供签名的功能。

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

Service	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）

联系人
名称	Nitro 支持
URL	https://www.gonitro.com/support
Email	prosupport@sfdc.gonitro.com

连接器元数据
Publisher	Nitro PDF
网站	https://www.gonitro.com/
隐私策略	https://www.gonitro.com/legal/privacy-policy
类别	生产力;IT 操作

Nitro 签名连接器

Overview

Nitro Sign 连接器可直接从Power Automate和Power Apps启用安全的端到端 eSignature 工作流。它允许应用程序创建和管理签名信封、上传和管理签名信封、上传和重新排序文档、添加参与者并定义签名顺序、放置签名和数据字段、发送用于签名的文档、跟踪进度以及下载原始、密封和审核线索文件 -- 全部通过完全自动化的 API 驱动方法。

Publisher： Nitro Software

先决条件

若要通过此连接器使用 Nitro Sign，需要：

已启用 Nitro Sign 的一个 Nitro 帐户
https://developers.gonitro.com/
具有自定义连接器功能的Microsoft PowerApps或Power Automate计划。

Authentication

Nitro Sign 使用 计算机到计算机 OAuth 2.0 和 客户端凭据 授予来为 API 请求生成访问令牌。

工作原理

在 Nitro 的自助服务门户中创建 API 应用程序，并获取关联的客户端 ID 和客户端密码。
连接器通过交换 持有者 访问令牌的这些凭据进行身份验证。
然后，该令牌用于授权后续的 Nitro Sign API 调用。

创建凭据并阅读详细指南：
https://developers.gonitro.com/docs/authentication/credentials

在 Power Automate/Power Apps 中创建连接

将连接器添加到流或应用时：

单击“ 添加新连接”。
输入 客户端 ID 和 客户端密码 （在 Nitro 开发人员门户中颁发）。
选择你的 Nitro 区域（欧洲、美国或 APAC）-与你的 Nitro 帐户关联的区域。
保存连接 - 首次使用时，连接器使用 OAuth 2.0 客户端凭据授予来交换客户端 ID 和客户端密码，以使用 OAuth 2.0 客户端凭据授予、缓存并自动续订它。凭据仅用于获取令牌;后续 API 调用是代表你使用持有者令牌进行身份验证的。

注意：无需用户交互式登录;此流专为服务器到服务器/应用到应用方案而设计。

支持的作

连接器围绕签名工作流的四个资源（信封、文档、字段和 参与者 ）以及一组用于检索已完成文件的下载操作进行分组。

1. 信封

信封是单个签名请求中的文档、参与者和字段的容器。

列表信封
返回与帐户中的应用程序关联的所有信封。结果已分页：响应包括 “下一页” 游标标记，你可以向可选 Page After 参数提供该标记，以检索下一页（或 “前页 前页”向后）。这两个游标参数都在 “高级 ”下，仅在遍历大型结果集时才需要。
创建信封
使用名称、通知消息（主题 + 正文、动态变量等 $(sender_name_or_email) ） $(envelope_name)和签名模式创建新信封：
- parallel — 所有参与者同时收到通知，可以独立签名。
- sequential — 参与者按添加的顺序一次通知一个。
按 ID 获取信封
按 UUID 检索特定信封的详细信息。
更新信封
更新信封名称、通知设置和/或签名模式。所有字段都是可选的。
按 ID 删除信封
永久删除信封和所有关联的文档、字段和参与者。无法撤消此作。
发送签名信封
将信封发送到参与者进行签名收集。在发送之前，信封通常应添加其文档、参与者和签名字段（通过“按信封 ID 创建文档”、“按信封 ID 创建参与者”和“创建字段”）（按文档 ID 添加）。 信封中的所有文档都必须处于上传状态，才能发送信封。
发送信封提醒
触发挂起参与者的提醒通知。如果未提供通知设置，则使用为信封配置的默认通知模板。
按 ID 取消信封
取消签名请求。只能取消已发送用于签名的信封。

2. 文档

文档是附加到信封并由参与者签名的文件。

按信封 ID 列出文档
检索与信封关联的所有文档。
按信封 ID 创建文档
将文档上传到现有信封。提供文件加上简单、类型化的字段 - 没有手动编写的 JSON：
- 文档文件 - 要上传的文件。
- 文档名称 - 要在其中存储文档的名称。
- 内容类型（高级，可选） - 文件的 MIME 类型;defaults to application/pdf. 省略时，仅接受 PDF 文件。
按 ID 获取文档
检索信封中特定文档的详细信息。
按 ID 更新文档
更新文档元数据。目前，只能更改文档名称。
按 ID 删除文档
永久删除信封中的文档。
按信封 ID 对文档重新排序
根据提供的文档 ID 列表对信封中的文档重新排序。

3. 字段

字段是放置在文档上并分配给参与者的交互式元素（签名、缩写、日期等）。

按文档 ID 列出字段
检索与特定文档关联的所有字段。
按文档 ID 创建字段
在文档中创建一个或多个字段，并将其分配给参与者。为单个字段提供一项，或为批量请求提供多个项。每个字段指定：
- participantID — 分配给字段的参与者。
- type- 之signature一，，initials，，name，companydatetitle，，。 customcheckbox
- page — 页码（基于 1 的索引）。
- X Position，YPosition，Width，Height - 字段的位置和大小，每个输入为单独的数字以磅为单位（X/Y 是从页面的左/上边缘测量）。它们替换了上一个 boundingBox 数组，因此每个值都是 UI 中的类型化字段，而不是手动生成的列表。
- 可选： required （默认值 true），并在 “高级format ”下（例如 MM/DD/YYYY 日期字段）和 modifiable。
按 ID 更新字段
更新现有字段的属性。必须提供该字段 type ，并且必须与现有字段类型匹配，它用于标识字段架构， 并且不会 更改字段类型。
按 ID 删除字段
永久删除文档中的字段。

4. 参与者

参与者是接收信封的人员，要么签署信封，要么被通知。

按信封 ID 列出参与者
检索与信封关联的所有参与者。
按信封 ID 创建参与者
向信封中添加一个或多个参与者。为单个参与者提供一个项目，或为批量请求提供多个项目。每个参与者指定：
- email — 参与者的电子邮件地址。
- role — signer （可以为签名分配字段）或 cc （只读访问权限）。
- authentication （高级，可选） - 当前 访问代码：参与者在签名之前必须提供的静态访问代码。仅当参与者在签名前应进行身份验证时，才打开此部分。
按 ID 更新参与者
更新参与者的身份验证设置。无法更改参与者电子邮件。
按 ID 删除参与者
永久删除信封中的参与者。

5. 下载

在文档签名并密封后检索完成的文件。

下载原始信封
将信封中的原始未签名文档下载为 ZIP 存档。
下载密封信封
将密封的签名文档以及审核线索下载为 ZIP 存档。
按 ID 下载密封文档
将单个密封的签名文档下载为 PDF 文件。
下载信封的审核线索
将信封的完整审核线索下载为 PDF 文件。

下载操作公开选取器本机 文件名 和 文件内容 令牌（加上 文件内容类型）。将文件内容直接拖放到下游步骤的文件输入（例如OneDrive/SharePoint创建文件）中，将文件名放入其文件名输入中。不需要body('Action_Name')表达式或手动键入的文件名;连接器会将下载的 ZIP 或 PDF 包装到 JSON 信封中，因此Power Automate将这些令牌显示为普通动态内容令牌。

典型签名工作流

完整的签名流按顺序链接上述操作。常见的Power Automate流如下所示：

创建信封 - 设置名称、通知主题/正文和签名模式（parallel 或 sequential）。保存返回的 信封 ID。
按信封 ID 创建文档 — 将一个或多个文件上传到信封（使用步骤 1 中的信封 ID）。保存每个返回 的文档 ID。
（可选）按信封 ID 对文档重新排序 - 设置文档顺序。
通过信封 ID 创建参与者（s） - 使用其访问代码身份验证添加签名者和抄送收件人。保存每个返回 的参与者 ID。
按文档 ID 创建字段 - 在每个文档上放置签名/日期/等字段，并将其分配给参与者（使用步骤 2 中的文档 ID 和步骤 3 中的参与者 ID）。
发送签名信封 - 调度信封。所有文档必须首先处于上传状态。
（挂起时）向信封发送提醒 以微移参与者，或 按 ID 取消信封 以停止请求。
（完成后）按 ID / 下载密封的信封 / 下载密封文档，下载信封的审核线索以检索完成的文件。

提示：创建操作返回的信封 ID、文档 ID 和参与者 ID 自然地通过Power Automate的动态内容选取器进入后续操作— 从上游操作中选取 ID 令牌，而不是键入。

错误和限制

Nitro Sign API 可能会返回以下错误：

400 — 错误的请求
401 - 未授权
404 - 找不到
409 - 冲突 （例如，在不允许操作的状态中处理信封）
413 - 内容太大
415 - 不支持的媒体类型
422 — 无法处理的实体
500 — 内部服务器错误

Throttling

每个连接的 API 调用数：每 60 秒100 次。

平台限制

文件大小

最大值： 每个请求 25 MB
适用于单文件和多文件操作。

页计数

最大值： 每个文档 250 页
跨多个文档的总合并页数可能超过 250。

保留时间

操作完成后，输入和输出文件将被删除 约 15 分钟 。

备注

信封、文档、字段和参与者管理操作返回 JSON。
下载操作返回 JSON 信封中包装的文件（ZIP 或 PDF），将 文件名、 文件内容类型和 文件内容 公开为选取器本机令牌，因此结果可以链接到没有表达式的下游文件操作中。
签名模式（parallel vs sequential）是在创建信封时设置的，可以在发送信封之前使用 更新信封 进行更改。
参与者身份验证目前仅支持 访问代码 。

正在创建连接

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


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

违约

适用：所有区域

用于创建连接的参数。

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

名称	类型	说明	必需
Nitro 客户端 ID	安全字符串	你的 Nitro 应用程序客户端 ID	是
Nitro 客户端机密	安全字符串	你的 Nitro 应用程序客户端密码	是
Nitro Region	字符串	选择帐户的 Nitro API 区域。	是

操作

下载信封的审核线索	下载包含所选 Nitro Sign 信封的完整审核线索的 PDF 文件。
下载原始信封	将来自 Nitro Sign 信封的原始未签名文档下载为 ZIP 存档。
下载密封信封	将密封的签名文档从 Nitro Sign 信封以及审核线索下载为 ZIP 存档。
列表信封	列表信封终结点返回与帐户中的应用程序关联的所有信封。
创建信封	创建一个新的 Nitro Sign 信封，稍后可以使用文档、参与者、字段和发送进行签名。
发送信封提醒	触发对指定 Nitro Sign 信封的挂起参与者的提醒通知。如果未提供通知设置，则使用为信封配置的默认通知模板。
发送签名信封	向参与者发送一个 Nitro Sign 信封以收集签名。在使用此操作之前，信封通常应包含使用“按信封 ID 创建文档”、“按信封 ID 创建参与者”和“创建字段”（s）添加的文档、参与者和签名字段。信封中的所有文档都必须处于上传状态，才能发送信封。
按 ID 下载密封文档	将一个密封的签名文档从一个 Nitro Sign 信封下载为 PDF 文件。
按 ID 删除信封	永久删除一个 Nitro 标志信封。此操作无法撤消，并且也会删除所有关联的文档、字段和参与者。
按 ID 删除参与者	从 Nitro Sign 信封中永久删除参与者。
按 ID 删除字段	从 Nitro Sign 信封中的文档永久删除字段。
按 ID 删除文档	从 Nitro Sign 信封中永久删除文档。
按 ID 取消信封	取消 Nitro Sign 信封的签名请求。只能取消已发送用于签名的信封。
按 ID 更新参与者	更新 Nitro Sign 信封中参与者的身份验证设置。无法更新参与者电子邮件。
按 ID 更新字段	更新 Nitro Sign 文档中现有字段的属性。必须提供字段类型，并且必须与现有字段类型匹配;API 使用它来标识字段架构，并且不会更改字段类型。
按 ID 更新文档	在 Nitro Sign 信封中更新现有文档的元数据。目前，只能更新文档名称。
按 ID 获取信封	使用其唯一信封 ID 检索特定 Nitro Sign 信封的详细信息。
按 ID 获取文档	检索 Nitro Sign 信封中特定文档的详细信息。
按信封 ID 列出参与者	检索与特定 Nitro Sign 信封关联的所有参与者。
按信封 ID 列出文档	检索与特定 Nitro Sign 信封关联的所有文档。
按信封 ID 创建参与者	将一个或多个参与者添加到一个 Nitro Sign 信封。若要添加单个参与者，请在“参与者”数组中提供一个项目。若要添加多个参与者，请提供多个项。
按信封 ID 创建文档	将文档上传到现有的 Nitro Sign 信封。稍后可以在签名工作流中使用该文档。
按信封 ID 对文档重新排序	根据提供的文档 ID 列表对与特定 Nitro Sign 信封关联的文档重新排序。
按文档 ID 列出字段	检索与 Nitro Sign 信封中的特定文档关联的所有字段。
按文档 ID 创建字段	在文档中创建一个或多个字段，并将其分配给参与者。若要创建单个字段，请在 Fields 数组中提供一项。若要创建多个字段，请提供多个项。
更新信封	更新现有的 Nitro Sign 信封。可以修改信封名称、通知设置、签名模式或这些字段的任意组合。

下载信封的审核线索

操作 ID:: DownloadAuditTrailOfEnvelope

下载包含所选 Nitro Sign 信封的完整审核线索的 PDF 文件。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识应下载其审核线索的信封。

下载的文件包装为 JSON 信封。

Body: FileDownloadResponse

下载原始信封

操作 ID:: DownloadOriginalEnvelope

将来自 Nitro Sign 信封的原始未签名文档下载为 ZIP 存档。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	唯一的 UUID，用于标识应下载其原始文档的信封。

下载的文件包装为 JSON 信封。

Body: FileDownloadResponse

下载密封信封

操作 ID:: DownloadSealedEnvelope

将密封的签名文档从 Nitro Sign 信封以及审核线索下载为 ZIP 存档。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识应下载其密封文档的信封。

下载的文件包装为 JSON 信封。

Body: FileDownloadResponse

列表信封

操作 ID:: ListEnvelopes

列表信封终结点返回与帐户中的应用程序关联的所有信封。

参数

名称	密钥	必需	类型	说明
Page After	pageAfter		string	用于检索下一页信封的可选游标标记。使用上一响应返回的 nextPage 值。
Page Before	pageBefore		string	用于检索上一页信封的可选游标标记。请勿与 Page After 一起使用。

名称	路径	类型	说明
信封	items	array of EnvelopeSummaryResponse	信封列表。
下一页	nextPage	string	可用作 Page After 的游标标记，用于检索下一页信封。

创建信封

操作 ID:: CreateEnvelope

创建一个新的 Nitro Sign 信封，稍后可以使用文档、参与者、字段和发送进行签名。

参数

名称	密钥	必需	类型	说明
信封名称	name	True	string	信封的名称。它不必是唯一的。
签名模式	mode	True	string	定义签名顺序。使用并行方式同时通知所有参与者，或按顺序按添加参与者的顺序通知参与者。
通知主题	subject	True	string	发送给签名参与者的电子邮件通知的主题行。支持动态变量，例如：$（sender_name_or_email）请求签名。
通知正文	body	True	string	发送给签名参与者的电子邮件正文。支持动态变量，例如：你好，\n请签署 $（envelope_name）\n谢谢，\n$（sender_name_or_email）。

请求或创建 Nitro Sign 信封后返回的响应。

Body: EnvelopeResponse

发送信封提醒

操作 ID:: SendRemindersForEnvelope

触发对指定 Nitro Sign 信封的挂起参与者的提醒通知。如果未提供通知设置，则使用为信封配置的默认通知模板。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	唯一的 UUID，用于标识应发送提醒通知的信封。
通知主题	subject		string	发送给签名参与者的电子邮件通知的主题行。支持动态变量，例如：$（sender_name_or_email）请求签名。
通知正文	body		string	发送给签名参与者的电子邮件正文。支持动态变量，例如：你好，\n请签署 $（envelope_name）\n谢谢，\n$（sender_name_or_email）。

发送签名信封

操作 ID:: SendEnvelopeForSigning

向参与者发送一个 Nitro Sign 信封以收集签名。在使用此操作之前，信封通常应包含使用“按信封 ID 创建文档”、“按信封 ID 创建参与者”和“创建字段”（s）添加的文档、参与者和签名字段。信封中的所有文档都必须处于上传状态，才能发送信封。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识要发送进行签名的信封的唯一 UUID。

有关 Nitro Sign 信封的摘要信息。

Body: EnvelopeSummaryResponse

按 ID 下载密封文档

操作 ID:: DownloadSealedDocumentByID

将一个密封的签名文档从一个 Nitro Sign 信封下载为 PDF 文件。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含密封文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识要下载的密封文档的唯一 UUID。

下载的文件包装为 JSON 信封。

Body: FileDownloadResponse

按 ID 删除信封

操作 ID:: DeleteEnvelopeByID

永久删除一个 Nitro 标志信封。此操作无法撤消，并且也会删除所有关联的文档、字段和参与者。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识要删除的信封的唯一 UUID。

按 ID 删除参与者

操作 ID:: DeleteParticipantByID

从 Nitro Sign 信封中永久删除参与者。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含参与者的信封的唯一 UUID。
参与者 ID	participantID	True	uuid	用于标识要删除的参与者的唯一 UUID。

按 ID 删除字段

操作 ID:: DeleteFieldByID

从 Nitro Sign 信封中的文档永久删除字段。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识包含字段的文档的唯一 UUID。
字段 ID	fieldID	True	uuid	用于标识要删除的字段的唯一 UUID。

按 ID 删除文档

操作 ID:: DeleteDocumentByID

从 Nitro Sign 信封中永久删除文档。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识要删除的文档的唯一 UUID。

按 ID 取消信封

操作 ID:: CancelEnvelopeByID

取消 Nitro Sign 信封的签名请求。只能取消已发送用于签名的信封。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识要取消的信封的唯一 UUID。

请求或创建 Nitro Sign 信封后返回的响应。

Body: EnvelopeResponse

按 ID 更新参与者

操作 ID:: UpdateParticipantByID

更新 Nitro Sign 信封中参与者的身份验证设置。无法更新参与者电子邮件。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含参与者的信封的唯一 UUID。
参与者 ID	participantID	True	uuid	用于标识要更新的参与者的唯一 UUID。
身份验证类型	type		string	Optional. 为参与者选择身份验证方法。如果指定，还应提供访问代码。
访问代码	accessCode		string	仅当指定身份验证类型时才是必需的。如果不需要参与者身份验证，请留空。

Nitro Sign 参与者详细信息。

Body: ParticipantResponse

按 ID 更新字段

操作 ID:: UpdateFieldByID

更新 Nitro Sign 文档中现有字段的属性。必须提供字段类型，并且必须与现有字段类型匹配;API 使用它来标识字段架构，并且不会更改字段类型。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识包含字段的文档的唯一 UUID。
字段 ID	fieldID	True	uuid	用于标识要更新的字段的唯一 UUID。
字段类型	type	True	string	要更新的字段的当前类型。 API 需要此值，并且必须与现有字段类型匹配;它不会更改字段类型。
参与者 ID	participantID		uuid	分配给字段的参与者的唯一标识符。
Page	page		integer	显示字段的页码。页面使用基于 1 的索引。
X 位置	x		float	Optional. 字段的水平位置，以磅为单位从页面左边缘测量。
Y 位置	y		float	Optional. 字段的垂直位置，以磅为单位从页面的上边缘测量。
宽度	width		float	Optional. 字段的宽度（以磅为单位）。
高度	height		float	Optional. 字段的高度（以磅为单位）。
必需	required		boolean	指示参与者是否必须完成此字段。
Format	format		string	字段格式（如果适用）。例如，日期字段可以使用 MM/DD/YYYY 等格式。
可修改	modifiable		boolean	指示字段值是否可修改（如果适用）。

Nitro Sign 字段详细信息。

Body: FieldResponse

按 ID 更新文档

操作 ID:: UpdateDocumentByID

在 Nitro Sign 信封中更新现有文档的元数据。目前，只能更新文档名称。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识要更新的文档的唯一 UUID。
文档名称	name	True	string	文档的新名称。

Nitro Sign 文档详细信息。

Body: DocumentResponse

按 ID 获取信封

操作 ID:: GetEnvelopeByID

使用其唯一信封 ID 检索特定 Nitro Sign 信封的详细信息。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识要检索的信封的唯一 UUID。

请求或创建 Nitro Sign 信封后返回的响应。

Body: EnvelopeResponse

按 ID 获取文档

操作 ID:: GetDocumentByID

检索 Nitro Sign 信封中特定文档的详细信息。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	用于标识要检索的文档的唯一 UUID。

Nitro Sign 文档详细信息。

Body: DocumentResponse

按信封 ID 列出参与者

操作 ID:: ListParticipantsByEnvelopeID

检索与特定 Nitro Sign 信封关联的所有参与者。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识应检索其参与者的信封。

列出与 Nitro Sign 信封关联的参与者时返回的响应。

Body: ParticipantsListResponse

按信封 ID 列出文档

操作 ID:: ListDocumentsByEnvelopeID

检索与特定 Nitro Sign 信封关联的所有文档。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识应检索其文档的信封。

列出与 Nitro Sign 信封关联的文档时返回的响应。

Body: ListDocumentsByEnvelopeIDResponse

按信封 ID 创建参与者

操作 ID:: CreateParticipantsByEnvelopeID

将一个或多个参与者添加到一个 Nitro Sign 信封。若要添加单个参与者，请在“参与者”数组中提供一个项目。若要添加多个参与者，请提供多个项。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识应在其中添加参与者的信封。
Email	email	True	email	参与者的电子邮件地址。
角色	role	True	string	参与者角色。签名者可以分配用于签名的字段。抄送参与者具有只读访问权限。
身份验证类型	type		string	Optional. 为参与者选择身份验证方法。如果指定，还应提供访问代码。
访问代码	accessCode		string	仅当指定身份验证类型时才是必需的。如果不需要参与者身份验证，请留空。

创建一个或多个参与者后返回的响应。

Body: ParticipantsResponse

按信封 ID 创建文档

操作 ID:: CreateDocumentByEnvelopeID

将文档上传到现有的 Nitro Sign 信封。稍后可以在签名工作流中使用该文档。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识将上载文档的信封。
文档名称	documentName	True	string	要上传的文档的名称。此值将用于生成发送到 Nitro 的文档元数据。
内容类型	contentType		string	上传的文档的内容类型。对于 PDF 文件，请使用 application/pdf。从元数据中省略时，仅接受 PDF 文件。
文档文件	payload	True	file	要上传到信封的文档文件。

名称	路径	类型	说明
文档编号	ID	uuid	标识已上传文档的唯一 UUID。
文档名称	name	string	上传的文档的名称。
创建时间	createdAt	string	指示创建文档的时间的时间戳。
文档状态	status	string	上传的文档的处理状态。

按信封 ID 对文档重新排序

操作 ID:: ReorderDocumentsByEnvelopeID

根据提供的文档 ID 列表对与特定 Nitro Sign 信封关联的文档重新排序。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	一个唯一的 UUID，用于标识其文档应重新排序的信封。
文档 ID	order	True	array of uuid	表示信封中文档的新顺序的文档 ID 数组。

列出与 Nitro Sign 信封关联的文档时返回的响应。

Body: ListDocumentsByEnvelopeIDResponse

按文档 ID 列出字段

操作 ID:: ListFieldsByDocumentID

检索与 Nitro Sign 信封中的特定文档关联的所有字段。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识包含文档的信封的唯一 UUID。
文档编号	documentID	True	uuid	一个唯一的 UUID，用于标识应检索其字段的文档。

创建一个或多个字段后返回的响应。

Body: FieldsResponse

按文档 ID 创建字段

操作 ID:: CreateFieldsByDocumentID

在文档中创建一个或多个字段，并将其分配给参与者。若要创建单个字段，请在 Fields 数组中提供一项。若要创建多个字段，请提供多个项。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识信封的唯一 UUID。
文档编号	documentID	True	uuid	一个唯一的 UUID，用于标识应在其中创建字段的文档。
参与者 ID	participantID	True	uuid	分配给字段的参与者的唯一标识符。
Page	page	True	integer	应放置字段的页码。页面使用基于 1 的索引，因此第一页为 1。
字段类型	type	True	string	要创建的字段的类型。
X 位置	x	True	float	字段的水平位置，以磅为单位从页面左边缘测量。
Y 位置	y	True	float	字段的垂直位置，以磅为单位从页面的上边缘测量。
宽度	width	True	float	字段的宽度（以磅为单位）。
高度	height	True	float	字段的高度（以磅为单位）。
必需	required		boolean	指示参与者是否必须完成此字段。
Format	format		string	支持格式的字段类型的可选格式，例如日期字段。示例：MM/DD/YYYY。
可修改	modifiable		boolean	指示参与者是否可以修改字段值，其中字段类型支持。

创建一个或多个字段后返回的响应。

Body: FieldsResponse

更新信封

操作 ID:: UpdateEnvelope

更新现有的 Nitro Sign 信封。可以修改信封名称、通知设置、签名模式或这些字段的任意组合。

参数

名称	密钥	必需	类型	说明
信封 ID	envelopeID	True	uuid	用于标识要更新的信封的唯一 UUID。
信封名称	name		string	更新后的信封名称。它不必是唯一的。
通知主题	subject		string	发送给签名参与者的电子邮件通知的主题行。支持动态变量，例如：$（sender_name_or_email）请求签名。
通知正文	body		string	发送给签名参与者的电子邮件正文。支持动态变量，例如：你好，\n请签署 $（envelope_name）\n谢谢，\n$（sender_name_or_email）。
签名模式	mode		string	定义签名顺序。使用并行方式同时通知所有参与者，或按顺序按添加参与者的顺序通知参与者。

请求或创建 Nitro Sign 信封后返回的响应。

Body: EnvelopeResponse

定义

EnvelopeNotification

一个 Nitro Sign 信封的通知电子邮件设置。

名称	路径	类型	说明
通知主题	subject	string	发送给签名参与者的电子邮件通知的主题行。支持动态变量，例如：$（sender_name_or_email）请求签名。
通知正文	body	string	发送给签名参与者的电子邮件正文。支持动态变量，例如：你好，\n请签署 $（envelope_name）\n谢谢，\n$（sender_name_or_email）。

EnvelopeSummaryResponse

有关 Nitro Sign 信封的摘要信息。

名称	路径	类型	说明
信封 ID	ID	uuid	用于标识信封的唯一 UUID。
创建时间	createdAt	date-time	指示何时创建信封的 UTC 时间戳。
上次修改时间	lastModifiedAt	date-time	指示信封上次修改时间的 UTC 时间戳。
信封名称	name	string	信封的名称。
信封状态	status	string	信封的内部状态。

EnvelopeResponse

请求或创建 Nitro Sign 信封后返回的响应。

名称	路径	类型	说明
信封 ID	ID	uuid	用于标识信封的唯一 UUID。
创建时间	createdAt	date-time	指示何时创建信封的 UTC 时间戳。
上次修改时间	lastModifiedAt	date-time	指示信封上次修改时间的 UTC 时间戳。
信封名称	name	string	信封的名称。
信封状态	status	string	信封的内部状态。
签名模式	mode	string	为信封配置的签名模式。
通知	notification	EnvelopeNotification	一个 Nitro Sign 信封的通知电子邮件设置。

ListDocumentsByEnvelopeIDResponse

列出与 Nitro Sign 信封关联的文档时返回的响应。

名称	路径	类型	说明
文档	items	array of DocumentResponse	与信封关联的文档列表。

DocumentResponse

Nitro Sign 文档详细信息。

名称	路径	类型	说明
文档编号	ID	uuid	标识文档的唯一 UUID。
文档名称	name	string	文档的名称。
创建时间	createdAt	date-time	指示文档创建时间的 UTC 时间戳。
大小（以字节为单位）	sizeBytes	integer	文档大小（以字节为单位）。
页数	numPages	integer	文档中的页数。
文档状态	status	string	文档的当前状态。

FieldsResponse

创建一个或多个字段后返回的响应。

名称	路径	类型	说明
Fields	items	array of FieldResponse	在此请求中创建的字段。

FieldResponse

Nitro Sign 字段详细信息。

名称	路径	类型	说明
字段 ID	ID	uuid	标识字段的唯一 UUID。
参与者 ID	participantID	uuid	分配给字段的参与者的唯一标识符。
文档编号	documentID	uuid	字段所属的文档的唯一标识符。
Page	page	integer	显示字段的页码。
边界框	boundingBox	array of float	采用 [x， y， width， height] 格式的四个数字的数组，以磅为单位。
必需	required	boolean	指示参与者是否必须完成此字段。
字段类型	type	string	字段的类型。
Format	format	string	字段格式（如果适用）。
可修改	modifiable	boolean	指示字段值是否可修改（如果适用）。

ParticipantsResponse

创建一个或多个参与者后返回的响应。

名称	路径	类型	说明
Participants	items	array of ParticipantResponse	在此请求中创建的参与者。

ParticipantsListResponse

列出与 Nitro Sign 信封关联的参与者时返回的响应。

名称	路径	类型	说明
Participants	items	array of ParticipantResponse	与信封关联的参与者。
参与者总数	total	integer	集合中可用的参与者总数。

ParticipantResponse

Nitro Sign 参与者详细信息。

名称	路径	类型	说明
参与者 ID	ID	uuid	标识参与者的唯一 UUID。
Email	email	email	参与者的电子邮件地址。
角色	role	string	参与者的角色。
身份验证	authentication	ParticipantAuthenticationResponse	为参与者返回的身份验证设置。

ParticipantAuthenticationResponse

为参与者返回的身份验证设置。

名称	路径	类型	说明
身份验证类型	type	string	参与者身份验证类型。
访问代码	accessCode	string	为参与者配置的访问代码。

FileDownloadResponse

下载的文件包装为 JSON 信封。

名称	路径	类型	说明
文件名	fileName	string	下载的文件的名称，派生自响应 Content-Disposition 标头（例如 result.zip 或 result.pdf）。将此令牌直接拖放到下游操作的文件名输入中，例如OneDrive或SharePoint创建文件。
文件内容类型	fileContentType	string	下载文件的 MIME 类型，例如 application/zip 或 application/pdf。
文件内容	fileContent	byte	base64 编码的文件内容。将此令牌直接拖放到下游操作的文件内容输入（例如OneDrive或SharePoint创建文件或其他 Nitro 操作）- 无需表达式。