ZohoBooks

ZohoBooks 連接器可讓您對 ZohoBooks 系統執行 SQL 作業。

支援的版本

這個連接器會運用 Zoho Books API V3，雙向存取 Zoho Books 資料。

事前準備

使用 Zoho Books 連接器前，請先完成下列工作：

  • 在 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」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分中，選擇連線的位置。
    1. 區域：從下拉式清單中選取位置。

      連接器支援的地區包括：

      如需所有支援區域的清單，請參閱「地點」一文。

    2. 點選「下一步」。
  4. 在「連線詳細資料」部分，完成下列步驟：
    1. 連接器：從可用連接器的下拉式清單中選取「Zoho Books」。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. 視需要設定「連線節點設定」：

      • 節點數下限：輸入連線節點的數量下限。
      • 節點數上限：輸入連線節點數上限。

      節點是用來處理交易的連線單位 (或備用資源)。如要處理更多連線交易，就需要更多節點；反之，如要處理較少的交易，則需要較少的節點。如要瞭解節點對連線器價格的影響，請參閱「 連線節點的定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    8. 帳戶伺服器：完整的帳戶伺服器網址。
    9. 機構 ID：與特定 Zoho Books 機構相關聯的 ID。
    10. 詳細等級：連線的詳細等級，範圍為 1 到 5。詳細程度越高，記錄的通訊詳細資料就越多 (要求、回應和 SSL 憑證)。
    11. (選用) 按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    12. 點選「下一步」。
  5. 在「驗證」部分，輸入驗證詳細資料。
    1. 選取「驗證類型」，然後輸入相關詳細資料。

      Zoho Books 連線支援下列驗證類型：

      • OAuth 2.0 授權碼授權

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點選「下一步」。
  6. 檢查：檢查連結和驗證詳細資料。
  7. 點選「建立」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • OAuth 2.0 授權碼授權
    • 用戶端 ID：連接器為您建立的應用程式提供的用戶端 ID。
    • 用戶端密鑰：Secret Manager 密鑰，內含您建立的已連結應用程式用戶端密鑰。
    • 存取權杖：Secret Manager 密鑰，內含為您建立的已連結應用程式提供的 OAuth 存取權杖。

設定 ZohoBooks 驗證

下列各節說明如何設定 ZohoBooks 連接器。

設定 ZohoBooks 帳戶

如要進一步瞭解如何設定 ZohoBooks 帳戶，請參閱帳戶建立。

設定開發人員帳戶並建立用戶端應用程式

如要瞭解 Zoho Books 開發人員帳戶和用戶端應用程式建立作業，請參閱「建立用戶端應用程式」。

設定驗證方法

如要設定驗證，請按照下列步驟操作：

  1. 前往 Cloud 控制台的「Integration Connectors」(整合連接器) 頁面。
  2. 如要查看特定連線的詳細資料，請在現有連線的表格中按一下連線名稱。
  3. 在「驗證」部分，按一下「授權連線」即可開始授權程序。
  4. 複製重新導向 URI。
  5. 前往 Zoho Books 開發人員控制台。
  6. 在「Service based application client authorized redirect URI's」(以服務為基礎的應用程式用戶端授權重新導向 URI) 部分，新增重新導向 URI。
  7. 在「Integration Connectors」頁面中，前往您複製重新導向 URI 的 ZohoBooks 連線頁面，然後按一下「授權」。

    8. 系統會將您重新導向至 ZohoBooks 網站進行授權。

連線設定範例

本節列出建立 Zoho Books 連線時設定各個欄位的範例值。

網路連線類型

欄位名稱 詳細資料
區域 us-east4
連接器 ZohoBooks
連接器版本 1
連線名稱 zohobooks-google-cloud-conn
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
帳戶伺服器 https://books.zoho.in
機構 ID ORGANIZATION_ID
詳細程度 5
節點數量下限 2
節點數量上限 50
用戶端 ID CLIENT_ID
範圍 ZohoBooks.fullaccess.all
用戶端密鑰 CLIENT_SECRET
密鑰版本 1

在整合中建立 ZohoBooks 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作，請參閱「連接器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連接器工作，請參閱「連接器工作」。

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義與連接器對連接器不同。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

    不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

  • 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：

    從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱連線器工作中的實體作業。 不過，如果連接器不支援任何實體作業，Operations 清單就不會列出這類不支援的作業。

  • 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

本節列出 Zoho Books 連線支援的部分動作。如要瞭解如何設定動作，請參閱動作範例。

ImportCreditCardStatement 動作

這項操作可匯入信用卡對帳單。

ImportCreditCardStatement 動作的輸入參數

參數名稱 資料類型 必填 說明
AccountId 字串 否 銀行/信用卡帳戶 ID
TransactionsTransactionDebitOrCredit 字串 否 指出交易是借方或貸方。
TransactionsTransactionAmount 字串 否 交易金額。
TransactionsTransactionDescription 字串 否 交易說明。
TransactionsTransactionDate 字串 否 交易日期。

如要瞭解如何設定 ImportCreditCardStatement 動作，請參閱範例。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 匯入信用卡對帳單

這個範例會匯入信用卡對帳單。

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「ImportCreditCardStatement」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "AccountId": "1470449000000023015",
  "TransactionsTransactionDebitOrCredit": "credit",
  "TransactionsTransactionAmount": "200",
  "TransactionsTransactionDescription": "Transaction done from Google account",
  "TransactionsTransactionDate": "2023-05-05"
}

    4. 如果動作成功，ImportCreditCardStatement 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

    [{
"Status": "Your bank statement has been imported."
}]

實體作業範例

本節說明如何在這個連接器中執行部分實體作業。

範例 - 列出所有估算值

這個範例會列出 Estimates 實體中的所有記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Estimates。
  3. 選取 List 作業，然後按一下「完成」。
  4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句來篩選結果集。您也可以使用邏輯運算子指定多個篩選條件。

範例 - 取得銷售訂單

這個範例會從 SalesOrder 實體取得指定的銷售訂單。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 SalesOrder。
  3. 選取 Get 作業，然後按一下「完成」。
  4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 1470449000000043003。

    其中 1470449000000043003 是 SalesOrder 實體中的主鍵值。

範例 - 建立銀行交易

這個範例會在 BankTransactions 實體中建立銀行交易記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 BankTransactions。
  3. 選取 Create 作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"TransactionType": "transfer_fund",
"FromAccountId": "1470449000000000459",
"ToAccountId": "1470449000000110001",
"Amount": 45.0,
"CurrencyId": "1470449000000000064"
}

    如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

    {
"TransactionId": "1470449000000231005"
}

範例 - 更新顧客聯絡資料

這個範例會更新 CustomerContacts 實體中的指定客戶記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 CustomerContacts。
  3. 選取 Update 作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"Department": "Development",
"ContactId": "1470449000000038003"
}
  5. 在「連線器」工作的「工作輸入」部分，按一下「entityId」，然後在「預設值」欄位中輸入 1470449000000038005。

    6. 如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似以下內容的值：

    {
"CustomerContactId": "1470449000000038005"
}

範例 - 刪除應付憑據記錄

這個範例會刪除 InvoiceDetails 實體中的指定應付憑據記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 InvoiceDetails。
  3. 選取 Delete 作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的 「Task Input」(任務輸入內容) 區段中，按一下 「entityId」，然後在 「Default Value」(預設值) 欄位中輸入 1470449000000184001。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟