通过


RSign (预览版)

RSign® 是一个安全、具有法律约束力的电子签名平台,可简化文档工作流。 此连接器使用户能够自动发送签名请求、跟踪实时信封状态以及检索已完成的签名文档和签名证书。 它通过数字化文档执行并确保安全、可跟踪的数字事务来提高业务效率。

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

服务 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 RSign 支持
URL https://rsign.com/contact/questions
Email support@rpost.com
连接器元数据
Publisher RPost US Inc
Publisher RPost US Inc
网站 https://rpost.com/
隐私策略 https://rpost.com/legal-notices/privacy-notice
类别 内容和文件;生产力

RSign 自定义连接器概述

连接器名称: RSign 说明: RSign® 是一个电子签名和数字事务管理平台,用于安全、合法绑定和简化的文档工作流。 出版商: RPost

1. 连接器功能

RSign® 连接器提供对电子签名和文档管理功能的访问权限,使用户能够将 RSign 工作流直接集成到其 Power Platform 解决方案(Power Automate、Power Apps 和逻辑应用) 中。

关键作

连接器当前支持以下主要作:

  • 获取 AuthToken: 基于 RSign® 凭据对用户进行身份验证,并检索所有后续 API 调用所需的必要令牌(AuthToken)。
  • 使用模板发送信封: 使用预配置的 RSign® 模板发送用于电子签名的文档,将模板角色映射到特定收件人。
  • 使用规则发送信封: 使用预配置的 RSign® 规则发送用于电子签名的文档,从而允许在请求正文中以 Base64 数据的形式提供文档。
  • 检索模板信息: 获取有关特定 RSign® 模板或规则的详细信息,包括定义的文档和收件人角色(RoleID)。
  • 检索信封状态: 使用信封代码检索电子签名请求的状态。
  • 检索信封文档: 下载与信封代码(原始和/或最终签名文档)关联的文档。

2.身份验证设置

RSign® 连接器使用自定义身份验证方案,在执行任何其他作之前,需要成功调用 Get AuthToken 该作。

身份验证作 (Get AuthToken

此作需要以下凭据,必须从 RSign® 平台获取这些凭据:

参数名称 类型 Description 能见度
ReferenceKey 字符串 与 RPost® 帐户关联的引用密钥。 重要
EmailId 字符串 RSign® 帐户的电子邮件地址。 重要
Password 密码 RSign® 帐户的密码。 重要

使用 AuthToken

Get AuthToken 作返回响应正文中的值 AuthToken 。 然后,必须在后续 API 调用中将此令牌传递给所有其他受支持的作。

注意:AuthToken 令牌的过期时间(AuthTokenExpires)应在流或应用程序逻辑中进行管理,以确保在现有令牌过期时使用新的令牌。

3. 先决条件

若要成功使用此 RSign® 自定义连接器,用户必须满足以下要求:

  • 有效的 RSign® 许可证: 用户必须具有有效的 RSign® 用户许可证。
  • API 访问: 与提供的凭据关联的 RSign® 帐户必须 启用并支付 API 访问功能。 生成并成功利用 RSign® 连接器需要 ReferenceKey 此功能。

如果当前不满足这些要求,或者不确定当前的 RSign® 帐户设置,请联系 RPost® 代表。

4. 集成的重要说明

模板和规则用法

  • 模板代码/规则代码: 这两 Send Envelope 个作都需要标识 TemplateCode RSign® 中预配置的文档和签名字段的(或规则代码)。
  • 角色映射: 发送信封时, TemplateRoleRecipientMapping 必须填充数组。 RoleID必须先使用Retrieve Template Information作检索每个收件人。 这可确保收件人正确映射到模板中定义的签名字段。

文档处理

  • 使用规则发送信封: 此作要求将文档内容作为 Base64 编码字符串传递(DocumentBase64Data)。
  • 检索信封文档: 文档以 Base64 字符串的形式在响应正文中返回(ByteArray)。 使用流必须解码此字符串才能保存文件。

错误处理

所有作都会返回响应正文中的状态信息,包括:

  • StatusCode (整数)
  • StatusMessage(字符串)
  • Message(字符串)

用户应根据 StatusCode 确保成功执行作来实现错误检查。

限制

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

操作

使用模板发送信封

使用指定的 RSign 模板向所选收件人发送 eSign 请求。

使用规则发送信封

使用指定的 RSign 规则向所选收件人发送 eSign 请求。

检索信封文档

根据信封代码检索信封的文档部分。 它将根据信封状态检索原始文档和/或最终签名文档。

检索信封状态

根据信封代码检索信封的状态。 可以选择详细报表或汇总报表。

检索模板信息

根据模板或规则的代码检索有关模板或规则的信息。 返回的信息包括定义模板名称、文档和角色。

获取 AuthToken

返回要用于所有其他 RSign 支持的作中的 AuthToken。

使用模板发送信封

使用指定的 RSign 模板向所选收件人发送 eSign 请求。

参数

名称 密钥 必需 类型 说明
身份验证令牌
AuthToken True string

从“获取 AuthToken”作检索到的 AuthToken。

TemplateCode
TemplateCode True string

要使用的模板的 ID。

应用密钥
AppKey string

使用连接器的系统的唯一标识符。 请向 RPost® 支持部门请求它。

RoleID
RoleID True string

收件人的角色 ID。 从“检索模板信息”作中检索。

RecipientEmail
RecipientEmail True string

收件人的电子邮件地址。

RecipientName
RecipientName True string

收件人的名称。

手机
Mobile string

收件人的移动电话号码。 如果模板不需要它,请留空。

返回

名称 路径 类型 说明
信封代码
EnvelopeCode string

信封的 ID。

透明度更改消息
TransparencyChangedMessage string

透明度更改了消息。

基于语言的 API 消息
LanguageBasedApiMessge string

基于语言的 API 消息。

预填充收件人 ID
PrefillRecipientId string

预填充收件人 ID。

发送导航页面后
PostSendingNavigationPage string

收件人在完成信封签名后将重定向到的网站。

已启用新签名者 UI
IsNewSignerUIEnabled boolean

已启用新签名者 UI。

状态代码
StatusCode integer

响应状态代码。

状态消息
StatusMessage string

响应状态消息。

Message
Message string

响应状态说明。

信封 ID
EnvelopeId string

生成的信封的内部 ID。

对文档 URL 进行签名
SignDoumentUrl string

信封签名的全局 URL。

收件人列表
RecipientList array of object

收件人详细信息

收件人姓名
RecipientList.RecipientName string

当前信封的收件人部分的名称。

收件人电子邮件
RecipientList.RecipientEmail string

当前信封的收件人部分的电子邮件地址。

下单
RecipientList.Order integer

收件人需要访问才能完成信封的顺序。

类型
RecipientList.Type string

当前信封的收件人部分的类型。 可能的值包括:签名者和预填充。

传递模式
RecipientList.DeliveryMode integer

指示签名请求和访问代码发送到收件人的通道。

拨号代码
RecipientList.DialCode string

发送签名请求和访问代码的国家/地区的拨号代码。

国家/地区代码
RecipientList.CountryCode string

发送签名请求和访问代码的国家/地区的代码。

手机号
RecipientList.Mobile string

收件人的移动电话号码。

移动模式
RecipientList.MobileMode integer

指示通过移动通道向收件人发送签名请求和访问代码。

签名 URL
RecipientList.SigningUrl string

收件人用来访问和签名信封的 URL。

拨号代码下拉列表
DialCodeDropdownList string

拨号代码下拉列表。

启用到移动的消息
EnableMessageToMobile string

启用到移动的消息。

使用规则发送信封

使用指定的 RSign 规则向所选收件人发送 eSign 请求。

参数

名称 密钥 必需 类型 说明
身份验证令牌
AuthToken True string

从“获取 AuthToken”作检索到的 AuthToken。

TemplateCode
TemplateCode True string

要使用的规则的 ID。

Name
Name True string

文档名称。 包括扩展(示例:Agreement.docx)。

DocumentBase64Data
DocumentBase64Data True string

要以 Base64 格式发送的文档。

应用密钥
AppKey string

使用连接器的系统的唯一标识符。 请向 RPost® 支持部门请求它。

RoleID
RoleID True string

收件人的角色 ID。 从“检索模板信息”作中检索。

RecipientEmail
RecipientEmail True string

收件人的电子邮件地址。

RecipientName
RecipientName True string

收件人的名称。

手机
Mobile string

收件人的移动电话号码。 如果规则不需要,请留空。

返回

名称 路径 类型 说明
信封代码
EnvelopeCode string

信封的 ID。

透明度更改消息
TransparencyChangedMessage string

透明度更改了消息。

基于语言的 API 消息
LanguageBasedApiMessge string

基于语言的 API 消息。

预填充收件人 ID
PrefillRecipientId string

预填充收件人 ID。

发送导航页面后
PostSendingNavigationPage string

收件人在完成信封签名后将重定向到的网站。

已启用新签名者 UI
IsNewSignerUIEnabled boolean

已启用新签名者 UI。

状态代码
StatusCode integer

响应状态代码。

状态消息
StatusMessage string

响应状态消息。

Message
Message string

响应状态说明。

信封 ID
EnvelopeId string

生成的信封的内部 ID。

对文档 URL 进行签名
SignDoumentUrl string

信封签名的全局 URL。

收件人列表
RecipientList array of object

收件人详细信息

收件人姓名
RecipientList.RecipientName string

收件人的名称。

收件人电子邮件
RecipientList.RecipientEmail string

收件人的电子邮件地址。

下单
RecipientList.Order integer

收件人需要访问才能完成信封的顺序。

类型
RecipientList.Type string

当前信封的收件人部分的类型。 可能的值包括:签名者和预填充。

传递模式
RecipientList.DeliveryMode integer

指示签名请求和访问代码发送到收件人的通道。

拨号代码
RecipientList.DialCode string

发送签名请求和访问代码的国家/地区的拨号代码。

国家/地区代码
RecipientList.CountryCode string

发送签名请求和访问代码的国家/地区的代码。

手机号
RecipientList.Mobile string

收件人的移动电话号码。

移动模式
RecipientList.MobileMode integer

指示通过移动通道向收件人发送签名请求和访问代码。

签名 URL
RecipientList.SigningUrl string

收件人用来访问和签名信封的 URL。

拨号代码下拉列表
DialCodeDropdownList string

拨号代码下拉列表。

启用到移动的消息
EnableMessageToMobile string

启用到移动的消息。

检索信封文档

根据信封代码检索信封的文档部分。 它将根据信封状态检索原始文档和/或最终签名文档。

参数

名称 密钥 必需 类型 说明
信封代码
EnvelopeCode True string

要检索的信封的代码。

身份验证令牌
AuthToken True string

从“获取 AuthToken”作检索到的 AuthToken。

返回

名称 路径 类型 说明
状态
Status boolean

状态成功标志。

状态代码
StatusCode integer

响应状态代码。

Message
Message string

响应状态说明。

状态消息
StatusMessage string

响应状态消息。

信封代码
Data.EnvelopeCode string

作为参数传递的信封代码。

文档列表
Data.DocumentList array of object

文档列表。

文档类型
Data.DocumentList.DocumentType string

附件的类型。

文件名
Data.DocumentList.FileName string

文件的名称。

Description
Data.DocumentList.Description string

文档的说明。

字节数组
Data.DocumentList.ByteArray string

Base64 格式的文件。

其他信息
Data.DocumentList.AdditionalInfo string

其他信息。

附件说明
Data.DocumentList.AttachmentDescription string

文件内容的信息性说明。

阅读我
Data.ReadMe string

Base64 格式的文本文件,指示已签名文档的名称和原始文件。

组合 Zip
Data.CombinedZip string

包含信封的所有文档的 Zip 文件。

总数
TotalCount integer

总计计数。

附件上传是否存在
IsAttachmentUploadsExist string

附件上传是否存在。

检索信封状态

根据信封代码检索信封的状态。 可以选择详细报表或汇总报表。

参数

名称 密钥 必需 类型 说明
身份验证令牌
AuthToken True string

从“获取 AuthToken”作检索到的 AuthToken。

EnvelopeCode
EnvelopeCode True string

信封代码。

DetailOrSummary
DetailOrSummary True string

选择所需的报表类型。

返回

名称 路径 类型 说明
状态
Status boolean

请求的状态。

状态代码
StatusCode integer

响应状态代码。

Message
Message string

响应状态说明。

状态消息
StatusMessage string

响应状态消息。

信封数据列表
Data array of object
信封代码
Data.EnvelopeCode string

信封的 ID。

信封 ID
Data.EnvelopeID string

信封的内部 ID。

Subject
Data.Subject string

信封的电子邮件主题。

信封状态
Data.Status string

所请求信封的状态。

IsEnvelopeComplete
Data.IsEnvelopeComplete boolean

指示信封是否已完成。

发送日期
Data.SentDate string

发送信封的日期。

最后修改日期
Data.LastModifiedDate string

上次修改日期。

SenderName
Data.SenderName string

发件人的名称。

SenderEmail
Data.SenderEmail string

发件人的电子邮件。

收件人详细信息
Data.RecipientDetails array of object
收件人 ID
Data.RecipientDetails.RecipientID string

当前信封的收件人部分的 ID。

收件人类型 ID
Data.RecipientDetails.RecipientTypeID string

当前信封的收件人部分的类型 ID。

收件人类型
Data.RecipientDetails.RecipientType string

当前信封的收件人部分的类型。 可能的值包括:签名者和预填充。

收件人姓名
Data.RecipientDetails.RecipientName string

收件人的名称。

Email
Data.RecipientDetails.Email string

收件人的电子邮件地址。

下单
Data.RecipientDetails.Order integer

收件人需要访问才能完成信封的顺序。

StatusID
Data.RecipientDetails.StatusId string

状态 ID。

签名状态
Data.RecipientDetails.SigningStatus string

信封收件人的签名状态。

上次修改日期
Data.RecipientDetails.LastModifiedDate string

上次修改日期。

参考代码
Data.ReferenceCode string

引用当前信封的代码部分。

引用电子邮件
Data.ReferenceEmail string

引用当前信封的电子邮件部分。

TotalCount
TotalCount integer

符合所请求条件的信封总数。

IsAttachmentUploadsExist
IsAttachmentUploadsExist string

附件上传是否存在。

检索模板信息

根据模板或规则的代码检索有关模板或规则的信息。 返回的信息包括定义模板名称、文档和角色。

参数

名称 密钥 必需 类型 说明
模板代码
TemplateCode True string

要检索的模板的代码。

身份验证令牌
AuthToken True string

从“获取 AuthToken”作检索到的 AuthToken。

返回

名称 路径 类型 说明
状态代码
StatusCode integer

响应状态代码。

状态消息
StatusMessage string

响应状态消息。

Message
Message string

响应状态说明。

模板 ID
TemplateId string

模板 ID。

模板 ID
TemplateBasicInfo.TemplateId string

模板 ID。

模板代码
TemplateBasicInfo.TemplateCode integer

用于其他作的模板代码。

用户电子邮件
TemplateBasicInfo.UserEmail string

模板的用户所有者的电子邮件。

模板名称
TemplateBasicInfo.TemplateName string

模板的名称。

模板说明
TemplateBasicInfo.TemplateDescription string

模板的说明。

是静态的
TemplateBasicInfo.IsStatic string

指示是否可以修改模板。

过期日期
TemplateBasicInfo.ExpiryDate string

模板过期的日期。

创建日期
TemplateBasicInfo.CreatedDate string

创建模板的日期。

上次修改日期
TemplateBasicInfo.LastModifiedDate string

上次修改模板的日期。

Subject
TemplateBasicInfo.Subject string

电子邮件模板主题。

Body
TemplateBasicInfo.Body string

电子邮件模板正文。 HTML 编码。

类型名称
TemplateBasicInfo.TypeName string

模板类型(可能的值:模板,规则)。

文档列表
TemplateBasicInfo.DocumentList array of object

文档列表。

文档 ID
TemplateBasicInfo.DocumentList.DocumentId string

模板的文档部分的 ID。

文档名称
TemplateBasicInfo.DocumentList.DocumentName string

模板的文档部分的名称。

下单
TemplateBasicInfo.DocumentList.Order integer

模板文档列表中的文档部件的顺序。

文档内容详细信息
TemplateBasicInfo.DocumentList.documentContentDetails array of object

文档内容详细信息。

控制 ID
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID string

文档中使用的控件的内部 ID。

控件名称
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName string

文档中使用的控件的名称。

控件 Html ID
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID string

文档中使用的控件的 HTML ID。

组名称
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName string

包含控件的组的名称。

标签
TemplateBasicInfo.DocumentList.documentContentDetails.Label string

要显示在文档中的控件的名称。

页号
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo integer

控件所在的文档中的页面。

必选
TemplateBasicInfo.DocumentList.documentContentDetails.Required boolean

是否需要控件。

控件值
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue string

控件的预填充值。

角色 ID
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId string

需要填充控件的角色的 ID。

角色名称
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName string

需要填充控件的角色的名称。

选择控件选项
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions array of string

选择“控件选项”。

模板角色列表
TemplateBasicInfo.TemplateRoleList array of object

收件人列表。

角色 ID
TemplateBasicInfo.TemplateRoleList.RoleID string

此模板的角色部分的 ID。

角色名称
TemplateBasicInfo.TemplateRoleList.RoleName string

此模板的角色部分的名称。

下单
TemplateBasicInfo.TemplateRoleList.Order integer

角色(收件人)需要完成模板的顺序。

收件人电子邮件
TemplateBasicInfo.TemplateRoleList.RecipientEmail string

此模板的收件人部分的预填充电子邮件。

收件人姓名
TemplateBasicInfo.TemplateRoleList.RecipientName string

此模板的收件人部分的预填充名称。

收件人类型 ID
TemplateBasicInfo.TemplateRoleList.RecipientTypeID string

收件人类型的内部 ID。

收件人 ID
TemplateBasicInfo.TemplateRoleList.RecipientID string

此模板的收件人部分的 ID。

收件人类型
TemplateBasicInfo.TemplateRoleList.RecipientType string

收件人的类型。

抄送签名者类型
TemplateBasicInfo.TemplateRoleList.CcSignerType string

抄送收件人类型。

区域性信息
TemplateBasicInfo.TemplateRoleList.CultureInfo string

它是创建模板/规则时用户的服务语言。

传递模式
TemplateBasicInfo.TemplateRoleList.DeliveryMode integer

指示签名请求和访问代码发送到收件人的通道。

拨号代码
TemplateBasicInfo.TemplateRoleList.DialCode string

发送签名请求和访问代码的国家/地区的拨号代码。

国家/地区代码
TemplateBasicInfo.TemplateRoleList.CountryCode string

发送签名请求和访问代码的国家/地区的代码。

手机号
TemplateBasicInfo.TemplateRoleList.Mobile string

收件人的移动电话号码。

移动模式
TemplateBasicInfo.TemplateRoleList.MobileMode integer

指示通过移动通道向收件人发送签名请求和访问代码。

电子邮件地址
TemplateBasicInfo.TemplateRoleList.EmailAddress string

收件人的电子邮件地址。

启用到移动的消息
TemplateBasicInfo.EnableMessageToMobile boolean

启用到移动的消息。

静态链接到期日期
TemplateBasicInfo.StaticLinkExpiryDate string

静态链接到期日期。

模板列表
TemplateList string

模板列表。

获取 AuthToken

返回要用于所有其他 RSign 支持的作中的 AuthToken。

参数

名称 密钥 必需 类型 说明
ReferenceKey
ReferenceKey True string

公司帐户的唯一标识符。

EmailId
EmailId True string

RSign 帐户的电子邮件地址。

密码
Password True password

RSign 帐户的密码。

返回

名称 路径 类型 说明
身份验证消息
AuthMessage string

响应状态消息。

身份验证令牌
AuthToken string

要用于其他 RSign作的身份验证令牌。

刷新令牌
RefreshToken string

刷新令牌。

刷新令牌过期
RefreshTokenExpires string

当前刷新令牌过期的日期。

身份验证令牌过期
AuthTokenExpires string

当前身份验证令牌过期的日期。

电子邮件 ID
EmailId string

经过身份验证的用户的电子邮件。

API Id
ApiId string

API ID。