产品文档
微应用
查看 PDF

集成 docuSign

December 1, 2021
投稿者: 
C

部署 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/。
  • 授权 URL： https://account-d.docusign.com/oauth/auth
  • 令牌 URL： https://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. 如果您想访问电子签名管理员的演示版本，请改用此 URL： https://admindemo.docusign.com。有关新服务帐号的更多信息，请参阅： https://support.docusign.com/en/guides/org-admin-guide-getting-started。

配置 OAuth 服务器

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

  1. 使用您的服务帐号登录电子签名管理员： https://admin.docusign.com。对于电子签名管理员的演示版本： https://admindemo.docusign.com。有关更多信息，请参阅： https://support.docusign.com/en/guides/ndse-admin-guide-access 和 https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration。
  2. 转到导航栏中的 “ 设置 ”。
  3. 在设置页面上，选择 应用程序和密钥 ，然后选择 添加应用程序和集成密钥。
  4. 输入 APP 名称 ，然后选择 添加。
  5. 选择 + 添加密钥 以生成密钥。
  6. 输入重定向 URI： https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. 复制并保存屏幕上显示的 集成密钥和私有密钥（clientID** 和密钥）。配置集成时，可以将这些详细信息用于 **服务身份验证 。
  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。对于电子签名管理员的演示版本： https://admindemo.docusign.com。有关更多信息，请参阅： https://support.docusign.com/en/guides/ndse-admin-guide-access 和 https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration。
  2. 转到导航栏中的 “ 设置 ”。
  3. 在设置页面上，选择 应用程序和密钥 ，然后选择 添加应用程序和集成密钥。
  4. 输入 APP 名称 ，然后选择 添加。
  5. 选择 + 添加密钥 以生成密钥。
  6. 输入重定向 URI： https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  7. 复制并保存屏幕上显示的 集成密钥和私有密钥（clientID** 和密钥）。配置集成时，可以将这些详细信息用于 **服务操作身份验证 。

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

配置组织

将帐户关联到您的组织。系统会自动关联您用于创建组织的帐户。

  1. 在电子签名管理员主页中，选择 开始使用。如果您在 DocuSign 帐户中没有看到此选项，则不会在该帐户上启用 DocuSign 管理员。请联系您的 DocuSign 客户经理寻求帮助。
  2. 在提供的字段中输入 组织名称 和可选 说明 ，然后选择 下一步。
  3. 选择 CREATE 以完成组织的创建。有关详细信息，请参阅 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 微应用程序以连接到您的应用程序。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。这样可以提供带有预配置通知和操作的开箱即用的微应用程序，这些通知和操作可在工作区中使用

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

  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\}\}。

    环境 URL

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

现在，您已准备好设置和运行第一次数据同步。有关同步规则、不符合其计划的同步和否决规则的完整信息，请参阅同步数据。

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

使用 DocuSign 微应用

现有的应用程序集成随现成的微应用程序一起提供。从这些微应用开始，然后根据您的需求自定义它们。

注意：

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

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

通知或页面 用例工作流
我收到的信封页面 提供一个表格，其中包含所有等待用户签名的信封，以及用于按电子邮件主题或发件人姓名过滤信封的搜索选项。用户可以查看信封的已发送和已送达状态。
收到的信封详情页 提供等待签名的信封的详细信息，例如电子邮件主题、发件人姓名和过期日期（天数）。用户可以使用 “ 签名信封” 按钮在 Workspace 中查看信封 。
签署信封页 提供用于在 Citrix Workspace 中对信封进行签名的表单。

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

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

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

注意：

通知将在创建两天后过期。

通知或页面 用例工作流
信封状态更改通知 当信封的状态更改为 “ 已完成 ” 或 “已 拒绝” 时，系统会生成通知并将其发送给信封的发件人。如果在将记录添加到 Citrix Microapps 数据库时信封的状态已经为 “已 完成 ” 或 “已 拒绝 ”，则不会为发件人生成通知。
新信封通知 收到新信封后，信封状态和收件人状态必须为 “ 已 发送” 或 “已 送达”，然后会生成通知并将其发送给关联的收件人。
添加收件人页 提供将收件人添加到信封的表单。包含 “姓名”、“电子邮件” 和 “角色” 等输入字段。
编辑收件人页 提供用于编辑姓名和电子邮件等输入字段的表单。当用户修改姓名或电子邮件时，将显示 “ 保存并重新发送 ” 按钮，并向收件人发送电子邮件。
信封详情页 提供信封详细信息，例如电子邮件主题、创建时间和状态。还会显示与信封关联的收件人列表以及 “ 添加收 件人” 按钮。用户无法编辑收件人或将收件人添加到已作废或拒绝的信封中。
我的已发送信封页面 提供状态为（已发送、已送达、完成、拒绝、已作废）的用户发送的所有信封的列表，并带有搜索栏，用于按电子邮件主题或信封状态筛选信封。
收件人详情页 使用以下按钮提供收件人详细信息，例如姓名、电子邮件和状态：编辑收件人、重新发送信封和删除收件人。
签署信封页 提供等待签名的信封的详细信息，例如电子邮件主题、发件人姓名和过期日期（天数）。用户可以使用 “ 签名信封” 按钮在 DocuSign 中查看信封 以对信封进行签名。
查看信封页面 提供信封详细信息，例如电子邮件主题、创建时间和状态。还包含与信封关联的收件人列表和 “ 查看信封 ” 按钮。
集成 docuSign
December 1, 2021
投稿者: 
C
December 1, 2021
投稿者: 
C

在本文中

站点反馈 | 隐私和法律条款 | Cookie 首选项 | 同意设置
© 1999- Cloud Software Group, Inc. All rights reserved.