Aufgabe "REST-Endpunkt aufrufen"

Mit der Aufgabe REST-Endpunkt aufrufen können Sie jede REST API eines Drittanbieters aus Ihrer Integration aufrufen. Die Antwort des REST API-Aufrufs ist in einer Integrationsvariablen verfügbar und kann in anderen nachgelagerten Aufgaben verwendet werden.

Hinweise

  • Wenn Sie eine Verbindung zu einem Authentifizierungsendpunkt für den REST API-Aufruf herstellen möchten, müssen Sie entweder ein OAuth 2.0-Profil erstellt oder ein nutzerverwaltetes Dienstkonto an Ihre Integration angehängt haben. Wenn die API keine Authentifizierung erfordert, kann der Authentifizierungsprofilbereich im Konfigurationsbereich der Aufgabe leer bleiben. Eine Liste der Konfigurationen finden Sie unter Konfigurationsattribute.

    Wenn für Ihre Integration sowohl ein OAuth 2.0-Profil als auch ein vom Nutzer verwaltetes Dienstkonto konfiguriert sind, wird standardmäßig das OAuth 2.0-Profil für die Authentifizierung verwendet. Wenn weder ein OAuth 2.0-Profil noch ein vom Nutzer verwaltetes Dienstkonto konfiguriert ist, schlägt die Ausführung fehl.

  • Wenn Ihre Integration ein Dienstkonto hat, weisen Sie diesem Dienstkonto anhand der REST-Endpunkt-URL die erforderliche IAM-Rolle zu. Wenn beispielsweise Ihre REST-Endpunkt-URL einen Cloud Storage-Dienst aufruft, weisen Sie die erforderliche IAM-Rolle für den Cloud Storage-Dienst zu.

    Informationen zum Zuweisen von Rollen zu einem Dienstkonto finden Sie unter Zugriff auf Dienstkonten verwalten.

  • Achten Sie darauf, dass VPC Service Controls NICHT für die Apigee Integration in Ihrem Google Cloud-Projekt eingerichtet ist.

Aufgabe "REST-Endpunkt aufrufen" konfigurieren

So konfigurieren Sie die Aufgabe REST-Endpunkt aufrufen:

  1. Wählen Sie in der Apigee-Benutzeroberfläche Ihre Apigee-Organisation aus.
  2. Klicken Sie auf Entwickeln > Integrationen.
  3. Wählen Sie eine vorhandene Integration aus oder erstellen Sie eine neue Integration, indem Sie auf Integration erstellen klicken.

    Wenn Sie eine neue Integration erstellen, gehen Sie so vor:

    1. Geben Sie im Dialogfeld Integration erstellen einen Namen und eine Beschreibung ein.
    2. Wählen Sie eine Region für die Integration aus der Liste der unterstützten Regionen aus.
    3. Klicken Sie auf Erstellen.

    Dadurch wird die Integration auf der Seite Integrationsdesigner geöffnet.

  4. Klicken Sie in der Navigationsleiste Integrationsdesigner auf + Aufgabe/Trigger hinzufügen > Aufgaben, um die Liste der verfügbaren Aufgaben aufzurufen.
  5. Klicken Sie auf das Element REST-Endpunkt aufrufen und platzieren Sie es im Integrationseditor.
  6. Klicken Sie im Designer auf das Element Call REST Endpoint, um den Aufgabenkonfigurationsbereich Call REST Endpoint aufzurufen.
  7. Konfigurieren Sie die angezeigten Felder mithilfe den Konfigurationsattributen der Aufgabe, wie in der folgenden Tabelle beschrieben.

    Änderungen an den Attributen werden automatisch gespeichert.

Konfigurationsattribute

In der folgenden Tabelle werden die Konfigurationsattribute der Aufgabe REST-Endpunkt aufrufen beschrieben.

Attribut Datentyp Beschreibung
Label String Optional: Fügen Sie Ihrer Aufgabe ein Label hinzu.
Authentifizierung String Optional: Konfiguriert und speichert die Authentifizierungsdetails für Verbindungen zu externen Systemen. Weitere Informationen finden Sie unter Authentifizierungsprofile in Apigee Integration erstellen.
Endpunkt-Basis-URL String REST-Endpunkt-URL ohne den Abfrageparameter.
HTTP-Methode HTTP-Methode, die verwendet werden soll.

Sie können eine der folgenden HTTP-Methoden auswählen:

  • DELETE
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
URL-Abfragestringparameter Abfragestring-Schlüssel: String

Wert: String

Für den REST API-Aufruf erforderliche Abfrageparameter.

Die Abfrageparameter haben die Form von Schlüssel/Wert-Paaren, wobei der Schlüssel der Schlüsselname und der Wert der entsprechende Schlüsselwert ist. Sie können mehrere Schlüssel/Wert-Paare eingeben, indem Sie auf das Pluszeichen klicken.

HTTP-Header HTTP-Header-Schlüssel: String

Wert: String

Für den REST API-Aufruf erforderliche HTTP-Header.

Die HTTP-Header haben die Form von Schlüssel/Wert-Paaren, wobei Schlüssel der Schlüsselname und der Wert der entsprechende Schlüsselwert ist. Sie können mehrere Schlüssel/Wert-Paare eingeben, indem Sie auf das Pluszeichen klicken.

Weiterleitungen folgen Boolesch URL-Weiterleitungen folgen.

Sie können einen der folgenden Werte auswählen:

  • True: Ruft die weitergeleitete URL auf, wenn die Basis-URL des Endpunkts an eine andere URL weitergeleitet wird.
  • False: Ruft die weitergeleitete URL nicht auf, wenn die Basis-URL des Endpunkts an eine andere URL weitergeleitet wird.
Aufgabe sollte bei HTTP-Fehler fehlschlagen Boolesch Strategie der Ausnahmebehandlung, wenn der REST API-Aufruf fehlschlägt. Der REST-Endpunkt aufrufen schlägt fehl, wenn der HTTP-Antwortcode 4xx oder 5xx ist. Eine Liste der Fehlercodes finden Sie unter Fehlercodes. Geben Sie für andere HTTP-Antwortcodes den Fehlercode und die Fehlermeldung in der Antwort zurück.

Sie können einen der folgenden Werte auswählen:

  • True: Löst eine Ausnahme aus.
  • False: Löst keine Ausnahme aus. Gibt jedoch den Fehlercode und die Fehlermeldung in der Antwort zurück.
Antwort-Header (<Aufgabenname>) String Nicht komprimierter Antwortheader aus der Antwort der REST APIs.
Antworttext (<Aufgabenname>) String Nicht komprimierter Antworttext aus der Antwort der REST APIs.
Antwortstatus (<Aufgabenname>) String HTTP-Antwortcode und der entsprechende Codetext aus der Antwort der REST APIs.

Best Practices

Informationen zu den Nutzungslimits für die Aufgabe REST-Endpunkt aufrufen finden Sie unter Nutzungslimits.

Fehlerbehebungsstrategie

Eine Strategie zur Fehlerbehandlung für eine Aufgabe legt die Aktion fest, die ausgeführt werden soll, wenn die Aufgabe aufgrund eines temporären Fehlers fehlschlägt. Informationen zur Verwendung einer Fehlerbehandlungsstrategie und zu den verschiedenen Arten von Fehlerbehandlungsstrategien finden Sie unter Strategien zur Fehlerbehebung.

Informationen zum Umgang mit Wiederholungsstrategien für Fehler des Typs 4xx oder 5xx finden Sie im Blog So wiederholen Sie die Aufgabe des REST-Aufrufers basierend auf dem Antwortstatus.