DocuSign

使用 DocuSign 连接器对 DocuSign 执行读取操作。

准备工作

在使用 DocuSign 连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
  • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。

  • 启用以下服务：
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    如需了解如何启用服务，请参阅启用服务。

  如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

   转到“连接”页面

2. 点击 + 新建以打开创建连接页面。
3. 在位置部分中，选择连接的位置。
   1. 区域：从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表，请参阅位置。

   2. 点击下一步。
4. 在连接详情部分中，完成以下操作：
   1. Connector（连接器）：从可用连接器下拉列表中选择 DocuSign。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. （可选）启用 Cloud Logging。 然后选择一个日志级别默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. （可选）如果您使用 DocuSign 沙盒账号，请选择 UseSandbox。
   8. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   10. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAUTH 2.0 - 授权代码
      • OAuth 2.0 - JWT 不记名

   如需了解如何配置这些身份验证类型，请参阅配置身份验证。

   2. 点击下一步。
6. 查看：查看您的连接和身份验证详细信息。
7. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

• OAUTH 2.0 - 授权代码
  • 客户端 ID：请求访问令牌时所用的客户端 ID。
  • 范围：所需范围的逗号分隔列表。
  • 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
• OAuth 2.0 - JWT 不记名
  • 关联的应用使用方密钥：您为所创建已关联应用提供的使用方密钥。
  • 用户名：与您创建的关联应用相关联的用户名。
  • 私钥：包含私钥文件内容的 Secret Manager 密文。私钥应与提供给连接器的公钥/证书匹配。

连接配置示例

本部分列出了适用于 字段。

OAUTH 2.0 - 授权代码连接类型

字段名称	详细信息
位置	us-central1
连接器	DocuSign
连接器版本	1
连接名称	gcp-docusign-new-auth
启用 Cloud Logging	否
UseSandbox	是
服务账号	[e-mail]
身份验证	OAuth 2.0 - 授权代码
客户端 ID	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
权限范围	signature
客户端密钥	CLIENT_SECRET
密钥版本	1 次

OAuth 2.0 - JWT 不记名连接类型

字段名称	详细信息
位置	us-central1
连接器	DocuSign
连接器版本	1
连接名称	gcp-docusign-token
启用 Cloud Logging	否
UseSandbox	是
服务账号	[e-mail]
身份验证	OAuth 2.0 - JWT 不记名
已关联的应用使用方密钥	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
用户名	USER_NAME
私钥	PRIVATE_KEY
密钥版本	1

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作， 操作未在 Operations 列表中列出。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作将具有一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

注意 ：所有实体和操作都具有相关联的架构。例如，操作架构将包含以下参数详细信息：参数 及其对应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新不会自动反映在现有连接中；您必须手动刷新架构。如需刷新连接的架构，请打开连接的连接详情页面，然后点击刷新连接架构。

系统限制

DocuSign 连接器每个节点每秒可处理 3 笔交易，并会节流超出此限制的所有交易。默认情况下，集成连接器会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

注意：集成连接器节点的数量将根据您的使用情况进行动态扩缩。不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。连接处理越多事务就需要越多节点。反之，节点数量越少 如果连接处理的事务较少，则需要。配置节点 值，请执行以下操作：

• 如果您是随用随付客户，请在“修改关联”页面中配置节点的最小值和最大值。
• 如果您是以订阅为主 请与支持团队联系。

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

实体 ID 的值应直接传递，例如 16ab549b-95d7-47cb-b557-c2476ef62d9d。ID 16ab549b-95d7-47cb-b557-c2476ef62d9d 是必须传递的唯一主键值。

示例 - 针对实体“Accounts”执行 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“账号”。
3. 选择 LIST 操作，然后点击完成。
4. 连接器任务的任务输入部分，您可以设置 filterClause。

示例 - 针对实体“Documents”的 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“Documents”（文档）。
3. 选择 LIST 操作，然后点击 完成。
4. 连接器任务的任务输入部分，您可以设置 filterClause。

示例 - 针对实体“信封”的 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“信封”。
3. 选择 LIST 操作，然后点击 完成。
4. 连接器任务的任务输入部分，您可以设置 filterClause。

示例 - 针对实体“文件夹”执行 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“文件夹”。
3. 选择 LIST 操作，然后点击完成。
4. 连接器任务的任务输入部分，您可以根据需要设置 filterClause。

示例 - 针对实体“Groups”执行 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“群组”。
3. 选择 LIST 操作，然后点击 完成。
4. 连接器任务的任务输入部分，您可以设置 filterClause。

示例 - 针对实体“Users”的 LIST 操作

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“用户”。
3. 选择 LIST 操作，然后点击完成。
4. 连接器任务的任务输入部分，您可以根据需要设置 filterClause。

您可以对以下实体执行 LIST 操作：

• UserInfo
• UserSignatures
• 工作区
• 收件人
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• 锁定
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• 模板

示例 - 针对实体“账号”获取单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“账号”。
3. 选择 GET 操作，然后点击 完成。
4. 如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 2.4578824E7，并选择 EntityId 作为本地变量。

示例 - 获取实体“文档”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“Documents”（文档）。
3. 选择 LIST 操作，然后点击 完成。
4. 要设置过滤器子句，请在 在 Data Mapping 的 Data Mapper 部分中，点击 Open Data Mapping Editor，然后 然后在 Input Value（输入值）字段中输入 Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'，并选择过滤器子句作为局部变量。

示例 - 获取实体“信封”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“信封”。
3. 选择 GET 操作，然后点击完成。
4. 要设置实体 ID，请在 在 Data Mapping 的 Data Mapper 部分中，点击 Open Data Mapping Editor，然后 然后在 Input Value（输入值）字段中输入 8e18be14-3254-4cbe-947d-f0d1cd62f5f87，并选择 EntityId 作为局部变量。

示例 - 获取实体“文件夹”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“文件夹”。
3. 选择 GET 操作，然后点击 完成。
4. 如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 05f76d13-a513-492b-8c58-176702768db0，并选择 EntityId 作为本地变量。

示例 - 获取实体“Groups”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“群组”。
3. 选择 GET 操作，然后点击 完成。
4. 如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 1.4167231E7，并选择 EntityId 作为本地变量。

示例 - 获取实体“用户”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“用户”。
3. 选择 GET 操作，然后点击 完成。
4. 要设置实体 ID，请在 在 Data Mapping 的 Data Mapper 部分中，点击 Open Data Mapping Editor，然后 然后在 Input Value（输入值）字段中输入 16ab549b-95d7-47cb-b557-c2476ef62d9d，并选择 EntityId 作为局部变量。

您还可以对以下实体执行 GET 操作：

• UserInfo
• UserSignatures
• 工作区
• 收件人
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• 锁定
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• 模板

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新的连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	必需	说明
proxy_enabled	BOOLEAN	错误	选中此复选框可为连接配置代理服务器。
proxy_auth_scheme	ENUM	错误	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	错误	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	错误	用于向 ProxyServer 代理进行身份验证的密码。

在集成中使用 DocuSign 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。