Benutzerdefinierten Connector erstellen

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

Führen Sie die folgenden Aufgaben aus, um mithilfe eines benutzerdefinierten Connectors eine Verbindung zum Back-End herzustellen:

  1. Benutzerdefinierten Connector erstellen: In dieser Aufgabe definieren Sie den Vertrag zwischen Integration Connectors und Ihrem Endpunkt (Back-End), indem Sie die OpenAPI-Spezifikation des Endpunkts angeben. Derzeit werden nur OpenAPI Version 3.0 und alle zugehörigen Nebenversionen unterstützt. Die Angabe der Spezifikation ist eine einmalige Aktivität.
  2. Benutzerdefinierte Connector-Verbindung erstellen: In dieser Aufgabe konfigurieren Sie die Verbindungsdetails Ihres Back-Ends wie den Hostnamen und die Authentifizierung. Sie können für einen bestimmten benutzerdefinierten Connector beliebig viele Verbindungen erstellen.

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

Hinweise

Der Nutzer, der den benutzerdefinierten Connector erstellt, muss eine der folgenden IAM-Rollen haben:

Benutzerdefinierten Connector erstellen

Wie unter Back-End-Konnektivitätsszenarien beschrieben, können benutzerdefinierte Connectors eines der folgenden Verbindungsmuster haben:

  • Direkte Verbindung zum öffentlichen Endpunkt Ihres Back-Ends.
  • Indirekte Verbindung zu Ihrem Back-End über einen öffentlichen Zwischenendpunkt.

Die Schritte zum Erstellen eines benutzerdefinierten Connectors variieren für diese beiden Muster geringfügig.

Benutzerdefinierten Connector mit direkter Verbindung erstellen

So erstellen Sie einen benutzerdefinierten Connector mit direkter Verbindung zum Back-End-Endpunkt:

Console

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

    Zur Seite „Benutzerdefinierte Connectors“

  2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
  3. Legen Sie im Bereich Connector-Details die folgenden Felder fest:
    1. Connector-Name: 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 mit den erforderlichen Rollen aus.
    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 Connector-Typ: Wählen Sie den benutzerdefinierten Connector-Typ aus.
    2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer OpenAPI-Spezifikation ein oder laden Sie Ihre Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
  6. Prüfen Sie die Details der Connector-Konfiguration und klicken Sie dann auf Erstellen.

Wenn der Connector erfolgreich erstellt wurde, wird er auf der Seite „Benutzerdefinierte Connectors“ angezeigt. Wenn es sich um einen neuen Connector handelt, wird auch eine erste Version des Connectors erstellt. Die Versionsdetails finden Sie auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Weitere Informationen finden Sie unter .

Sie müssen jedoch eine Verbindung für den neu erstellten Connector herstellen, um eine Verbindung zum Back-End herzustellen. Weitere Informationen finden Sie unter Verbindung zu einem benutzerdefinierten Connector erstellen.

API

Die folgenden Beispielbefehle zeigen, wie Sie mithilfe der Integration Connectors 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: ID Ihres Google Cloud-Projekts.
    • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Connector. 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 OpenAPI-Spezifikation. Beispiel: https://petstore3.swagger.io/api/v3/openapi.json.
    • PROJECT_ID: ID Ihres Google Cloud-Projekts.
    • VERSION_NUMBER: Eine Versionsnummer für den Connector. Beispiel: 2.

Benutzerdefinierten Connector mit indirekter Verbindung erstellen

So erstellen Sie einen benutzerdefinierten Connector, der über einen Zwischenendpunkt eine Verbindung zum Back-End herstellt:

Console

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

    Zur Seite „Benutzerdefinierte Connectors“

  2. Klicken Sie auf Neu erstellen, um die Seite Benutzerdefinierten Connector erstellen zu öffnen.
  3. Legen Sie im Bereich Connector-Details die folgenden Felder fest:
    1. Connector-Name: 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 Back-End-Zugriff konfigurieren: Aktivieren Sie diese Option. Hier werden die zusätzlichen Konfigurationsabschnitte auf der Seite angezeigt.
    5. Dienstkonto: Wählen Sie ein Dienstkonto mit den erforderlichen Rollen aus.
    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 Connector-Typ: Wählen Sie den benutzerdefinierten Connector-Typ aus.
    2. Connector-Spezifikation: Geben Sie entweder die öffentliche URL Ihrer OpenAPI-Spezifikation ein oder laden Sie Ihre Spezifikationsdatei in einen Cloud Storage-Bucket hoch.
  6. Klicken Sie auf Weiter.
  7. Legen Sie im Bereich Connector-Ziel die folgenden Felder fest:
    1. Zieltyp: Wählen Sie Hostadresse aus.
    2. Host: Geben Sie den Hostnamen ein, auf dem der Vermittlungsdienst ausgeführt wird.
    3. Port: Geben Sie die Portnummer Ihres Vermittlungsdienstes ein.
  8. Klicken Sie auf Weiter.
  9. Wählen Sie im Bereich Connector-Authentifizierung den Authentifizierungstyp des Vermittlungsdienstes aus und geben Sie dann die entsprechenden Details ein, wenn Sie dazu aufgefordert werden. In diesem Schritt konfigurieren Sie die Authentifizierung von Integration Connectors beim Vermittlungsdienst.

    Die Authentifizierungskonfiguration vom Vermittlungsdienst zum Back-End kann nicht in Integration Connectors konfiguriert werden. Der Vermittlungsdienst entscheidet, wie er sich beim Back-End authentifizieren möchte.

  10. Klicken Sie auf Weiter.
  11. Geben Sie im Bereich Back-End-Variablen die Werte ein, die Sie über den Vermittlungsdienst an Ihr Back-End senden möchten. Sie müssen die Werte als Schlüssel/Wert-Paar Paris konfigurieren. Klicken Sie auf Variable hinzufügen und legen Sie die folgenden Felder fest, um ein Schlüssel/Wert-Paar einzugeben:
    • Schlüssel: Geben Sie den Schlüsselnamen ein.
    • Werttyp: Wählen Sie den Datentyp der Variablen aus.
    • Display name (Anzeigename): Geben Sie einen Anzeigenamen ein.
    • Speicherort: Geben Sie an, wie der Connector die Variablen an den Vermittlungsdienst senden soll. Die verfügbaren Optionen sind Header, Request payload und Query parameter.
    • Wählen Sie optional Required aus, um anzugeben, dass die Variable eine obligatorische Variable ist.
  12. Klicken Sie auf Weiter.
  13. Prüfen Sie die Details der Connector-Konfiguration und klicken Sie dann auf Erstellen.

Wenn der Connector erfolgreich erstellt wurde, wird er auf der Seite Benutzerdefinierte Connectors angezeigt. Wenn es sich um einen neuen Connector handelt, wird auch eine erste Version des Connectors erstellt. Die Versionsdetails finden Sie auf der Seite Details zum benutzerdefinierten Connector auf dem Tab Version. Informationen zum Erstellen und Bearbeiten einer benutzerdefinierten Connector-Version finden Sie unter Versionen von benutzerdefinierten Connectors verwalten.

Sie müssen jedoch eine Verbindung für den neu erstellten Connector herstellen, um eine Verbindung zum Back-End herzustellen. Weitere Informationen finden Sie unter Verbindung zu einem benutzerdefinierten Connector erstellen.

API

Die folgenden Beispielbefehle zeigen, wie Sie mithilfe der Integration Connectors 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: ID Ihres Google Cloud-Projekts.
    • UNIQUE_IDENTIFIER: Eine eindeutige Kennung für den Connector. 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 OpenAPI-Spezifikation. Beispiel: https://petstore3.swagger.io/api/v3/openapi.json.
    • PROJECT_ID: 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.

Benutzerdefinierte Connector-Verbindung 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 sind die übergeordneten Schritte zum Erstellen einer neuen Verbindung aufgeführt:

  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 im Feld Region einen Standort für die Verbindung aus.

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

  4. Klicken Sie auf Weiter.
  5. Legen Sie im Bereich Verbindungsdetails die folgenden Felder fest:
    1. Connector: Wählen Sie Ihren 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 eine Beschreibung für die Verbindung ein.
    5. Wählen Sie optional Cloud Logging aktivieren aus, um Cloud Logging zu aktivieren.
    6. Dienstkonto: Wählen Sie ein Dienstkonto mit den erforderlichen Rollen aus.
    7. 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.

    8. Klicken Sie optional auf Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
  6. Klicken Sie auf Weiter.
  7. Geben Sie im Bereich Authentifizierung die Authentifizierungsdetails für Ihr Back-End ein.
    • Wenn Sie eine direkte Verbindung zu Ihrem Back-End herstellen, werden Sie von Integration Connectors aufgefordert, die Authentifizierung für Ihr Back-End zu konfigurieren.
    • Wenn Sie indirekt über einen Vermittlungsdienst eine Verbindung zu Ihrem Back-End herstellen, werden Sie von Integration Connectors nicht zur Konfiguration von Authentifizierungsdetails aufgefordert. Beim Erstellen des Connectors müssen Sie die Authentifizierung zwischen Integration Connectors und dem Vermittlungsdienst bereits konfiguriert haben. Für Integration Connectors ist keine Konfiguration der Authentifizierung zwischen dem Vermittlungsdienst und dem Back-End erforderlich. Der Vermittlungsdienst entscheidet, wie er sich beim Back-End authentifizieren möchte.
  8. Klicken Sie auf Weiter.
  9. Prüfen Sie die Details der Verbindungskonfiguration und klicken Sie dann auf Erstellen.

Wenn die Verbindung erstellt wurde, wird sie auf der Seite Alle Verbindungen aufgeführt und die Verbindung wird in Application Integration verfügbar gemacht. Sie können die Verbindung in Ihrer Integration über die Connectors-Task verwenden.

Hinweise

Beachten Sie beim Erstellen eines benutzerdefinierten Connectors Folgendes:

  • Integration Connectors unterstützt nur OpenAPI Version 3.0 und alle zugehörigen Nebenversionen.
  • Die OpenAPI-Spezifikation wird beim Erstellen des benutzerdefinierten Connectors nicht validiert. Wenn Sie eine Verbindung für den benutzerdefinierten Connector erstellen, validiert Integration Connectors die Spezifikation. Falls Fehler auftreten, hat die Verbindung den Status Error.
  • Integrations-Connectors unterscheiden nicht zwischen Entitäten und Aktionen. Daher werden sowohl die Entitäten als auch die Aktionen Ihres Back-Ends als Actions in Ihrem benutzerdefinierten Connector aufgeführt.
  • Benutzerdefinierte Connectors werden in Google Cloud-Projekten nicht unterstützt, für die VPC Service Controls aktiviert ist.
  • Sowohl der Endpunkt der OpenAPI-Spezifikation als auch der Back-End-Endpunkt sollten öffentlich zugänglich sein. Dies bedeutet, dass Sie keine private Verbindung zu Ihrem Back-End herstellen können.
  • Der mehrteilige Medientyp wird in der OpenAPI-Spezifikation nicht unterstützt.
  • Sie können die Versionsdetails eines benutzerdefinierten Connectors nicht bearbeiten.