FreshBooks

Mit dem FreshBooks-Connector können Sie eine Verbindung zu einer FreshBooks-Instanz herstellen und auf die FreshBooks-Daten als herkömmliche Datenbank zugreifen.

Unterstützte Versionen

Dieser Connector modelliert die FreshBooks Alpha API als Datenbankobjekte, die mit SQL abgefragt werden können.

Hinweis

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

• In Ihrem Google Cloud-Projekt:
  • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkverbindung.
  • 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.

Informationen zum Erstellen einer Anwendung und zum Generieren von Client-ID und Clientschlüssel für die Authentifizierung finden Sie unter Get Started with FreshBooks API.

Connector konfigurieren

Eine Verbindung gilt für eine Datenquelle. 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 Next (Weiter).
4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
   1. Connector: Wählen Sie FreshBooks 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 gesetzt.
   6. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
   7. Konfigurieren Sie optional 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. Konto-ID: Die Konto-ID, mit der eine Verbindung hergestellt werden soll. Wenn kein Wert angegeben ist, wird der erste zurückgegebene Wert verwendet.
   9. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   10. Klicken Sie auf Next (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 FreshBooks-Verbindung unterstützt:

      • OAuth 2.0-Autorisierungscode

   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
  • Bereiche: Eine durch Kommas getrennte Liste der gewünschten Bereiche.
  • Client-ID: Die Client-ID, die zum Anfordern von Zugriffstokens verwendet wird.
  • Clientschlüssel: Der Clientschlüssel, der zum Anfordern von Zugriffstokens verwendet wird.

So autorisieren Sie die FreshBooks-Verbindung:

1. Klicken Sie auf der Seite „Verbindungen“ auf die FreshBooks-Verbindung.
2. Klicken Sie im Abschnitt Authentifizierung auf Verbindung autorisieren.
3. Rufen Sie den Abschnitt Weiterleitungs-URI auf und kopieren Sie ihn.
4. Klicken Sie in der FreshBooks-Anwendung auf Weiterleitungs-URIs.
5. Fügen Sie den Weiterleitungs-URI ein, den Sie aus der FreshBooks-Verbindung kopiert haben, und klicken Sie dann auf Einstellungen speichern.
Wenn Sie Ihre OAuth-Drittanbieteranwendung konfigurieren, verwenden Sie diesen autorisierten Weiterleitungs-URI (Callback-URL):

https://console.cloud.google.com//connectors/oauth?project=PROJECT_ID

Ersetzen Sie PROJECT_ID durch die Google Cloud Projekt-ID Ihres Projekts.

6. Kehren Sie zur FreshBooks-Verbindung zurück und klicken Sie im Abschnitt „Authentifizierung“ auf Autorisieren.

   Wenn die Autorisierung erfolgreich ist, wird der Verbindungsstatus auf der Seite „Verbindungen“ auf Aktiv gesetzt.

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 Entities Liste 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 keine Entitätsvorgänge unterstützt, werden diese nicht in der nicht unterstützten Vorgänge in der Operations Liste 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 Ausgabe parameter. Es ist jedoch möglich , dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Liste Actions leer.

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

Beispiele für Entitätsvorgänge

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

Beispiel: Alle Projekte auflisten

In diesem Beispiel werden alle Projekte in der Entität Projects aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Projects aus.
3. Wählen Sie den Vorg0/} aus und klicken Sie dann auf Fertig.List
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors Ihr Ergebnissatz filtern, indem Sie eine Filterklausel angeben.

Beispiel: Datensatz aus einer Entität abrufen

In diesem Beispiel wird ein Datensatz mit der ID 2009015 aus der Entität Expense Categories abgerufen.

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

   2009015 ist hier ein Primärschlüsselwert in der Entität Expense Categories.

Beispiel: Rechnung erstellen

In diesem Beispiel wird eine Rechnung in der Entität Invoices erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Invoices aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie dann 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:

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

   Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload Ihrer Connector-Aufgabe einen Wert ähnlich dem folgenden:

   {
   "Id": "49594.0"
   }

Beispiel: Rechnung aktualisieren

In diesem Beispiel wird die Rechnung mit der ID 36741.0 in der Entität Invoices aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Invoices aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie dann 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:

   {
   "FirstName": "James"
   }

5. Klicken Sie auf entityId und geben Sie dann 36741.0 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 36741.0 festlegen.

   Wenn die Integration erfolgreich ist, hat das connectorOutputPayload Feld Ihrer Connector-Aufgabe einen Wert ähnlich dem folgenden:

   {
   "Id": "36741.0"
   }

Beispiel: Datensatz löschen

In diesem Beispiel wird der Datensatz mit der ID 78 in der Entität Payments gelöscht.

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

Verbindungen mit Terraform erstellen

Sie können die Terraform Ressource verwenden, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispielvorlage für Terraform zum Erstellen einer Verbindung finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

Parameter name	Datentyp	Erforderlich	Beschreibung
account_id	STRING	Wahr	Die Konto-ID, mit der eine Verbindung hergestellt werden soll. Wenn kein Wert angegeben ist, wird der erste zurückgegebene Wert verwendet.

FreshBooks-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 in einer Integration über die Connectors-Aufgabe 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.

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

• Verbindungen anhalten und fortsetzen
• Connector-Nutzung überwachen
• Connector-Logs ansehen