集成 DocuSign

部署 DocuSign 集成以使用 Citrix Workspace 从任何设备发送和接收数字签名的信封。用户可以启动新模板进行签名、收到任何新待处理文档的通知,以及查看之前在 DocuSign 收件箱中发送或接收的信封列表。

注意:

我们想要你的反馈!请在使 对此集成模板的反馈 用时提供。对 专用论坛 于任何问题,我们的团队也会每天监控我们的。

有关 DocuSign 的开箱即用微应用的全面详细信息,请参阅 使用 DocuSign 微应用

检查必备项

这些先决条件假定管理员是组织 DocuSign 集成设置的一部分。此 DocuSign 管理员帐户必须具有用户信息的完全读取权限。

与 DocuSign 设置此集成后,您需要使用这些项目来添加 Citrix Workspace 微应用程序中的集成,特别是以下用于设置 OAuth 集成的参数列表:

  • 基本 URL:附加终端节点路径的基本 URL。您可以从应用程序和密钥下的服务帐户中收集基本 URL。基本 URL 格式:{baseURL fetched from sevice account}/restapi/2.1/。有关如何查找基本 URL,请参阅 配置 OAuth 服务器
  • DocuSign 帐户 ID:您的 docusign 管理员帐户 ID。请参阅 配置 OAuth 服务器
  • 环境 URL:例如来自基本 URL https://{yourEnvironmentalURL}.docusign.net/restapi/v2.1/
  • 授权 URLhttps://account-d.docusign.com/oauth/auth
  • 令牌 URLhttps://account-d.docusign.com/oauth/token
  • 客户端 ID:客户端 ID 是表示授权服务器唯有的客户端注册信息的字符串。此外,DocuSign 的所有应用程序密钥必须通过 DocuSign 上线流程。这适用于 集成密钥 (ClientiD)。这可能需要长达一周的时间。有关 DocuSign 上线流程的更多信息,请参阅 https://developers.docusign.com/docs/esign-rest-api/go-live/
  • 客户端密钥:客户端密码是设置目标应用程序集成时发出的唯一字符串。

注意:

我们建议您始终使用 OAuth 2.0 作为服务身份验证方法(如果可用)。OAuth 2.0 可确保您的集成符合您配置的微应用的最大安全合规性。

将 Citrix Gateway 配置为支持 DocuSign 的单点登录,以便用户登录后他们将自动再次登录,而无需再次输入凭据。有关配置 SSO 的详细信息,请参阅Citrix Gateway 服务

可以向特定资源发出的 API 请求数量有限,因此我们建议采取以下措施:

DocuSign API 限制表单链接:https://developers.docusign.com/docs/esign-soap-api/esign101/security/call-limits/

创建新的服务帐户

在这里注册: https://admin.docusign.com. 您可以在此处查看用户权限配置文件:https://support.docusign.com/en/guides/ndse-admin-guide-permission-sets。如果你想访问 eSignature Admin 的演示版本,请改用以下 URL:https://admindemo.docusign.com。有关新服务帐号的详细信息,请参阅:https://support.docusign.com/en/guides/org-admin-guide-getting-started

配置 OAuth 服务器

将 OAuth 服务器配置为通过 DocuSign 集成读取数据。

  1. 使用您的服务帐号登录电子签名管理员:https://admin.docusign.com。对于 eSignature Admin 的演示版本:https://admindemo.docusign.com。有关详细信息,请参阅:https://support.docusign.com/en/guides/ndse-admin-guide-accesshttps://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration
  2. 转到导航栏中的设置
  3. 在设置页面上,选择应用程序和密钥,然后选择添加应用程序和集成密钥
  4. 输入应用程序名称,然后选择添加
  5. 选择 + 添加密钥以生成密钥。
  6. 输入重定向 URI:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. 复制并保存屏幕上显示的集成密钥密钥客户端 ID密钥)。配置集成时,您将这些详细信息用于服务身份验证
  8. 复制并保存帐户的基本 URI
  9. 复制并保存 DocuSign 账户 ID

此外,DocuSign 的所有应用程序密钥必须通过 DocuSign 上线流程。这适用于 集成密钥 (ClientiD)。这可能需要长达一周的时间。有关 DocuSign 上线流程的更多信息,请参阅 https://developers.docusign.com/docs/esign-rest-api/go-live/

配置 OAuth 客户端

将 OAuth 客户端配置为通过 DocuSign 集成写回数据。

  1. 使用您的服务帐号登录电子签名管理员:https://admin.docusign.com。对于 eSignature Admin 的演示版本:https://admindemo.docusign.com。有关详细信息,请参阅:https://support.docusign.com/en/guides/ndse-admin-guide-accesshttps://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration
  2. 转到导航栏中的设置
  3. 在设置页面上,选择应用程序和密钥,然后选择添加应用程序和集成密钥
  4. 输入应用程序名称,然后选择添加
  5. 选择 + 添加密钥以生成密钥。
  6. 输入重定向 URI:https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  7. 复制并保存屏幕上显示的集成密钥密钥客户端 ID密钥)。配置集成时,您将这些详细信息用于服务操作身份验证

此外,DocuSign 的所有应用程序密钥必须通过 DocuSign 上线流程。这适用于 集成密钥 (ClientiD)。这可能需要长达一周的时间。有关 DocuSign 上线流程的更多信息,请参阅 https://developers.docusign.com/docs/esign-rest-api/go-live/

配置组织

将帐户链接到您的组织。您用于创建组织的帐户将自动链接。

  1. 在 eSignature 管理员主页中,选择开始使用。如果您在 DocuSign 帐户中没有看到此选项,则不会在该帐户上启用 DocuSign 管理员。请联系您的 DocuSign 客户经理寻求帮助。
  2. 在提供的字段中输入组织名称和可选的说明,然后选择下一步
  3. 选择创建以完成组织的创建。有关详细信息,请参阅https://support.docusign.com/en/guides/org-admin-guide-create-org
  4. 转到组织管理员控制面板。选择连接的应用程序,然后选择授权应用程序
  5. 选择您在配置 OAuth 服务器和客户端时输入和创建的应用程序名称。选择添加以提供权限。
  6. 输入这些范围。有关详细信息,请参阅https://developers.docusign.com/platform/auth/reference/scopes
    • 对于服务身份验证,请选择您在配置 OAuth 服务器中创建的应用程序名称,提供 user_read 权限,然后选择添加
    • 对于服务操作身份验证,请选择您在配置 OAuth 客户端中创建的应用程序名称,提供 user_write 权限,然后选择添加

将集成添加到 Citrix Workspace 微应用

将 DocuSign 集成添加到 Citrix Workspace 微应用程序以连接到应用程序。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。这样可以提供现成的微应用,以及可以在 Workspace 内使用的预配置通知和操作。

请按照以下步骤进行操作:

  1. 微应用集成页面中,选择添加新集成,然后选择从 Citrix 提供的模板添加新集成
  2. 选择 DocuSign 磁贴。
  3. 输入集成的集成名称
  4. 输入连接器参数
    • 输入实例 基本 URL
    • 图标 库中选择集成的图标,或将其保留为默认图标。

    DocuSign 参数

  5. 输入您的 DocuSign 账户 ID。请参阅 配置 OAuth 服务器
  6. 服务身份验证下,从身份验证方法菜单中选择 OAuth 2.0,然后填写身份验证详细信息。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为服务身份验证方法(如果可用)。OAuth 2.0 可确保您的集成符合您配置的微应用的最大安全合规性。

    1. 授权类型菜单中选择授权代码。这将授予客户端交换访问令牌的临时代码。代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有此授权类型才能启用安全用户模拟。这将显示您在注册应用程序时使用的 回调 URL
    2. 令牌授权菜单中选择请求正文
    3. 授权 URL 已预填充。
    4. 令牌 URL 已预填充。
    5. 确保为范围输入了以下内容:user_read
    6. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。在配置 OAuth 服务器时,您将收集这些信息和密码。您需要添加集成配置页面上看到的回调 URL
    7. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。

    服务身份验证

  7. 服务操作身份验证下,启用在操作中使用单独的用户身份验证开关。服务操作身份验证在服务操作级别进行身份验证。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。

    1. 从“身份验证方法”菜单中选择“OAuth 2.0”,然后完成身份验证详细信息。
    2. 授权类型菜单中选择授权代码。这将授予客户端交换访问令牌的临时代码。代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有此授权类型才能启用安全用户模拟。这将显示您在注册应用程序时使用的 回调 URL
    3. 令牌授权菜单中选择请求正文
    4. 授权 URL 已预填充。
    5. 令牌 URL 已预填充
    6. 确保为范围输入了以下内容:user_write
    7. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。您在配置 OAuth 客户端时收集此信息和密码。您需要添加集成配置页面上看到的回调 URL
    8. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。

    服务操作身份验证

  8. 启用请求速率限制 开关已启用。为 请求数400 ,为 时间间隔1 分钟。 1.. 默认情况下,请求超时 设置为 120
  9. (可选)启用日志记录开关以保留 24 小时的日志记录以供支持。

    服务身份验证

  10. 选择 保存 以继续。
  11. OAuth 授权下,选择 授权 以使用您的服务帐户登录。此时将出现一个带有 Google 登录屏幕的弹出窗口。
    1. 输入您的服务帐户用户名和密码,然后选择“登录”。
    2. 选择“接受”。

    授权

向按钮添加动作

为以下按钮配置 “ 转到 URL ” 操作以启用 “ 签名信封 ” 和 “ 查看信封 ” 按钮功能。此 “ 转到 URL ” 配置将用户操作重定向到 DocuSign 中的特定信封详情页面。

  1. 导航到页面生成器中的以下按钮,然后选择该按钮。对以下每个按钮执行此过程:

    • 我收到的信封 微应用程序: 待定信封详情 页面: 签名信封 按钮
    • 我的发送信封 微应用: 信封的收件人视图 页面: 签名信封 按钮
    • 我的发送信封 微应用: 发件人查看信封 页面: 查看信封 按钮
  2. 选择右侧的 “ 操作 ” 选项卡。
  3. 在 “ 操作” 下,选择 “ 转到 URL”。
  4. URL 模板 字段中,将 URL 的 {yourEnvironmentName} 部分替换为环境 URL。在你的基本 URL 中找到你的环境 URL: https://{yourEnvironmentName}.docusign.net/restapi/v2.1/. 例如:https://appdemo.docusign.com/documents/details/\{\{nested_table_envelopes_recipients_sign.envelope_id\}\}

    环境网址

  5. 现在,对其他按钮重复此过程。

现在,您可以设置和运行第一个数据同步。有关同步规则、不符合其计划的同步以及否决规则的完整信息,请参阅 同步数据

有关 API 端点和表实体的更多详细信息,请参阅DocuSign 连接器规格

使用 DocuSign 微应用

现有的应用程序集成附带开箱即用的微应用。从这些微应用开始,并根据您的需求定制它们。

注意:

要启用 签名信封查看信封 按钮功能,必须将 待处理信封详细信息 页面、信封的收件人视图 和信封的发件人视图” 页面的按钮替换为环境 URL。请参阅 向按钮添加动作

我收到的信封: 查看用户收到的信封,这些信封正在等待签名。用户可以对自己进行身份验证并在 DocuSign 中查看信封。

通知或页面 用例工作流
我的待处理信封页面 提供一个表格,其中包含所有等待用户签名的信封,并提供搜索选项,用于按电子邮件主题或发件人姓名过滤信封。用户可以查看信封状态已发送已送达
待定信封详细信息页面 提供信封待处理签名的详细信息,例如电子邮件主题、发件人姓名和在(天数)之后过期。用户可以使用签名信封按钮在 DocuSign 中查看信封。

发送模板: 发送现有模板进行签名。

通知或页面 用例工作流
所有模板页面 为用户提供一个包含所有模板的表格。集成不会在登录用户的模板列表中列出共享模板。
模板详细信息页 提供用于将模板发送给收件人的表单。发件人提供以下详细信息来发送信封:姓名、电子邮件和角色。一次最多可以向三 (3) 个收件人发送信封。模板必须包含文档才能使用该模板发送信封。

我的发送信封: 查看用户发送的信封列表。用户还可以查看信封的详细信息,还可以添加、编辑和删除收件人。

注意:

通知在创建后两天过期。

通知或页面 用例工作流
信封状态变更通知 当信封的状态更改为已完成已拒绝时,将生成通知并发送给信封的发件人。如果将记录添加到 Citrix 微应用数据库时,信封的状态已经为已完成已拒绝,则不会为发件人生成通知。
新信封通知 收到新信封后,信封状态和收件人状态必须为已发送已送达,并生成通知并发送给关联的收件人。
添加收件人页面 提供用于将收件人添加到信封中的表单。包含名称、电子邮件和角色等输入字段。
编辑收件人页 提供用于编辑输入字段(如姓名和电子邮件)的表单。当用户修改姓名或电子邮件时,将显示保存并重新发送按钮,并向收件人发送电子邮件。
信封详情页 提供信封详细信息,例如电子邮件主题、创建时间和状态。还会显示与信封关联的收件人列表以及添加收件人按钮。用户无法编辑收件人或将收件人添加到已作废或拒绝的信封中。
我的信封页 提供具有状态(已发送、已送达、已完成、拒绝、无效)的用户发送的所有信封的列表,并附有一个搜索栏,用于按电子邮件主题或信封状态筛选信封。
收件人详情页面 使用以下按钮提供收件人详细信息,例如姓名、电子邮件和状态:编辑收件人、重新发送信封和删除收件人。
“信封的收件人视图” 页面 提供信封待处理签名的详细信息,例如电子邮件主题、发件人姓名和在(天数)之后过期。用户可以使用签名信封按钮在 DocuSign 中查看信封对信封进行签名。
信封页面的发件人视图 提供信封详细信息,例如电子邮件主题、创建时间和状态。还包含与信封关联的收件人列表以及 “ 查看信封 ” 按钮。
集成 DocuSign