Xero

此连接器提供对 Xero 后端的 SQL 访问权限。

准备工作

在使用 Xero 连接器之前，请执行以下任务：

  • 在您的 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. 连接器：从可用连接器下拉列表中选择 Xero。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. （可选）输入连接实例的说明。
    5. 服务账号：选择具有所需角色的服务账号。
    6. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

    7. 架构：您要作为数据库架构访问的 Xero API。
    8. 租户：设置要连接的 Xero 组织。可以是名称或租户 ID。
    9. 详细程度：连接的详细程度，从 1 到 5 不等。如果详细程度越高，系统会记录所有通信详细信息（请求、响应和 SSL 证书）。
    10. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    11. 点击下一步。
  5. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAuth 2.0 客户端凭据
      • OAuth 2.0 授权代码授权

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

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

配置身份验证

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

  • OAuth 2.0 客户端凭据
    • 客户端 ID：连接器为您创建的应用提供的客户端 ID。
    • 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
  • OAuth 2.0 授权代码授权
    • 访问令牌：通过基于 auth-code-flow 的连接对请求进行身份验证时所用的访问令牌。
    • 客户端 ID：请求访问令牌时所用的客户端 ID。
    • 客户端密钥：请求访问令牌时所用的客户端密钥。

实体、操作和动作

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

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

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

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

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

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

在集成中使用 Xero 连接

系统限制

Xero 连接器每秒可以为每个节点处理 5 个事务，并且会限制任何超出此限制的事务。 但是，Xero 连接器可以处理的事务数量还取决于 Xero 实例施加的限制。如需了解详情，请参阅 Xero API 速率限制。 默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

操作

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

DownloadAttachment 操作

此操作会下载附件。

DownloadAttachment 操作的输入参数

参数名称 数据类型 需要 说明
文件名 字符串 否 要下载的附件的名称。
表 字符串 否 我们需要从中下载附件的表的名称。
ObjectId 字符串 否 附件的 ObjectId。

DownloadAttachment 操作的输出参数

如果下载成功，此操作会返回状态 200 (OK)。

如需了解如何配置 DownloadAttachment 操作，请参阅操作示例。

UploadAttachment 操作

此操作可让您上传附件。

UploadAttachment 操作的输入参数

参数名称 数据类型 需要 说明
文件名 字符串 否 要上传的附件的名称。
ObjectId 字符串 否 附件的 ObjectId。
ContentType 字符串 否 附件的内容类型。
表 字符串 否 应上传附件的表的名称。
内容 字符串 否 附件的内容

UploadAttachment 操作的输出参数

如果对象上传成功，此操作会返回状态 200 (OK)。

如需了解如何配置 UploadAttachment 操作，请参阅操作示例。

ListAttachment 操作

此操作可让您列出表的所有附件。

ListAttachment 操作的输入参数

参数名称 数据类型 需要 说明
ObjectId 字符串 否 附件的对象 ID。
表 字符串 否 必须列出附件的表的名称。

ListAttachment 操作的输出参数

如果删除成功，此操作会返回状态 200 (OK)。

如需了解如何配置 ListAttachment 操作，请参阅操作示例。

SendInvoiceMail 操作

此操作可让您向账单结算方发送电子邮件。

SendInvoiceMail 操作的输入参数

参数名称 数据类型 需要 说明
InvoiceId 字符串 否 应向其发送邮件的账单的 ID。

SendInvoiceMail 操作的输出参数

如果移动操作成功，此操作会返回状态 200 (OK)。

如需了解如何配置 SendInvoiceMail 操作，请参阅操作示例。

UploadFile 操作

此操作可让您上传文件。

UploadFile 操作的输入参数

参数名称 数据类型 需要 说明
名称 字符串 否 要上传的文件的名称。
内容 字符串 否 要上传的文件内容。

UploadFile 操作的输出参数

如果对象上传成功，此操作会返回状态 200 (OK)。

如需了解如何配置 UploadFile 操作，请参阅操作示例。

操作示例

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

示例 - 下载附件

本示例会下载一个附件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DownloadAttachment 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}

    4. 如果操作成功，DownloadAttachment 任务的 connectorOutputPayload 响应参数的值将如下所示：

    [{
"Success": "True",
"Content": "Test content"
}]

示例 - 上传附件

该示例上传附件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UploadAttachment 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

    4. 如果操作成功，UploadAttachment 任务的 connectorOutputPayload 响应参数的值将如下所示：

    [{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

示例 - 列出附件

此示例列出了指定表的附件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 ListAttachment 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}

    4. 如果操作成功，ListAttachment 任务的 connectorOutputPayload 响应参数的值将如下所示：

    [{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

示例 - 发送账单电子邮件

下面的示例将针对指定账单发送一封电子邮件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SendInvoiceMail 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}

    4. 如果操作成功，SendInvoiceMail 任务的 connectorOutputPayload 响应参数的值将如下所示：

    [{
"Success": "true"
}]

示例 - 上传文件

此示例上传了一个文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UploadFile 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"Name": "Sample1.txt",
"Content": "This is a sample file"
}

    4. 如果操作成功，UploadFile 任务的 connectorOutputPayload 响应参数的值将如下所示：

    [{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

实体操作示例

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

示例 - 列出所有记录

以下示例列出了 Accounts 实体中的所有记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Accounts。
  3. 选择 List 操作，然后点击完成。
  4. （可选）在连接器任务的任务输入部分，您可以通过指定 filter 子句来过滤结果集。例如 City='Bangalore'。您还可以使用逻辑运算符指定多个过滤条件。例如 City='Bangalore' and region='asia-south2'。

示例 - 获取账单

此示例从 Invoices 实体获取具有指定 ID 的账单。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Invoices。
  3. 选择 Get 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 EntityId，然后在默认值字段中输入 1|016a64c7-be0b-45a2-acae-13057fdf1566。

    此处，1|016a64c7-be0b-45a2-acae-13057fdf1566 是 Invoices 实体中的主键值。

示例 - 创建账单

此示例在 Invoices 实体中创建账单。

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

    如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：

    {
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}

示例 - 更新记录

此示例将更新 AssetTypes 实体中的一条记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 AssetTypes。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. 点击 entityId，然后在 Default Value 字段中输入 f8d43548-25b0-4cc3-8f59-d97106974fe8。

    如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：

    {
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}

示例 - 删除文件

以下示例从 Files 实体中删除具有指定 ID 的文件。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Files。
  3. 选择 Delete 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 entityId，然后在默认值字段中输入 421c82f0-38fb-4074-a679-63b04c0d8832。

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

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

向 Google Cloud 社区寻求帮助

您可以在 Cloud 论坛的 Google Cloud 社区发布您的问题并讨论此连接器。

后续步骤