ZohoBooks

Mit dem ZohoBooks-Connector können Sie SQL-Vorgänge im ZohoBooks-System ausführen.

Unterstützte Versionen

Der Connector nutzt die Zoho Books API V3, um einen bidirektionalen Zugriff auf Zoho Books-Daten zu ermöglichen.

Hinweise

Führen Sie vor der Verwendung des Zoho Books-Connectors die folgenden Aufgaben aus:

• In Ihrem Google Cloud-Projekt:
  • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
  • Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
  • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

  • Aktivieren Sie die folgenden Dienste:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

  Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Zur Seite „Verbindungen“

2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
   1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Unterstützte Regionen für Connectors:

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

   2. Klicken Sie auf Weiter.
4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
   1. Connector: Wählen Sie Zoho Books aus der Drop-down-Liste der verfügbaren Connectors aus.
   2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
   3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 49 Zeichen haben.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf Error festgelegt.
   6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   7. Optional: Konfigurieren Sie die Verbindungsknoteneinstellungen:
      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   8. Kontoserver: Die vollständige URL des Kontoservers.
   9. Organisations-ID: Die ID, die mit der jeweiligen Zoho Books-Organisation verknüpft ist.
   10. Ausführlichkeit: Die Ausführlichkeit der Verbindung, von 1 bis 5. Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage,Antwort und SSL-Zertifikate) protokolliert.
   11. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   12. Klicken Sie auf Weiter.
5. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
   1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der Zoho Books-Verbindung unterstützt:

      • OAuth 2.0-Authentifizierungscode-Zuweisung

   Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

   2. Klicken Sie auf Next (Weiter).
6. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
7. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

• OAuth 2.0-Autorisierungscode-Grant
  • Client-ID: Die Client-ID, die vom Connector für die von Ihnen erstellte Anwendung bereitgestellt wird.
  • Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.
  • Zugriffstoken: Secret Manager-Secret mit dem OAuth-Zugriffstoken für die verbundene App, die Sie erstellt haben.

ZohoBooks-Authentifizierung konfigurieren

In den folgenden Abschnitten wird beschrieben, wie Sie den ZohoBooks-Connector konfigurieren.

ZohoBooks-Konto einrichten

Weitere Informationen zum Einrichten des ZohoBooks-Kontos finden Sie unter Konto erstellen.

Entwicklerkonto einrichten und Clientanwendung erstellen

Informationen zum ZohoBooks-Entwicklerkonto und zum Erstellen einer Client-App finden Sie unter Client-App erstellen.

Authentifizierung einrichten

So richten Sie die Authentifizierung ein:

1. Rufen Sie in der Cloud Console die Seite Integration Connectors auf.
2. Um die Details einer bestimmten Verbindung aufzurufen, klicken Sie in der Tabelle der vorhandenen Verbindungen auf einen Verbindungsnamen.
3. Klicken Sie im Bereich Authentifizierung auf Verbindung autorisieren, um den Autorisierungsvorgang zu starten.
4. Kopieren Sie den Weiterleitungs-URI.
5. Rufen Sie die ZohoBooks Developer Console auf.
6. Fügen Sie im Abschnitt „Autorisierter Weiterleitungs-URI des dienstbasierten Anwendungsclients“ den Weiterleitungs-URI hinzu.
7. Rufen Sie auf der Seite Integration Connectors (Integration Connectors) die ZohoBooks-Verbindungsseite auf, von der Sie die Weiterleitungs-URI kopiert haben, und klicken Sie auf Authorize (Autorisieren).

Sie werden zur ZohoBooks-Website weitergeleitet, um die Autorisierung vorzunehmen.

Beispiele für Verbindungskonfigurationen

In diesem Abschnitt finden Sie Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der Zoho Books-Verbindung konfigurieren.

Webverbindungstyp

Feldname	Details
Region	us-east4
Connector	ZohoBooks
Connector-Version	1
Verbindungsname	zohobooks-google-cloud-conn
Dienstkonto	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Kontoserver	https://books.zoho.in
Organisations-ID	ORGANIZATION_ID
Ausführlichkeit	5
Mindestanzahl von Knoten	2
Maximale Anzahl von Knoten	50
Client-ID	CLIENT_ID
Bereiche	ZohoBooks.fullaccess.all
Clientschlüssel	CLIENT_SECRET
Secret-Version	1

ZohoBooks-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connectors-Aufgabe in einer Integration verwenden.

• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

Hinweis: Sie können die Entitäten, Vorgänge und Aktionen eines Connectors in der Connectors-Aufgabe aufrufen.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Liste Operations aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Hinweis : Allen Entitäten und Aktionen ist ein Schema zugewiesen. Ein Aktionsschema enthält beispielsweise Parameterdetails wie die Parameternamen und den entsprechenden Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Backend abgerufen. Wenn es Aktualisierungen am Schema gibt, werden diese nicht automatisch in Ihren vorhandenen Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Wenn Sie das Schema für eine Verbindung aktualisieren möchten, öffnen Sie die Seite Verbindungsdetails der Verbindung und klicken Sie dann auf Verbindungsschema aktualisieren.

Aktionen

In diesem Abschnitt werden einige der von der Zoho Books-Verbindung unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Hinweis:Die Ergebnisse aller Aktionen sind als JSON-Antwort im Antwortparameter connectorOutputPayload der Aufgabe Connectors verfügbar, nachdem Sie die Integration ausgeführt haben.

Aktion „ImportCreditCardStatement“

Mit dieser Aktion können Sie Kreditkartenabrechnungen importieren.

Eingabeparameter der Aktion „ImportCreditCardStatement“

Parametername	Datentyp	Erforderlich	Beschreibung
AccountId	String	Nein	ID des Bank-/Kreditkartenkontos
TransactionsTransactionDebitOrCredit	String	Nein	Gibt an, ob es sich bei der Transaktion um eine Debit- oder Kreditkarte handelt.
TransactionsTransactionAmount	String	Nein	Der Betrag der Transaktion.
TransactionsTransactionDescription	String	Nein	Transaktionsbeschreibung.
TransactionsTransactionDate	String	Nein	Datum der Transaktion.

Informationen zum Konfigurieren der ImportCreditCardStatement-Aktion finden Sie unter Beispiele.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige Aktionen in diesem Connector ausführen.

Beispiel: Kreditkartenabrechnung importieren

In diesem Beispiel wird eine Kreditkartenabrechnung importiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion ImportCreditCardStatement aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe ImportCreditCardStatement einen Wert, der in etwa so aussieht:

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

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel: Alle Schätzungen auflisten

In diesem Beispiel werden alle Einträge in der Entität Estimates aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Estimates aus.
3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors einen Filter angeben, um den Ergebnissatz einzugrenzen. Mithilfe der logischen Operatoren können Sie auch mehrere Filterbedingungen angeben.

Beispiel: Auftrag abrufen

In diesem Beispiel wird die angegebene Bestellung von der Entität SalesOrder abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option SalesOrder aus.
3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 1470449000000043003 in das Feld Standardwert ein.

   Hier ist 1470449000000043003 ein Primärschlüsselwert in der Entität SalesOrder.

Beispiel: Banktransaktion erstellen

In diesem Beispiel wird ein Banktransaktionseintrag in der BankTransactions-Entität erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option BankTransactions aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

   Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der in etwa so aussieht:

   {
   "TransactionId": "1470449000000231005"
   }

Beispiel: Kontaktdaten des Kunden aktualisieren

In diesem Beispiel wird der angegebene Kundendatensatz in der Entität CustomerContacts aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option CustomerContacts aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

5. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 1470449000000038005 in das Feld Standardwert ein.

Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der in etwa so aussieht:

{
"CustomerContactId": "1470449000000038005"
}

Beispiel: Rechnungseintrag löschen

In diesem Beispiel wird der angegebene Rechnungseintrag in der Entität InvoiceDetails gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option InvoiceDetails aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 1470449000000184001 in das Feld Standardwert ein.

Hinweis : Wenn Ihre Entität einen zusammengesetzten Primärschlüssel hat, können Sie eine Filterklausel angeben.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte

• Informationen zum Anhalten und Fortsetzen einer Verbindung
• Informationen zum Überwachen der Connector-Nutzung
• Weitere Informationen zum Ansehen von Connector-Logs