Xero

Dieser Connector bietet SQL-Zugriff auf das Xero-Backend.

Hinweise

Führen Sie die folgenden Schritte aus, bevor Sie den Xero-Connector verwenden:

  • In Ihrem Google Cloud-Projekt:
    • Gewähren Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin.
    • 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 Xero 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 den 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, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

    7. Schema: Die Xero API, auf die Sie als Datenbankschema zugreifen möchten.
    8. Mandant: Legt die Xero-Organisation fest, zu der eine Verbindung hergestellt werden soll. Dies kann ein Name oder eine Mandanten-ID sein.
    9. Ausführlichkeit: Der Ausführlichkeitsgrad für die Verbindung variiert zwischen 1 und 5. Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage-, Antwort- und SSL-Zertifikate) protokolliert.
    10. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    11. 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 Xero-Verbindung unterstützt:

      • OAuth 2.0-Clientanmeldedaten
      • Gewährung von OAuth 2.0-Auth-Codes

      2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    2. Klicken Sie auf 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-Clientanmeldedaten
    • 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.
  • OAuth 2.0-Auth-Code-Gewähren
    • Zugriffstoken: Das Zugriffstoken, das zur Authentifizierung von Anfragen mit auth-code-flow-basierten Verbindungen verwendet wird.
    • 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 keine 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. Normalerweise umfasst 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.

Xero-Verbindung in einer Integration verwenden

Systembeschränkungen

Der Xero-Connector kann fünf Transaktionen pro Sekunde und Knoten verarbeiten und alle Transaktionen über dieses Limit hinaus drosseln. Die Anzahl der Transaktionen, die der Xero-Connector verarbeiten kann, hängt jedoch auch von den Einschränkungen der Xero-Instanz ab. Weitere Informationen finden Sie unter Xero API-Ratenlimits. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten (zur besseren Verfügbarkeit) zu.

Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Beschränkungen.

Aktionen

In diesem Abschnitt sind einige der vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Aktionsbeispiele.

Aktion „DownloadAttachment“

Durch diese Aktion wird ein Anhang heruntergeladen.

Eingabeparameter der Aktion „DownloadAttachment“

Parametername Datentyp Erforderlich Beschreibung
Dateiname String Nein Name des herunterzuladenden Anhangs.
Tabelle String Nein Name der Tabelle, aus der der Anhang heruntergeladen werden soll.
ObjectId String Nein ObjectId des Anhangs.

Ausgabeparameter der Aktion „DownloadAttachment“

Diese Aktion gibt bei einem erfolgreichen Download den Status 200 (OK) zurück.

Informationen zum Konfigurieren der Aktion DownloadAttachment finden Sie unter Aktionsbeispiele.

UploadAttachment-Aktion

Mit dieser Aktion können Sie einen Anhang hochladen.

Eingabeparameter der UploadAttachment-Aktion

Parametername Datentyp Erforderlich Beschreibung
Dateiname String Nein Name des hochzuladenden Anhangs.
ObjectId String Nein ObjectId des Anhangs.
ContentType String Nein Inhaltstyp des Anhangs.
Tabelle String Nein Name der Tabelle, in die der Anhang hochgeladen werden soll.
Inhalt String Nein Inhalt des Anhangs

Ausgabeparameter der UploadAttachment-Aktion

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Objektupload erfolgreich war.

Informationen zum Konfigurieren der Aktion UploadAttachment finden Sie unter Aktionsbeispiele.

Aktion "ListAttachment"

Mit dieser Aktion können Sie alle Anhänge einer Tabelle auflisten.

Eingabeparameter der ListAttachment-Aktion

Parametername Datentyp Erforderlich Beschreibung
ObjectId String Nein Objekt-ID des Anhangs.
Tabelle String Nein Name der Tabelle, aus der die Anhänge aufgelistet werden müssen.

Ausgabeparameter der Aktion „ListAttachment“

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Löschvorgang erfolgreich war.

Informationen zum Konfigurieren der Aktion ListAttachment finden Sie unter Aktionsbeispiele.

Aktion "SendInvoiceMail"

Mit dieser Aktion können Sie E-Mails an einen Rechnungssteller senden.

Eingabeparameter der Aktion SendInvoiceMail

Parametername Datentyp Erforderlich Beschreibung
InvoiceId String Nein ID der Rechnung, für die die E-Mail gesendet werden soll.

Ausgabeparameter der Aktion SendInvoiceMail

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Verschiebevorgang erfolgreich ist.

Informationen zum Konfigurieren der Aktion SendInvoiceMail finden Sie unter Aktionsbeispiele.

UploadFile-Aktion

Mit dieser Aktion können Sie eine Datei hochladen.

Eingabeparameter der UploadFile-Aktion

Parametername Datentyp Erforderlich Beschreibung
Name String Nein Name der Datei, die hochgeladen werden soll.
Inhalt String Nein Dateiinhalt, der hochgeladen werden soll.

Ausgabeparameter der UploadFile-Aktion

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Objektupload erfolgreich war.

Informationen zum Konfigurieren der Aktion UploadFile finden Sie unter Aktionsbeispiele.

Aktionsbeispiele

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

Beispiel – Anhang herunterladen

In diesem Beispiel wird ein Anhang heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadAttachment aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe DownloadAttachment einen Wert ähnlich dem folgenden:

    [{
"Success": "True",
"Content": "Test content"
}]

Beispiel – Anhang hochladen

In diesem Beispiel wird ein Anhang hochgeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadAttachment aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe UploadAttachment einen Wert ähnlich dem folgenden:

    [{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Beispiel – Anhänge auflisten

In diesem Beispiel werden die Anhänge der angegebenen Tabelle aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion ListAttachment aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe ListAttachment einen Wert ähnlich dem folgenden:

    [{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Beispiel – Rechnungs-E-Mail senden

In diesem Beispiel wird eine E-Mail für die angegebene Rechnung gesendet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion SendInvoiceMail aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe SendInvoiceMail einen Wert ähnlich dem folgenden:

    [{
"Success": "true"
}]

Beispiel – Datei hochladen

In diesem Beispiel wird eine Datei hochgeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadFile aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"Name": "Sample1.txt",
"Content": "This is a sample file"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe UploadFile einen Wert ähnlich dem folgenden:

    [{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Beispiele für Entitätsvorgänge

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

Beispiel – Alle Einträge auflisten

In diesem Beispiel werden alle Datensätze in der Entität Accounts aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Accounts aus der Entity-Liste 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 die Ergebnisse filtern, indem Sie eine Filterklausel angeben. Beispiel: City='Bangalore' Sie können auch mehrere Filterbedingungen angeben, indem Sie die logischen Operatoren verwenden. Zum Beispiel: City='Bangalore' and region='asia-south2'.

Beispiel – Rechnung abrufen

In diesem Beispiel wird eine Rechnung mit der angegebenen ID von der Entität Invoices abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Invoices aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf EntityId und geben Sie dann 1|016a64c7-be0b-45a2-acae-13057fdf1566 in das Feld Default Value (Standardwert) ein.

    Hier ist 1|016a64c7-be0b-45a2-acae-13057fdf1566 ein Primärschlüssel/Wert in der Entität Invoices.

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ähle Invoices aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}

    Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

    {
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}

Beispiel – Datensatz aktualisieren

In diesem Beispiel wird ein Datensatz in der Entität AssetTypes aktualisiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle AssetTypes aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. Klicken Sie auf entityId und geben Sie im Feld Default Value (Standardwert) f8d43548-25b0-4cc3-8f59-d97106974fe8 ein.

    Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

    {
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}

Beispiel – Datei löschen

In diesem Beispiel wird die Datei mit der angegebenen ID aus der Entität Files gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Files aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und geben Sie im Feld Default Value (Standardwert) 421c82f0-38fb-4074-a679-63b04c0d8832 ein.

Nachdem Sie die Verbindung erstellt haben, ist sie in Apigee Integration und 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 der Apigee-Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors.

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