Freshbooks

借助 FreshBooks 连接器,您可以连接到 FreshBooks 实例,并作为传统数据库访问 FreshBooks 数据。

支持的版本

该连接器将 FreshBooks Alpha 版 API 建模为可通过 SQL 查询的数据库对象。

准备工作

在使用 Freshbooks 连接器之前,请完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

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

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

如需了解如何创建应用以及如何生成用于身份验证的客户端 ID 和客户端密钥,请参阅 FreshBooks API 使用入门

配置连接器

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

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

    转到“连接”页面

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

      连接器支持的区域包括:

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

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

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

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

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

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

    8. Account Id:要关联的账号 ID。如果未指定值,将使用返回的第一个值。
    9. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    10. 点击下一步
  5. 身份验证部分中,输入身份验证详细信息。
    1. 选择身份验证类型,然后输入相关详细信息。

      Freshbooks 连接支持以下身份验证类型:

      • OAuth 2.0 授权代码授权
    2. 如需了解如何配置这些身份验证类型,请参阅配置身份验证

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

配置身份验证

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

  • OAuth 2.0 授权代码授权
    • 范围:所需范围的列表(以英文逗号分隔)。
    • 客户端 ID:请求访问令牌时所用的客户端 ID。
    • 客户端密钥:请求访问令牌时所用的客户端密钥。

如需为 FreshBooks 连接授权,请执行以下操作:

  1. 连接页面中,点击 FreshBooks 连接。
  2. Authentication(身份验证)部分中,点击 Authorize Connection(授权连接)。
  3. 前往重定向 URI 部分,然后复制该部分。
  4. 在 FreshBooks 应用中,点击重定向 URI
  5. 粘贴您从 FreshBooks 连接中复制的重定向 URI,然后点击保存设置
  6. 返回 FreshBooks 连接,点击“身份验证”部分中的授权

    如果授权成功,“连接”页面中的连接状态将设为活跃

实体、操作和动作

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

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

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

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

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

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

实体操作示例

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

示例 - 列出所有项目

以下示例列出了 Projects 实体中的所有项目。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Projects
  3. 选择 List 操作,然后点击完成
  4. (可选)在连接器任务的任务输入部分,您可以执行以下操作: 通过指定过滤子句来过滤结果集。

示例 - 从实体中获取记录

此示例从 Expense Categories 实体中获取 ID 为 2009015 的记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Expense Categories
  3. 选择 Get 操作,然后点击 完成
  4. 连接器任务的任务输入部分,点击 EntityId,然后在默认值字段中输入 2009015

    其中,2009015Expense Categories 实体中的主键值。

示例 - 创建账单

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

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Invoices
  3. 选择 Create 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 connectorInputPayload,然后在 Default Value 字段:
    {"CustomerId": 68039.0,
    "FirstName": "John",
    "CreateDate": "2023-09-13"
    }

    如果集成成功,连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容:

    {
    "Id": "49594.0"
    }

示例 - 更新账单

以下示例更新了 Invoices 实体中 ID 为 36741.0 的账单。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Invoices
  3. 选择 Update 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 connectorInputPayload,然后在 Default Value 字段:
    {
    "FirstName": "James"
    }
  5. 点击 entityId,然后在 Default Value 字段中输入 36741.0

    或者,您也可以将 filterClause 设置为 36741.0,而不是指定 entityId

    如果集成成功,连接器任务的 connectorOutputPayload 字段的值将类似于以下内容:

    {
    "Id": "36741.0"
    }

示例 - 删除记录

以下示例会删除 Payments 实体中 ID 为 78 的记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Payments
  3. 选择 Delete 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 entityId 并 然后在 Default Value 字段中输入 78

使用 Terraform 创建连接

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

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

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

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

参数名称 数据类型 必需 说明
account_id STRING True 要关联到的账号 ID。如果未指定值,则系统会使用返回的第一个值。

在集成中使用 Freshbooks 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤