API-Trigger

API-Trigger werden verwendet, um Ausführungen für Integrationen direkt aufzurufen.

Wenn Sie einen API-Trigger in Ihrer Integration konfigurieren, können Sie Folgendes tun:

• Legen Sie die Anfrage- und Antwortnutzlast mithilfe von triggerspezifischen Eingabe- und Ausgabevariablen fest.
• OpenAPI-Spezifikation (OAS) für Ihre Integration generieren und ansehen
• Eine Integration synchron oder asynchron aufrufen.

Informationen zu den ersten Schritten mit API-Triggern finden Sie im Tutorial API-Auftragsausführung. In der Anleitung wird gezeigt, wie Sie eine Integration mit einem API-Trigger erstellen, der API-Anfragen zum Abrufen von Kundendaten empfängt.

API-Trigger hinzufügen

Führen Sie die folgenden Schritte aus, um Ihrer Integration einen API-Trigger hinzuzufügen:

1. Rufen Sie in der Google Cloud Console die Seite Application Integration auf.

   Zu Application Integration

2. Klicken Sie im Navigationsmenü auf Integrationen.

   Die Seite Integrationsliste wird angezeigt. Dort sind alle im Google Cloud-Projekt verfügbaren Integrationen aufgeführt.

3. Wählen Sie eine vorhandene Integration aus oder klicken Sie auf Integration erstellen, um eine neue zu erstellen.

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

   1. Geben Sie im Bereich Integration erstellen einen Namen und eine Beschreibung ein.
   2. Wählen Sie eine Region für die Integration aus.
      Hinweis: Im Drop-down-Menü Regionen werden nur die in Ihrem Google Cloud-Projekt bereitgestellten Regionen aufgeführt. Klicken Sie zum Bereitstellen einer neuen Region auf Region aktivieren. Weitere Informationen finden Sie unter Neue Region aktivieren.
   3. Wählen Sie ein Dienstkonto für die Integration aus. Sie können die Dienstkontodetails einer Integration jederzeit im Bereich Integrationsübersicht in der Integrationssymbolleiste ändern oder aktualisieren.
      Hinweis: Die Option zum Auswählen eines Dienstkontos wird nur angezeigt, wenn Sie die Integrations-Governance für die ausgewählte Region aktiviert haben.
   4. Klicken Sie auf Erstellen.

   Die neu erstellte Integration wird im Integrationseditor geöffnet.

4. Klicken Sie in der Navigationsleiste des Integrationseditors auf Trigger, um die Liste der verfügbaren Trigger aufzurufen.
5. Klicken Sie auf das Element API-Trigger und platzieren Sie es im Designer.

API-Trigger konfigurieren

Klicken Sie im Integrationseditor auf das Element API-Trigger, um einen API-Trigger zu konfigurieren. Der Konfigurationsbereich für den API-Trigger wird mit den folgenden Feldern angezeigt:

• Label: Der sichtbare Name des API-Triggers in Ihrer Integration. Sie können das Label in einen Namen Ihrer Wahl ändern.
• Notizen: Sie können dem API-Trigger Notizen hinzufügen, um zusätzliche Informationen zum Trigger bereitzustellen.
• Trigger-ID: Eine eindeutige ID, die dem API-Trigger im Format api_trigger/TRIGGER_NAME zugewiesen wird.
  Hinweis: Sie können mehr als einen API-Trigger in Ihrer Integration haben. Jedem API-Trigger ist eine eindeutige Trigger-ID zugewiesen.
• Eingabevariablen: Triggerspezifische Eingabevariablen, mit denen Sie die Anfragenutzlast für den API-Trigger festlegen können.
  • Wenn Sie dem API-Trigger vorhandene Integrationsvariablen hinzufügen oder daraus entfernen möchten, klicken Sie auf Ändern und wählen Sie die erforderlichen Variablen im Bereich Eingabevariablen für API-Trigger aus.
  • Wenn Sie eine neue Variable speziell für den ausgewählten API-Trigger hinzufügen möchten, klicken Sie auf Ändern und wählen Sie im Bereich API-Trigger-Eingabevariablen die Option + Neue Variable hinzufügen aus. Informationen zu den unterstützten Datentypen finden Sie unter Unterstützte Variablendatentypen.
• Ausgabevariablen: Triggerspezifische Ausgabevariablen, mit denen Sie die Antwortnutzlast für den API-Trigger festlegen können.
  • Wenn Sie dem API-Trigger vorhandene Integrationsvariablen hinzufügen oder daraus entfernen möchten, klicken Sie auf Ändern und wählen Sie im Bereich Ausgabevariablen des API-Triggers die gewünschten Variablen aus.
  • Wenn Sie eine neue Variable speziell für den ausgewählten API-Trigger hinzufügen möchten, klicken Sie auf Ändern und wählen Sie im Bereich Ausgabevariablen des API-Triggers die Option + Neue Variable hinzufügen aus. Informationen zu den unterstützten Datentypen finden Sie unter Unterstützte Variablendatentypen.
Hinweis: Sie können Eingabe- und Ausgabevariablen sowohl im Bereich „Variablen“ als auch im Konfigurationsbereich für den API-Trigger erstellen.
• Application Integration fügt Variablen, die im Konfigurationsbereich des API-Triggers erstellt wurden, automatisch als Eingabe- oder Ausgabevariablen zu diesem Trigger hinzu.
• Sie können Variablen von einem API-Trigger manuell als Eingabe- oder Ausgabevariablen zu einem anderen hinzufügen.
• Standardmäßig können alle Elemente in Ihrer Integration auf Variablen zugreifen, die im Bereich „Variablen“ erstellt wurden.
• Wenn Sie den Variablentyp einer Variablen ändern, wirkt sich das auf alle Elemente in Ihrer Integration aus, die diese Variable verwenden.

OpenAPI-Spezifikation für Ihren API-Trigger ansehen

Application Integration bietet die Möglichkeit, die OpenAPI-Spezifikationen Ihrer veröffentlichten Integrationen, die mit einem oder mehreren API-Triggern konfiguriert sind, dynamisch zu generieren und anzusehen. Informationen zum Aufrufen der OpenAPI-Spezifikation finden Sie unter OpenAPI-Spezifikation für Ihre Integration aufrufen.

Hinweis: Auf dieser Seite geht es um das Aufrufen des API-Triggers mit der v1 API. Die für Ihre Integration generierte OpenAPI-Spezifikation enthält möglicherweise Definitionen für andere API-Versionen, z. B. v2.

API-Trigger mit einem API-Aufruf aufrufen

Nachdem Sie eine Integration mit einem konfigurierten API-Trigger veröffentlicht haben, können Sie die Methode projects.locations.integrations.execute verwenden, um diesen Trigger von einer beliebigen Anwendung aus aufzurufen. Diese Methode löst die Ausführung im synchronen Modus aus.

Syntax

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"triggerId":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Ersetzen Sie Folgendes:

• TIMEOUT_SECONDS: Das Zeitlimit in Sekunden für den API-Aufruf. Standardmäßig beträgt das Zeitlimit 120 Sekunden. Eine Liste der vordefinierten Anfrageparameter finden Sie unter Systemparameter.
• TRIGGER_NAME: Der Name des API-Triggers in Ihrer Integration.
• PROJECT_ID: Die ID Ihres Google Cloud -Projekts.
• LOCATION: Die Region der Integration, z. B. us-east1.

Beispiel

Im folgenden Beispiel wird eine Integration in der Region us-east1 aufgerufen, die den API-Trigger test_API_1 im Google Cloud-Projekt demo-project enthält:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300" \
    -d '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/integrations/-:execute"

Hinweise

Bei Verwendung des API-Triggers darf die kumulative Größe aller Eingabevariablen maximal 8 MB betragen. Wenn die Größe 8 MB überschreitet, führt Application Integration die Integration nicht aus und Sie erhalten einen Fehler.

Kontingente und Limits

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

Nächste Schritte

• Alle Aufgaben und Trigger.
• Hier erfahren Sie, wie Sie eine Integration testen und veröffentlichen.
• Weitere Informationen zur Fehlerbehandlung.
• Weitere Informationen zu Ausführungslogs der Integration.