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)

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

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

Xero 配置

配置 Xero 需要完成以下任务：

设置 Xero 账号和 Xero 演示公司

  1. 前往 Xero 账号注册一个免费的 Xero 账号。
  2. 前往 Xero 演示公司，启用 Xero 演示公司。

生成 OAuth2.0 客户端身份验证详细信息

  1. 登录 Xero 开发者账号。
  2. 点击注册，然后按照提示操作。如果您已有账号，请使用您的凭据登录。

    3. 登录后，您会进入 Xero 开发者信息中心。

  3. 从开发者信息中心内的我的应用部分，前往 Xero 开发者门户。
  4. 点击新应用或创建新应用以创建新应用。
  5. 输入所需的应用详细信息，例如应用名称、说明、公司网址、隐私权政策网址、使用条款网址和回调网址。
  6. 请务必选择与 Xero 的演示版公司集成所需的合适应用类型和权限。

    7. 创建应用后，您将获得 OAuth 凭据，包括客户端 ID 和客户端密钥。

  7. 将客户端 ID 和客户端密钥存储在安全的位置，以备日后使用。

    8. 创建集成时，请仔细为每个架构选择必要的范围，以确保您的应用具有访问和使用所需实用程序的适当权限。

    如需了解如何进行身份验证以及如何检索客户端 ID 和客户端密钥，请参阅检索客户端 ID 和客户端密钥。

设置架构详细信息

您可以根据模块选择架构。可用的架构有 ACCOUNTING、ASSETS、PAYROLLAUS、FILES 和 PROJECTS。因为我们有五个不同的模块，所以您必须为每个模块创建不同的连接。

设置授权详细信息

如需了解如何设置授权网址，请参阅设置授权网址。

配置连接器

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

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

    转到“连接”页面

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

      支持的连接器区域包括：

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

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

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

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

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

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

    8. 架构：您要作为数据库架构访问的 Xero API。
    9. 租户：设置要连接的 Xero 组织。可以是名称或租户 ID。
    10. 详细程度级别：连接的详细程度级别，介于 1 到 5 之间。详细级别越高，系统会记录的通信详细信息（请求、响应和 SSL 证书）就越多。
    11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    12. 点击下一步。
  5. 在 Authentication（身份验证）部分中，输入身份验证详细信息。
    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。
    • 客户端密钥：请求访问令牌时所用的客户端密钥。

连接配置

本部分列出了您在创建 Xero 关联时配置的各种字段的示例值。

会计服务器连接类型

字段名称 详细信息
区域 us-central1
连接器 Xero
连接器版本 1
连接名称 google-cloud-xero-accounting-connection
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
架构 会计
详细程度 5
节点数下限 2
节点数上限 50
身份验证 OAuth 2.0 - 授权代码
客户端 ID CLIENT_ID
权限范围 offline_access openid profile email accounting.transactions, accounting.reports.read, accounting.attachments, accounting.journals.read, accounting.settings, accounting.contacts, accounting.budgets.read
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.xero.com/{identity}/connect/authorize

素材资源服务器连接类型

字段名称 详细信息
区域 us-central1
连接器 Xero
连接器版本 1
连接名称 google-cloud-xero-assets-connection
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
架构 资产
详细程度级别 5
节点数下限 2
节点数上限 50
身份验证 OAuth 2.0 - 授权代码
客户端 ID CLIENT_ID
权限范围 assets.read、assets
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.xero.com/{identity}/connect/authorize

文件服务器连接类型

字段名称 详细信息
区域 us-central1
连接器 Xero
连接器版本 1
连接名称 google-cloud-xero-files-connection
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
架构 FILES
详细程度级别 5
节点数下限 2
节点数上限 50
身份验证 OAuth 2.0 - 授权代码
客户端 ID CLIENT_ID
权限范围 files、files.read
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.xero.com/{identity}/connect/authorize

Payrollaus 服务器连接类型

字段名称 详细信息
区域 us-central1
连接器 Xero
连接器版本 1
连接名称 google-cloud-xero-payroll-connection
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
架构 PAYROLLAUS
详细程度 5
节点数下限 2
节点数上限 50
身份验证 OAuth 2.0 - 授权代码
客户端 ID CLIENT_ID
权限范围 payroll.employees、payroll.payruns、payroll.payslip、payroll.timesheets、payroll.settings
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.xero.com/{identity}/connect/authorize

项目服务器连接类型

字段名称 详细信息
区域 us-central1
连接器 Xero
连接器版本 1
连接名称 google-cloud-xero-projects-connection
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
架构 项目
详细程度级别 5
节点数下限 2
节点数上限 50
身份验证 OAuth 2.0 - 授权代码
客户端 ID CLIENT_ID
权限范围 projects、projects.read
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.xero.com/{identity}/connect/authorize

实体、操作和动作

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

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

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

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

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

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

在集成中使用 Xero 连接

系统限制

Xero 连接器每个节点每秒可处理 5 笔交易，并会对超出此限制的任何交易进行节流。 不过，Xero 连接器能够处理的事务数量也取决于 Xero 实例施加的限制。如需了解详情，请参阅 Xero API 速率限制。 默认情况下，集成连接器会为连接分配 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. 您还可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。 例如 City='Bangalore'。您 也可以使用逻辑运算符指定多个过滤条件。例如 City='Bangalore' and region='asia-south2'。

示例 - 获取账单

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

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Invoices。
  3. 选择 Get 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击实体 ID，然后 然后在 Default Value 字段中输入 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 并 然后在 Default Value 字段中输入 421c82f0-38fb-4074-a679-63b04c0d8832。

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤