Apigee-Integration mit einem API-Trigger

In dieser Kurzanleitung erfahren Sie, wie Sie eine Beispielintegration in Apigee Integration 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 die Anzahl der Seitenaufrufe aus einer öffentlichen API ab, transformieren die Daten in ein geeignetes Format und senden die resultierende Liste in einer E-Mail – alles über den Integrationsdesigner.

Neue Integration erstellen

So erstellen Sie eine neue Integration:

  1. Wählen Sie in der Apigee-Benutzeroberfläche Ihre Apigee-Organisation aus.
  2. Klicken Sie auf Entwickeln > Integrationen.
  3. Klicken Sie auf Integration erstellen.
  4. Geben Sie im Dialogfeld Integration erstellen einen Namen und eine Beschreibung ein.

    Geben Sie für diese Kurzanleitung den Namen my-test-integration und die Beschreibung Integration for quickstart ein.

  5. Wählen Sie eine Region für die Integration aus.
  6. Klicken Sie auf Erstellen, um den Integrationseditor zu öffnen.

API-Trigger hinzufügen und 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. Verwenden Sie für diese Kurzanleitung den API-Trigger.

So konfigurieren Sie den API-Trigger:

  1. Klicken Sie im Integrationseditor auf Trigger, um eine Liste der verfügbaren Trigger aufzurufen.
  2. Klicken Sie auf das Element API-Trigger und platzieren Sie es im Integrationseditor.
  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 Aufgaben aus, um eine Liste der verfügbaren Aufgaben anzuzeigen.
  2. Klicken Sie auf das Element REST-Endpunkt aufrufen und platzieren Sie es im Integrationseditor.
  3. Fügen Sie eine Edge-Verbindung aus dem Element API-Trigger dem Element REST-Endpunkt aufrufen hinzu. Dazu bewegen Sie den Mauszeiger auf einen Steuerungspunkt des Elements API-Trigger. Klicken Sie dann auf eine Zeile und ziehen Sie sie an einen Steuerungspunkt im Aufgabenelement REST-Endpunkt aufrufen. Der Edge kennzeichnet den Steuerungsfluss vom API-Trigger zur Aufgabe REST-Endpunkt aufrufen.

    Ein Edge ist eine Verbindung zwischen zwei Elementen in einer Integration. Die Verbindung gibt die Richtung des Steuerungsablaufs von einem Element(Aufgabe oder Trigger) zu einem anderen an. Weitere Informationen zu Kanten finden Sie unter Edges.

  4. 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://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031 ein. Diese öffentliche API von wikimedia.org gibt die Anzahl der Seitenaufrufe eines Artikels namens Tree für einen bestimmten Monat zurück.
      • HTTP-Methode: Wählen Sie GET über die Drop-down-Liste aus.
    • 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 Antworttextdaten, 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 Antwortstatusdaten, 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
      • Aufgabe sollte bei HTTP-Fehler fehlschlagen: False
      • Fehlerbehebungsstrategie
        • Strategie für synchrone Ausführungen: None
        • Strategie für asynchrone Ausführungen: None

    Änderungen an den Attributen werden automatisch gespeichert.

Aufgabe „Datenabgleich“ hinzufügen und konfigurieren

So konfigurieren Sie die Aufgabe Datenabgleich:

  1. Wählen Sie Aufgaben aus, um eine Liste der verfügbaren Aufgaben anzuzeigen.
  2. Klicken Sie auf das Element Datenabgleich und platzieren Sie es im Integrationsdesigner.
  3. 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.
  4. Klicken Sie im Designer auf die Aufgabe Datenabgleich, um den Konfigurationsbereich der Aufgabe zu öffnen.
  5. 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.

    Erstellen Sie für diese Kurzanleitung eine Zuordnung mit responseBody(REST-Endpunkt aufrufen) als Eingabe:

    1. Ziehen Sie die Variable responseBody aus dem Bereich Variablen in die erste Eingabezeile.
    2. Klicken Sie im Variablenchip responseBody auf + (Funktion hinzufügen), um die Drop-down-Liste der verfügbaren Funktionen aufzurufen.
    3. Sie können eine Reihe von Funktionen 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.

      • Wählen Sie TO_JSON() aus, um den String responseBody in JSON zu konvertieren.
      • Klicken Sie im Variablenchip responseBody auf + (Funktion hinzufügen), um die Funktion GET_PROPERTY() auszuwählen und zu verketten.
      • Um den Eingabeparameter für GET_PROPERTY() hinzuzufügen, klicken Sie auf Variable oder Wert und geben Sie in Wert items ein.

        Diese Funktion extrahiert ein Attribut aus der JSON-Nutzlast. Übergeben Sie das Attribut items 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(items)

      • Wenn Sie eine Funktion entfernen oder löschen möchten, klicken Sie auf das Symbol -.
    4. Klicken Sie auf das erste Feld in der Spalte Ausgabe, um eine neue Ausgabevariable zu erstellen, die den Wert der transformierten Daten enthält. Füllen Sie die folgenden Felder aus:
      • Name: Geben Sie JSONList 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 JSONList wird links im Datenabgleichs-Editor in der Liste Variablen angezeigt.
    5. Schließen Sie den Datenableichs-Editor, sobald die Zuordnung abgeschlossen ist. Alle Änderungen werden automatisch gespeichert.

Aufgabe „E-Mail senden” hinzufügen und konfigurieren

So konfigurieren Sie die Aufgabe E-Mail senden:

  1. Wählen Sie im Integrationseditor Aufgaben aus, um die Liste der verfügbaren Aufgaben aufzurufen.
  2. Klicken Sie auf das Element E-Mail senden und platzieren Sie es im Integrationseditor.
  3. 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. Der Edge kennzeichnet den Kontrollfluss von der Aufgabe Datenabgleich zur Aufgabe E-Mail senden.
  4. Klicken Sie im Designer auf das Element E-Mail senden, um den Konfigurationsbereich der Aufgabe zu öffnen. Legen Sie die folgenden Attribute fest:
    • An 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 Integration ein.
    • Text in Nur-Text: Wählen Sie die Variable JSONList aus, die zuvor in der Aufgabe Datenabgleich erstellt wurde.
    • Die restlichen Optionen können in der Standardkonfiguration beibehalten werden.

    Änderungen an den Attributen werden automatisch gespeichert.

Erforderliche Edge-Verbindungen prüfen

Prüfen Sie, ob Sie Edge-Verbindungen zwischen Elementen in Ihrer Einbindung hinzugefügt haben. Die Verbindung gibt die Richtung des Steuerungsablaufs von einem Element(Aufgabe oder Trigger) zu einem anderen an. Weitere Informationen zu Kanten finden Sie unter Edges.

Die fertige Verbindung sollte der folgenden Abbildung entsprechen:

Abbildung mit Kurzanleitung Abbildung mit Kurzanleitung

Integration testen

So testen Sie die neue Integration:

  1. Klicken Sie in der Symbolleiste des Integrationseditors auf Testen.

    Der Bereich Integration testen wird angezeigt.

  2. Klicken Sie auf Integration testen.

Weitere Informationen zu Tests finden Sie unter Integrationen testen und veröffentlichen.

Nach erfolgreichem Abschluss sendet die Integration eine E-Mail mit den JSON-Werten 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: 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

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 Integrationseditors 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.