Informationen zu den unterstützten Connectors für Application Integration.

Benutzerdefinierten Connector erstellen

Auf dieser Seite wird beschrieben, wie Sie einen benutzerdefinierten Connector erstellen. Informationen zu benutzerdefinierten Connectors finden Sie unter Benutzerdefinierte Connectors.

Wenn Sie eine Verbindung zu Ihrem Back-End über einen benutzerdefinierten Connector herstellen möchten, müssen Sie die folgenden Aufgaben ausführen:

  1. Benutzerdefinierten Connector erstellen: In dieser Aufgabe definieren Sie den Vertrag zwischen der Anwendungsintegration und Ihrem Endpunkt (Backend), indem Sie die OpenAPI-Spezifikation des Endpunkts angeben. Derzeit werden nur OpenAPI-Version 3.0 und alle zugehörigen Nebenversionen unterstützt. Die Spezifikation muss nur einmal angegeben werden.
  2. Benutzerdefinierte Connector-Verbindung erstellen: In dieser Aufgabe konfigurieren Sie die Verbindungsdetails Ihres Backends, z. B. den Hostnamen und die Authentifizierung. Für einen bestimmten benutzerdefinierten Connector können Sie beliebig viele Verbindungen erstellen.

Weitere Informationen zum Unterschied zwischen einem Connector und einer Verbindung finden Sie unter Connector und Verbindung im Vergleich.

Hinweise

Benutzerdefinierten Connector erstellen

Wie in den Szenarien für die Backend-Konnektivität beschrieben, können benutzerdefinierte Connectors eines der folgenden Konnektivitätsmuster haben:

  • Direkte Verbindung zum öffentlichen Endpunkt Ihres Backends.
  • Indirekte Verbindung zu Ihrem Backend über einen vermittelnden öffentlichen Endpunkt.

Die Schritte zum Erstellen benutzerdefinierter Connector unterscheiden sich bei diesen beiden Mustern geringfügig.

Mit direkter Verbindung erstellen

So erstellen Sie einen benutzerdefinierten Connector mit direkter Verbindung zum Endpunkt Ihres Backends:

Console

  1. Rufen Sie in der Console die Seite Anwendungsintegration > Benutzerdefinierte Connectors auf und wählen Sie ein Google Cloud Projekt aus oder erstellen Sie eins.

    Zur Seite „Benutzerdefinierte Konnektoren“

  2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
  3. Legen Sie im Abschnitt Anschlussdetails die folgenden Felder fest:
    1. Name des Connectors: Geben Sie einen Namen für den Connector ein.
    2. Anzeigename: Geben Sie einen Anzeigenamen für den Connector ein.
    3. Beschreibung: Geben Sie eine Beschreibung ein.
    4. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
    5. Logo: Laden Sie das Bild in einen Cloud Storage-Bucket hoch, um es als Connector-Logo zu verwenden.
  4. Klicken Sie auf Weiter.
  5. Legen Sie im Abschnitt Connector-Spezifikation die folgenden Felder fest:
    1. Benutzerdefinierter Anschlusstyp: Wählen Sie den benutzerdefinierten Anschlusstyp aus.
    2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer Open API-Spezifikation ein oder laden Sie die Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
  6. Prüfen Sie die Details zur Connectorkonfiguration und klicken Sie dann auf Erstellen.

Wenn die Erstellung des Connectors erfolgreich war, wird er auf der Seite Zur Seite „Benutzerdefinierte Connectors“ angezeigt. Bei einem neuen Connector wird auch eine erste Version des Connectors erstellt. Sie finden die Versionsdetails auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Weitere Informationen finden Sie unter .

Beachten Sie jedoch, dass Sie für die Verbindung zu Ihrem Backend eine Verbindung für den neu erstellten Connector erstellen müssen. Weitere Informationen finden Sie unter Benutzerdefinierte Connector-Verbindung erstellen.

API

In den folgenden Beispielbefehlen wird gezeigt, wie Sie mithilfe der Application Integration APIs einen benutzerdefinierten Connector erstellen:

  1. Erstellen Sie den Connector. 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    Ersetzen Sie Folgendes:

    • CUSTOM_CONNECTOR_NAME: Ein Name für den benutzerdefinierten Connector.
    • PROJECT_ID: Die ID Ihres Google Cloud Projekts.
    • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Anschluss. Beispiel: custom-connector-1.
  2. Konfigurieren Sie die Version des benutzerdefinierten Connectors. 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL",}' \
"https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"

    3. Ersetzen Sie Folgendes:

    • SPECIFICATION_URL: Die URL der Open API-Spezifikation. Beispiel:https://petstore3.swagger.io/api/v3/openapi.json.
    • PROJECT_ID: Die ID Ihres Google Cloud Projekts.
    • VERSION_NUMBER: Eine Versionsnummer für den Connector. Beispiel: 2.

Mit indirekter Konnektivität erstellen

So erstellen Sie einen benutzerdefinierten Connector, der über einen Zwischenendpunkt eine Verbindung zu Ihrem Backend herstellt:

Console

  1. Rufen Sie in der Console die Seite Anwendungsintegration > Benutzerdefinierte Connectors auf und wählen Sie ein Google Cloud Projekt aus oder erstellen Sie eins.

    Zur Seite „Benutzerdefinierte Konnektoren“

  2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
  3. Legen Sie im Abschnitt Anschlussdetails die folgenden Felder fest:
    1. Name des Connectors: Geben Sie einen Namen für den Connector ein.
    2. Anzeigename: Geben Sie einen Anzeigenamen für den Connector ein.
    3. Beschreibung: Geben Sie eine Beschreibung ein.
    4. Connector-Ziel für den Back-End-Zugriff konfigurieren: Aktivieren Sie diese Option. Dadurch werden die zusätzlichen Konfigurationsabschnitte auf der Seite angezeigt.
    5. Dienstkonto: Wählen Sie ein Dienstkonto aus, das über die erforderlichen Rollen verfügt.
    6. Logo: Laden Sie das Bild in einen Cloud Storage-Bucket hoch, um es als Connector-Logo zu verwenden.
  4. Klicken Sie auf Weiter.
  5. Legen Sie im Abschnitt Connector-Spezifikation die folgenden Felder fest:
    1. Benutzerdefinierter Anschlusstyp: Wählen Sie den benutzerdefinierten Anschlusstyp aus.
    2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer Open API-Spezifikation ein oder laden Sie die Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
  6. Klicken Sie auf Weiter.
  7. Legen Sie im Abschnitt Connector-Ziel die folgenden Felder fest:
    1. Zieltyp: Wählen Sie Hostadresse aus.
    2. Host: Geben Sie den Hostnamen ein, unter dem Ihr Intermediärdienst ausgeführt wird.
    3. Port: Geben Sie die Portnummer Ihres Vermittlungsdiensts ein.
  8. Klicken Sie auf Weiter.
  9. Wählen Sie im Abschnitt Connector-Authentifizierung den Authentifizierungstyp des Intermediärdienstes aus und geben Sie dann die entsprechenden Details ein. In diesem Schritt konfigurieren Sie die Authentifizierung von der Anwendungsintegration zum Intermediärdienst.

    Die Authentifizierungskonfiguration vom Vermittlungsdienst zum Backend kann nicht in der Anwendungsintegration konfiguriert werden. Es liegt im Ermessen des Vermittlungsdienstes, wie er sich beim Backend authentifizieren möchte.

    Sie können die folgenden Authentifizierungstypen verwenden, um sich beim Intermediärdienst zu authentifizieren:

    • Dienstkonto-Authentifizierung
    • Authentifizierung per API-Schlüssel
    • OAuth 2.0 – Authentifizierung mit Clientanmeldedaten
    • Basisauthentifizierung
    • Digest-Authentifizierung

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

    Wenn der Zugriff auf die Ressourcen der API uneingeschränkt ist und keine Authentifizierung erfordert, wählen Sie Keine Authentifizierung aus.

  10. Klicken Sie auf Weiter.
  11. Geben Sie im Abschnitt Backend-Variablen die Werte ein, die Sie über den Vermittlungsdienst an Ihr Backend senden möchten. Sie müssen die Werte als Schlüssel/Wert-Paare konfigurieren. Wenn Sie ein Schlüssel/Wert-Paar eingeben möchten, klicken Sie auf Variable hinzufügen und legen Sie dann die folgenden Felder fest:
    • Schlüssel: Geben Sie den Schlüsselnamen ein.
    • Werttyp: Wählen Sie den Datentyp der Variablen aus.
    • Anzeigename: Geben Sie einen Anzeigenamen ein.
    • Speicherort: Legen Sie fest, wie der Connector die Variablen an den Zwischendienst senden soll. Verfügbare Optionen sind Header, Request payload und Query parameter.
    • Optional: Wählen Sie Required aus, um anzugeben, dass es sich um eine Pflichtvariable handelt.
  12. Klicken Sie auf Weiter.
  13. Prüfen Sie die Details zur Connectorkonfiguration und klicken Sie dann auf Erstellen.

Wenn die Erstellung des Connectors erfolgreich war, wird er auf der Seite Benutzerdefinierte Connectors angezeigt. Bei einem neuen Connector wird auch eine erste Version des Connectors erstellt. Sie finden die Versionsdetails auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Informationen zum Erstellen und Bearbeiten einer benutzerdefinierten Connectorversion finden Sie unter Benutzerdefinierte Connectorversionen verwalten.

Beachten Sie jedoch, dass Sie für die Verbindung zu Ihrem Backend eine Verbindung für den neu erstellten Connector erstellen müssen. Weitere Informationen finden Sie unter Benutzerdefinierte Connector-Verbindung erstellen.

Authentifizierung konfigurieren

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

  • Authentifizierung des Dienstkontos

    Wählen Sie diese Option aus, um sich mit einem Google Cloud-Dienstkonto zu authentifizieren. Achten Sie darauf, dass Sie dem Dienstkonto die für die Authentifizierung erforderlichen IAM-Rollen und -Berechtigungen zugewiesen haben.

    • Bereiche: Wählen Sie im Drop-down-Menü die erforderlichen OAuth 2.0-Bereiche aus. Weitere Informationen finden Sie unter Zugriffsbereiche.
  • Authentifizierung von API-Schlüsseln

    Wählen Sie diese Option aus, um sich mit einem API-Schlüssel zu authentifizieren.

    • API-Schlüssel: Wählen Sie das Secret Manager-Secret des API-Schlüssels aus.
    • Secret-Version: Wählen Sie die Secret-Version aus.
    • Name des API-Schlüsselparameters: Geben Sie einen Parameternamen für den API-Schlüssel ein. Ein API-Schlüssel wird als Schlüssel/Wert-Paar an deinen Back-End-Server gesendet. Der hier eingegebene Wert wird als Schlüsselname für den zuvor ausgewählten API-Schlüssel verwendet.
    • API-Schlüsselspeicherort: Wählen Sie aus, wo Sie den API-Schlüssel in der Anfrage hinzufügen möchten.
  • OAuth 2.0 – Clientanmeldedaten gewähren
    • Client-ID: Die Client-ID, die für die Authentifizierung beim Vermittlungsdienst verwendet werden soll.
    • Client-Secret: Secret Manager-Secret mit dem Client-Secret zur Authentifizierung beim Intermediärdienst.
    • Anfrageformat für Zugriffstoken: Anfrageformat, das in Anfragen verwendet wird, um das Zugriffstoken vom Authentifizierungsserver abzurufen. Wählen Sie body aus, um die Client-ID und das Secret als Anfragetext zu übergeben, oder header, um sie als codierten Header zu übergeben.
    • Token-Anfragepfad: Anfragepfad, der an die Authentifizierungsserver-URL angehängt wird, um die Zugriffstoken-URL abzurufen.
  • Basisauthentifizierung
    • Nutzername: Der Nutzername, der für die Authentifizierung beim Intermediärdienst verwendet wird.
    • Kennwort: Secret Manager-Secret mit dem Passwort, das dem angegebenen Nutzernamen zugeordnet ist.
  • Digest-Authentifizierung
    • Nutzername: Der Nutzername, der für die Authentifizierung beim Intermediärdienst verwendet wird.
    • Kennwort: Secret Manager-Secret mit dem Passwort, das dem angegebenen Nutzernamen zugeordnet ist.

API

In den folgenden Beispielbefehlen wird gezeigt, wie Sie mithilfe der Application Integration APIs einen benutzerdefinierten Connector erstellen:

  1. Erstellen Sie den Connector. 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    Ersetzen Sie Folgendes:

    • CUSTOM_CONNECTOR_NAME: Ein Name für den benutzerdefinierten Connector.
    • PROJECT_ID: Die ID Ihres Google Cloud Projekts.
    • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Anschluss. Beispiel: custom-connector-1.
  2. Konfigurieren Sie die Version des benutzerdefinierten Connectors und die Authentifizierung. 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL", \
"service_account":"test-sa", \
"enable_backend_destination_config": true, \
"auth_config": { \
"auth_type":"USER_PASSWORD", \
"auth_key": "basic", \
"user_password": { \
"username":"USERNAME", \
"password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
}}, \
"backend_variable_templates": [{ \
"key":"authkey", \
"value_type":"SECRET", \
"display_name":"Authorization Key", \
"required":true, \
"location_type": "HEADER" \
}], \
"destination_configs":[{ \
"key":"base_url", \
"destinations": [{ \
"host":"DESTINATION_HOST_ADDRESS" \
}]} \
]}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"

    3. Ersetzen Sie Folgendes:

    • SPECIFICATION_URL: Die URL der Open API-Spezifikation. Beispiel:https://petstore3.swagger.io/api/v3/openapi.json.
    • PROJECT_ID: Die ID Ihres Google Cloud Projekts.
    • USERNAME: Nutzername für die Authentifizierung beim Vermittlungsdienst.
    • SECRET_VERSION_NUMBER: Die Versionsnummer des Secret Manager-Secrets. Beispiel: 2.
    • DESTINATION_HOST_ADDRESS: Hostadresse des Vermittlungsdienstes. Beispiel: http://www.test.com:80.
    • CONNECTOR_VERSION_NUMBER: Die Versionsnummer des benutzerdefinierten Connectors. Beispiel: 1.

Verbindung mit benutzerdefiniertem Connector erstellen

Nachdem Sie den benutzerdefinierten Connector erstellt haben, müssen Sie eine Verbindung des benutzerdefinierten Connector-Typs erstellen, um eine Verbindung zum Backend herzustellen. Im Folgenden finden Sie eine allgemeine Anleitung zum Erstellen einer neuen Verbindung:

  1. Klicken Sie auf Neu erstellen, um die Seite Verbindung erstellen zu öffnen.
  2. Wählen Sie im Abschnitt Standort im Feld Region einen Standort für die Verbindung aus.

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

  3. Klicken Sie auf Weiter.
  4. Legen Sie im Abschnitt Verbindungsdetails die folgenden Felder fest:
    1. Connector: Wählen Sie den benutzerdefinierten Connector 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 Verbindung 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 Verbindung ein.
    5. Optional können Sie Cloud Logging aktivieren auswählen, um Cloud Logging zu aktivieren.
    6. Dienstkonto: Wählen Sie ein Dienstkonto aus, 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.

    8. Klicken Sie optional auf Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
  5. Klicken Sie auf Weiter.
  6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails für Ihr Backend ein.
    • Wenn Sie eine direkte Verbindung zu Ihrem Backend herstellen, werden Sie von der Anwendungsintegration aufgefordert, die Authentifizierung für Ihr Backend zu konfigurieren.
    • Wenn Sie eine indirekte Verbindung über einen Vermittlungsdienst zu Ihrem Backend herstellen, werden Sie in Application Integration nicht aufgefordert, Authentifizierungsdetails zu konfigurieren. Beim Erstellen des Connectors haben Sie bereits die Authentifizierung zwischen Application Integration und dem Intermediärdienst konfiguriert. Bei der Anwendungsintegration müssen Sie die Authentifizierung zwischen dem Vermittlungsdienst und dem Backend nicht konfigurieren. Es liegt im Ermessen des Vermittlungsdienstes, wie er sich beim Backend authentifizieren möchte.
  7. Klicken Sie auf Weiter.
  8. Prüfen Sie die Details zur Verbindungskonfiguration und klicken Sie dann auf Erstellen.

Wenn die Verbindung erfolgreich erstellt wurde, wird sie auf der Seite Alle Verbindungen aufgeführt und ist für die Anwendungsintegration verfügbar. Sie können die Verbindung in Ihrer Integration über die Connectors-Aufgabe verwenden.

Hinweise

Beachten Sie beim Erstellen eines benutzerdefinierten Connectors die folgenden Punkte:

  • Die Anwendungsintegration unterstützt nur OpenAPI-Version 3.0 und alle zugehörigen Minor-Versionen.
  • Die OpenAPI-Spezifikation wird beim Erstellen eines benutzerdefinierten Connectors nicht validiert. Wenn Sie eine Verbindung für den benutzerdefinierten Connector erstellen, wird die Spezifikation von der Anwendungsintegration validiert. Wenn Fehler auftreten, hat die Verbindung den Status Error.
  • Bei der Anwendungsintegration wird nicht zwischen Entitäten und Aktionen unterschieden. Daher werden sowohl die Entitäten als auch die Aktionen Ihres Backends in Ihrem benutzerdefinierten Connector als Actions aufgeführt.
  • Benutzerdefinierte Connectors werden in Google Cloud Projekten, in denen VPC Service Controls aktiviert sind, nicht unterstützt.
  • Sowohl der Endpunkt der OpenAPI-Spezifikation als auch der Back-End-Endpunkt sollten öffentlich zugänglich sein. Das bedeutet, dass Sie keine private Verbindung zu Ihrem Backend herstellen können.
  • Der mehrteilige Medientyp wird in der Open API-Spezifikation nicht unterstützt.
  • Die Versionsdetails eines benutzerdefinierten Connectors können nicht bearbeitet werden.

Kontingente und Limits

Weitere Informationen zu allen Kontingenten und Limits finden Sie unter Kontingente und Limits.

Nächste Schritte