Freshbooks

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

Unterstützte Versionen

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

Hinweise

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

In Ihrem Google Cloud-Projekt:
- 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:

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“
Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
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).
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 63 Zeichen haben.
4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
5. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
6. Konfigurieren Sie optional die Einstellungen für Verbindungsknoten:
  - 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, wird die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Anzahl von Knoten auf 50 festgelegt.
7. Konto-ID: Die Konto-ID, mit der eine Verbindung hergestellt werden soll. Wenn kein Wert angegeben ist, wird der erste zurückgegebene verwendet.
8. Sie können auch auf + Label hinzufügen klicken, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
9. Klicken Sie auf Next (Weiter).
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:
  - Gewähren von OAuth 2.0-Auth-Code
2. Klicken Sie auf Next (Weiter).
Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

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

Gewähren von OAuth 2.0-Auth-Code
- 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.

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.

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:
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 solche 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. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Beispiele für Entitätsvorgang

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.

Klicken Sie im Dialogfeld Configure connector task auf Entities.
Wählen Sie Projects aus der Liste Entity aus.
Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors die Ergebnisse filtern, indem Sie eine Filterklausel angeben.

Beispiel – Datensatz aus einer Entität abrufen

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

Klicken Sie im Dialogfeld Configure connector task auf Entities.
Wählen Sie Expense Categories aus der Liste Entity aus.
Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf Entitäts-ID und geben Sie 2009015 in das Feld Standardwert ein.
Hier ist 2009015 ein Primärschlüsselwert in der Expense Categories-Entität.

Beispiel – Rechnung erstellen

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

Klicken Sie im Dialogfeld Configure connector task auf Entities.
Wählen Sie Invoices aus der Liste Entity aus.
Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert ähnlich dem folgenden ein:
```
{"CustomerId": 68039.0,
"FirstName": "John",
"CreateDate": "2023-09-13"
}
```
Wenn die Integration erfolgreich ist, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert wie diesen:
```
{
"Id": "49594.0"
}
```

Beispiel – Rechnung aktualisieren

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

Klicken Sie im Dialogfeld Configure connector task auf Entities.
Wählen Sie Invoices aus der Liste Entity aus.
Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert ähnlich dem folgenden ein:
```
{
"FirstName": "James"
}
```
Klicken Sie auf entityId und geben Sie 36741.0 in das Feld Standardwert ein.
Statt die entityId anzugeben, können Sie auch die filterClause auf 36741.0 setzen.

Wenn die Integration erfolgreich ist, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert wie diesen:
```
{
"Id": "36741.0"
}
```

Beispiel – Eintrag löschen

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

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

Mit Terraform Verbindungen erstellen

Mit der Terraform-Ressource können Sie eine neue Verbindung erstellen.

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

Ein Beispiel für eine Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

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

Parametername	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 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 über die Connector-Aufgabe in einer Integration verwenden.

Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der Apigee-Integration finden Sie unter Connectors-Task.
Informationen zum Erstellen und Verwenden der Aufgabe „Connectors“ 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.