Erste Schritte mit Apigee Integration

Sie lesen die Dokumentation zu Apigee X.
Apigee Edge-Dokumentation aufrufen

In dieser Kurzanleitung erfahren Sie, wie Sie eine Beispielintegration in Apigee erstellen. In den folgenden Schritten wird beschrieben, wie Sie Trigger, Aufgaben, Edges, Variablen und Datenabgleiche konfigurieren, die für eine vollständige Integration erforderlich sind. In dieser Kurzanleitung rufen Sie eine Produktliste von einem URL-Endpunkt ab, wandeln die Daten in ein verwendbares Format um und senden die resultierende Liste per E-Mail – alles über den Integrationsdesigner.

Integrationen aktivieren

Zum Aktivieren des Integrationen-Features in Apigee können Sie entweder eine Evaluierungsorganisation für Testversionen erstellen oder für die Integrationen bezahlen, wenn Sie ein Apigee-Abo haben.

Integrationen in einer Evaluierungsorganisation aktivieren

Mit einer Evaluierungsorganisation können Sie das Apigee-Integrationen-Feature testen, ohne für die Nutzung eine Rechnung zu erhalten. Informationen zum Bereitstellen einer Evaluierungsorganisation finden Sie unter Evaluierungsorganisation bereitstellen. Verwenden Sie eine Evaluierungsorganisation, wenn Sie das Integrationen-Feature nur untersuchen und ausprobieren möchten, denn die in einer Evaluierungsorganisation erstellten Integrationen haben einige Einschränkungen. Weitere Informationen finden Sie unter Vergleich von Evaluierungsorganisationen mit kostenpflichtigen Organisationen.

In der Evaluierungsorganisation sind die Integrationen und das Connectors-Add-on bereits aktiviert. Das Connectors-Add-on ist erforderlich, um über die Integrationen auf externe Datenquellen zuzugreifen. Nach der Bereitstellung der Evaluierungsorganisation müssen Sie nur die folgenden APIs für die Evaluierungsorganisation aktivieren und Sie können das Integrationen-Feature verwenden.

  • Cloud Integrations API (integrations.googleapis.com)
  • Connectors API (connectors.googleapis.com)

Nachdem Sie die APIs aktiviert haben, können Sie mit dem Erstellen der Integrationen beginnen. Weitere Informationen finden Sie im Abschnitt Neue Integration erstellen.

Integrationen in einer kostenpflichtigen Organisation aktivieren

Wenn Sie Apigee-Integrationen ohne Einschränkungen verwenden möchten, können Sie für die Integrationen bezahlen. Apigee Integration ist als Add-on-Dienst für Ihr Abo verfügbar. Als ersten Schritt wenden Sie sich an den Apigee-Support, um Ihrem Abo Integration und Connectors hinzuzufügen. Nachdem Sie sie Ihrem Abo hinzugefügt haben, führen Sie die folgenden Aufgaben aus:

  1. Aktivieren Sie folgende APIs:
    • Apigee API (apigee.googleapis.com)
    • Cloud Integrations API (integrations.googleapis.com)
    • Secret Manager API (secretmanager.googleapis.com)
    • Connectors API (connectors.googleapis.com)

    Informationen zum Aktivieren der APIs finden Sie unter Dienste aktivieren.

  2. Aktivieren Sie die Add-ons und die Connectors-Add-ons für Ihre Apigee-Organisation.
    • Wenn Sie eine neue Organisation für die Integration erstellen, führen Sie den folgenden Befehl aus:

      curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"
    • Wenn Sie eine vorhandene Organisation verwenden, führen Sie den folgenden Befehl aus:

      curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'

    Um zu prüfen, ob die Add-ons erfolgreich aktiviert wurden, führen Sie den folgenden Befehl aus:

    curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"

    Bei Ausführung des Befehls sollte eine Meldung wie die folgende angezeigt werden:

    {
      "name": "Test....",
      "createdAt": "1615483867669",
      "lastModifiedAt": "1615483873468",
      …...
      "addonsConfig": {
        "integrationConfig": {
          "enabled": true,
        "connectorsPlatformConfig": {
          "enabled": true
        }
      }
    }
  3. Gewähren Sie dem Apigee-Dienst-Agent (service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com) die erforderlichen IAM-Rollen und -Berechtigungen.

    So erteilen Sie die Berechtigungen:

    1. Wechseln Sie in der Cloud Console zur Seite IAM und Verwaltung > IAM.
    2. Wählen Sie Von Google bereitgestellte Rollenzuweisungen einschließen aus. Dadurch wird der Apigee-Dienst-Agent zusammen mit anderen Hauptkonten angezeigt.
    3. Weisen Sie dem Apigee-Dienst-Agent die erforderlichen Rollen zu.
    4. Klicken Sie auf Speichern.
  4. Weisen Sie Ihrem Google Cloud-Projekt die folgenden Rollen zu:
    • Editor
    • Apigee-Organisationsadministrator
    • Administrator von Apigee-Integrationen
    • Connector-Administrator

Neue Integration erstellen

So erstellen Sie eine neue Integration:

  1. Wechseln Sie zur Apigee-Benutzeroberfläche und melden Sie sich an.
  2. Wählen Sie Ihre Organisation im Drop-down-Menü oben links in der Benutzeroberfläche aus.
  3. Klicken Sie auf Entwickeln > Integrationen.
  4. Klicken Sie auf NEU ERSTELLEN.
  5. Geben Sie im Dialogfeld Integration erstellen einen Namen und eine Beschreibung ein. Beispiel: my-test-integration.
  6. Wählen Sie eine Region für die Integration aus der Liste der unterstützten Regionen aus.
  7. Klicken Sie auf Erstellen, um den Integrationsdesigner zu öffnen.

Trigger konfigurieren

Trigger sind erforderlich, um die Abfolge der Aufgaben zu starten, aus denen eine Integration besteht. Mit jedem verfügbaren Trigger kann eine Integration gestartet werden. Für die Kurzanleitung verwenden Sie den API-Trigger.

So konfigurieren Sie den API-Trigger:

  1. Wählen Sie im Integrationsdesigner Aufgabe/Trigger hinzufügen > Trigger aus, um eine Liste der verfügbaren Trigger aufzurufen.
  2. Ziehen Sie das Element API-Trigger in den Integrationsdesigner.
  3. Klicken Sie im Designer auf das Element API-Trigger, um den Bereich für die Triggerkonfiguration zu öffnen.
  4. Apigee Integration fügt für den Trigger Label, Triggername und Trigger-ID automatisch ein. Die Trigger-ID wird maschinengeneriert und Sie können den Wert nicht bearbeiten. Sie können jedoch den Wert der Attribute Label und Triggername bearbeiten.

    Änderungen an den Attributen werden automatisch gespeichert.

Aufgaben hinzufügen und konfigurieren

Eine Aufgabe ist eine ausführbare Gruppe von Schritten, die Variablen als Eingaben verwenden und Variablen als Ausgaben generieren können. Wie bei Triggern kann jede verfügbare Aufgabe in einer Integration verwendet werden. In dieser Kurzanleitung werden die Aufgaben REST-Endpunkt aufrufen, Datenabgleich und E-Mail senden verwendet. Die Konfigurationsdetails für jede Aufgabe werden in den folgenden Schritten beschrieben.

Aufgabe "REST-Endpunkt aufrufen" konfigurieren

So konfigurieren Sie die Aufgabe REST-Endpunkt aufrufen:

  1. Wählen Sie Aufgabe/Trigger hinzufügen > Aufgaben aus, um eine Liste der verfügbaren Aufgaben aufzurufen.
  2. Ziehen Sie das Element REST-Endpunkt aufrufen in den Integrationsdesigner.
  3. Klicken Sie im Designer auf das Element REST-Endpunkt aufrufen, um den Aufgabenkonfigurationsbereich zu öffnen. Legen Sie die folgenden Attribute fest:
    • Label: Geben Sie einen benutzerdefinierten Namen für diese Aufgabe ein. Geben Sie beispielsweise Call REST Endpoint Task ein.
    • Authentifizierung: Für diese Kurzanleitung ist kein Authentifizierungsprofil erforderlich. Weitere Informationen zur Verwendung von Authentifizierungsprofilen für andere Anwendungsfälle finden Sie unter Authentifizierungsprofile in Apigee Integration erstellen.
    • AUFGABENEINGABE: Geben Sie die Details zum Aufrufen des REST-Endpunkts ein. Die hier eingegebenen Informationen werden als Eingabe für die Aufgabe REST-Endpunkt aufrufen verwendet. Geben Sie die folgenden Informationen ein:
      • Basis-URL des Endpunkts: Geben Sie https://apigee-pm4-prod.apigee.net/v1/hipsters/products ein. Dieser Endpunkt gibt ein Array von Produktobjekten mit id, name, description, picture, price und einem Array von categories zurück.
      • HTTP-Methode: Wählen Sie GET über die Drop-down-Liste aus.
      • Zusätzliche HTTP-Header: Geben Sie zusätzliche Header ein, die für den Zugriff auf den Endpunkt erforderlich sind. Für diese Kurzanleitung:
        • Geben Sie x-apikey in das Feld HTTP-Header-Schlüssel ein.
        • Geben Sie im Feld Wert H7WpkpvdCAC2jSffbmKpQLVduxC6nOO9 ein.
    • AUFGABENAUSGABE: Hier fügt Apigee Integration drei Variablen ein, die die Antwortdatenausgabe des Aufrufs des REST-Endpunkts enthalten:
      • responseHeader(REST-Endpunkt aufrufen): Diese Variable enthält die Antwort-Header-Daten, die mit der Aufgabe REST-Endpunkt aufrufen verknüpft sind. Die Variablendaten haben den Typ String (STR).
      • responseBody(REST-Endpunkt aufrufen): Diese Variable enthält die Antworttext-Daten, die mit der Aufgabe REST-Endpunkt aufrufen verknüpft sind. Die Variablendaten haben den Typ String (STR).
      • responseStatus(REST-Endpunkt aufrufen): Diese Variable enthält die Antwort-Statusdaten, die mit der Aufgabe REST-Endpunkt aufrufen verknüpft sind. Die Variablendaten haben den Typ String (STR).
    • Wenn Sie die Details der einzelnen Variablen aufrufen möchten, klicken Sie im Bereich der Aufgabenkonfiguration auf den Namen der Variable. Übernehmen Sie für diese Kurzanleitung die Standardwerte für jede dieser Variablen.
    • Die verbleibenden Felder sollten die folgenden Standardwerte enthalten:
      • Weiterleitungen folgen: True
      • Fehler ausgeben: False
      • Bei Fehler noch einmal versuchen
        • Wenn die Integration synchron ausgeführt wird: None
        • Wenn die Integration asynchron ausgeführt wird: None

    Änderungen an den Attributen werden automatisch gespeichert.

    Die fertige Konfiguration sollte der folgenden Abbildung entsprechen:

    Trigger "REST-Endpunkt aufrufen"

  4. Fügen Sie eine Edge-Verbindung aus dem Element API-Trigger dem Element REST-Endpunkt aufrufen hinzu, indem Sie den Mauszeiger auf einen Steuerungspunkt des Elements API-Trigger bewegen. Klicken Sie dann auf eine Zeile und ziehen Sie sie an einen Steuerungspunkt im Aufgabenelement REST-Endpunkt aufrufen. Die Steuerungspunkte und die Edge-Linie werden gelb, wie in der folgenden Abbildung dargestellt:

    Integrationsdesigner mit Edge-Verbindung

    Der Edge kennzeichnet den Steuerungsfluss vom API-Trigger zur Aufgabe REST-Endpunkt aufrufen.

Aufgabe "Datenabgleich" konfigurieren

So konfigurieren Sie die Aufgabe Datenabgleich:

  1. Wählen Sie Aufgabe/Trigger hinzufügen > Aufgaben aus, um eine Liste der verfügbaren Aufgaben aufzurufen.
  2. Ziehen Sie das Element Datenabgleich in den Integrationsdesigner.
  3. Klicken Sie im Designer auf die Aufgabe Datenabgleich, um den Konfigurationsbereich der Aufgabe zu öffnen.
  4. Klicken Sie auf Datenabgleichs-Editor öffnen.

    Mit den Transformationsfunktionen im Datenabgleichs-Editor können Sie Eingabevariablen den gewünschten Ausgabevariablen zuordnen. Die Ausgabe ist dann als Variable für alle anderen Integrationsaufgaben oder Trigger verfügbar. Weitere Informationen zur Übergabe von Daten als Variablen finden Sie unter Variablen in Apigee Integration verwenden.

    Für diese Kurzanleitung erstellen Sie einen Abgleich mit responseBody(REST-Endpunkt aufrufen) als Eingabe:

    1. Ziehen Sie den Chip responseBody aus der Liste Variablen links im Editor in das erste Eingabe-Feld.
    2. Klicken Sie im Chip responseBody auf + Funktion hinzufügen, um die Drop-down-Liste der verfügbaren Funktionen aufzurufen.
    3. Sie können eine Reihe von Datenabgleichsfunktionen anwenden, um die Daten in der Eingabevariablen zu transformieren. In diesem Fall können Sie die Nutzlast in JSON umwandeln und dann über das Antwortarray iterieren, um die Liste der Produktnamen abzurufen, die für Ihre E-Mail-Benachrichtigungen erforderlich sind. Klicken Sie auf das Symbol + Funktion hinzufügen für die Variable responseBody, um die Liste der verfügbaren Funktionen zu öffnen. Verwenden Sie die folgenden Funktionen:
      • Wählen Sie TO_JSON() aus, um den String responseBody in JSON zu konvertieren.
      • Klicken Sie im Variablenchip responseBody noch einmal auf das Symbol + Funktion hinzufügen, um die Funktion GET_PROPERTY() auszuwählen und zu verketten. Diese Funktion extrahiert ein Attribut aus der JSON-Nutzlast. Übergeben Sie das Attribut products.name als Parameter für diese Funktion. Sie erhalten eine Liste NUR mit Produktnamen ohne weitere Produktinformationen. Ihre Funktion sollte so aussehen:
        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(products.name)
      • Wenn Sie eine Funktion entfernen oder löschen möchten, klicken Sie auf das Symbol -. Dadurch wird die zuletzt hinzugefügte Funktion entfernt.
    4. Klicken Sie auf das erste Feld in der Spalte Ausgabe, um eine neue Variable zu erstellen, die den Wert der transformierten Daten enthält. Füllen Sie die folgenden Felder aus:
      • Name: Geben Sie JSONProdNameList ein.
      • Datentyp: JSON
      • Klicken Sie das Kästchen Als Ausgabe der Integration verwenden an.
      • Klicken Sie auf Erstellen, um die Variable zu erstellen, und schließen Sie den Bereich. Die neue Variable JSONProdNameList wird links im Datenabgleichseditor in der Liste Variablen angezeigt.
    5. Klicken Sie im Datenabgleichseditor auf X, um den Abgleich zu speichern und den Editor zu schließen.
    6. Der fertige Abgleich sollte der folgenden Abbildung entsprechen:

      Abbildung des fertigen Datenabgleichs und der Variablen

  5. Fügen Sie eine Edge-Verbindung vom Element REST-Endpunkt aufrufen zum Element Datenabgleich hinzu. Bewegen Sie dazu den Mauszeiger über einen Steuerungspunkt auf dem Element REST-Endpunkt aufrufen. Klicken Sie dann auf eine Linie und ziehen Sie sie an einen Steuerungspunkt im Aufgabenelement Datenabgleich. Der Edge kennzeichnet den Datenfluss von der Aufgabe REST-Endpunkt aufrufen zur Aufgabe Datenabgleich.

Aufgabe "E-Mail senden" konfigurieren

So konfigurieren Sie die Aufgabe E-Mail senden:

  1. Wählen Sie im Integrationsdesigner Aufgabe/Trigger hinzufügen > Aufgaben aus, um die Liste der verfügbaren Aufgaben aufzurufen.

    Verwenden Sie für diesen Schritt die Aufgabe E-Mail senden.

  2. Ziehen Sie das Element E-Mail senden in den Integrationsdesigner.
  3. Klicken Sie im Designer auf das Element E-Mail senden, um den Konfigurationsbereich der Aufgabe zu öffnen. Legen Sie die folgenden Attribute fest:
    • Empfänger: Geben Sie Ihre E-Mail-Adresse ein. Mit dieser E-Mail bestätigen Sie den erfolgreichen Abschluss der Integration.
    • Betreff: Geben Sie Email from Apigee Integrations ein.
    • E-Mail-Text: Wählen Sie die zuvor erstellte Variable JSONProdNameList in der Aufgabe Datenabgleich aus.
    • Die restlichen Optionen können in der Standardkonfiguration beibehalten werden.

    Änderungen an den Attributen werden automatisch gespeichert.

    Die fertige Konfiguration sollte der folgenden Abbildung entsprechen:

    Konfiguration der E-Mail-Aufgabe

  4. Fügen Sie eine Edge-Verbindung vom Element Datenabgleich zum Element E-Mail senden hinzu. Bewegen Sie dazu den Mauszeiger auf einen Steuerungspunkt des Elements Datenabgleich. Klicken Sie dann auf eine Linie und ziehen Sie sie an einen Steuerungspunkt im Aufgabenelement E-Mail senden. Die Steuerungspunkte und die Edge-Linie werden gelb. Der Edge kennzeichnet den Datenfluss von der Aufgabe Datenabgleich zur Aufgabe E-Mail senden.

Integration testen

So testen Sie die neue Integration:

  1. Klicken Sie in der Symbolleiste des Integrationsdesigners auf Veröffentlichen. Wenn Sie die Integration veröffentlichen, wird die Schaltfläche Test in der Symbolleiste aktiviert.
  2. Klicken Sie auf Test und wählen Sie dann API Trigger aus.
  3. Klicken Sie im Dialogfeld Veröffentlichen und Testen bestätigen auf Veröffentlichen und Testen.

Weitere Informationen zu Tests finden Sie unter Integrationen testen.

Nach erfolgreichem Abschluss sendet die Integration eine E-Mail mit der Produktnamenliste an die E-Mail-Adresse, die in der Aufgabe E-Mail senden angegeben ist. Bestätigen Sie den Erhalt der E-Mail in Ihrem E-Mail-Client.

Die E-Mail, die durch die Integration gesendet wird, sollte einen Text wie den folgenden enthalten:

["Vintage Typewriter", "Vintage Camera Lens", "Home Barista
Kit", "Terrarium", "Film Camera", "Vintage Record Player", "Metal Camping
Mug", "City Bike", "Air Plant"]

Sie können den Inhalt der E-Mail nicht nur überprüfen, sondern auch in den Logs den Status und die Nutzlast einer bestimmten Integration einsehen. So können die Logs angezeigt werden:

  1. Klicken Sie in der Symbolleiste des Integrationsdesigners auf Logs.
  2. Auf der Seite Ausführungslogs können Sie Details zu jedem Versuch anzeigen, eine Integration auszuführen. Jeder Eintrag enthält Details für den Ausführungsversuch. Beispiele:
    • Name der Integration
    • Ausführungs-ID
    • Status
    • Beginn
    • Dauer
    • Integrationsversion
    • Trigger-ID
  3. Klicken Sie neben der ausgeführten Integration auf den Erweiterungspfeil (>), um eine erweiterte Liste von Aufgaben und Variablen in der Integration aufzurufen. Außerdem werden der Aufgabenstatus und die Nutzlasten von Variablen angezeigt.

Glückwunsch! Sie haben eine Integration mit Apigee Integration erfolgreich konfiguriert und bereitgestellt.

Nächste Schritte