WooCommerce

使用 WooCommerce 连接器在 WooCommerce 中执行插入、删除、更新和读取操作。

准备工作

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

• 在您的 Google Cloud 项目中：
  • 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
  • 将以下 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. 连接器：从可用连接器的下拉列表中选择 WooCommerce。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

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

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

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

   注意：只有在 即随用随付的客户。
   8. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
   • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
     • 基本：基本 HTTP 身份验证。
     • 摘要：摘要 HTTP 身份验证。
   • 代理用户：用于向代理服务器进行身份验证的用户名。
   • 代理密码：用户密码的 Secret Manager 密文。
   • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
     • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
     • 始终：连接始终启用 SSL。
     • 永不：连接未启用 SSL。
     • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
   • 在代理服务器部分中，输入代理服务器的详细信息。
     1. 点击+ 添加目标。
     2. 选择目标类型。
        • 主机地址：指定目标的主机名或 IP 地址。

          如果要与后端系统建立专用连接，请执行以下操作：

          • 创建 PSC 服务连接。
          • 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
   9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   10. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目标类型：选择目标类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意 ：如需了解如何创建端点连接，请参阅 PSC 服务连接 以及端点连接。创建端点连接后，它将显示在端点连接列表中。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

   2. 点击下一步。
6. 在身份验证部分中，输入身份验证详细信息。

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

7. 指定身份验证详细信息后，点击下一步。
8. 查看：查看您的连接和身份验证详细信息。
9. 点击创建。

配置身份验证

输入身份验证详细信息。

• 使用方公钥：WooCommerce 在创建身份验证凭据时分配的使用方公钥。
• 使用方密钥：包含与连接器关联的使用方密钥的 Secret Manager Secret。

系统限制

Woocommerce 连接器每秒可处理 2 笔交易， 每节点， 并throttles任何事务 。 默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

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

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

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

在集成中使用 WooCommerce 连接

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

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

实体、操作和动作

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

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

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

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

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

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

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

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

操作

本部分列出了该连接器支持的操作。要了解如何配置 操作，请参阅操作示例。

注意：所有操作的结果将在您运行集成后以 JSON 响应的形式在 Connectors 任务的 connectorOutputPayload 响应参数中提供给您。

“更新配送区域地理位置”操作

通过此操作，您可以在 Woocommerce 中更新配送区域的地址信息。

“更新送货区域位置”操作的输入参数

参数名称	数据类型	必需	说明
ZoneId	字符串	是	要更新的区域的 ID。
位置	字符串	是	营业地点详情。

例如，关于如何配置 Update Shipping Zone Locations 操作， 请参阅操作示例。

操作示例

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

示例 - 更新配送区域位置

此示例更新了配送区域的位置。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 Update Shipping Zone Locations 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
       "ZoneId": "7",
       "Locations": "[{\"code\":\"BR:SP\",\"type\":\"state\"}]"
     }

如果操作成功， Update Shipping Zone Locations 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

[ { "code": "BR:SP", "type": "state",
    "_links_collection_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7/locations", 
    "_links_describes_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7", 
    "success": "true" } ]

实体操作示例

示例 - 列出实体的记录

此示例列出了 Orders 实体的记录。

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

   例如，将过滤条件子句设置为 Id='891'，仅列出这些记录 订单 Id 为 891。

示例 - 从实体中获取单个记录

此示例从 Orders 实体中提取一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Orders。
3. 选择 Get 操作，然后点击 完成。
4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 891。

   其中，891 是资源 Orders 实体的唯一标识符。

示例 - 从实体中删除记录

以下示例将从 Orders 实体中删除一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Orders。
3. 选择 Delete 操作，然后点击 完成。
4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 891。

   或者，如果实体具有复合主键，您可以设置 filterClause，而不是指定 entityId。例如 Id='891'。

示例 - 在实体中创建记录

此示例在 Orders 实体中创建了一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Orders。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "BillingFirstName": "Alex",
   "BillingLastName": "Smith",
   "Status":"processing",
   "CustomerId": 1,
   "ShippingAddress1":"809/2 Downtown, Alaska, United States"
   }

如果集成成功，连接器任务的 connectorOutputPayload 字段将包含创建操作的响应。

{ 
"Id": 1010 
}

示例 - 更新实体中的记录

此示例会更新 Orders 实体中的记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Orders。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Status": "on-hold"
   }

5. 在连接器任务的任务输入部分，点击 entityId 并 然后在 Default Value 字段中输入 1010。

如果集成成功，连接器任务的 connectorOutputPayload 字段将包含更新操作的响应。

{
"Id": 1010
}