In dieser Anleitung erfahren Sie, wie Sie mit dem Apigee-Proxyassistenten einen Proxy mit einem Integrationsziel erstellen. Der Proxy verwendet eine API-Trigger-Referenz aus einer vorhandenen Integration, um die Abfolge der Schritte in der Integration zu initiieren.
In den folgenden Schritten wird beschrieben, wie Sie den Integrations-Zielproxy so konfigurieren, dass auf Aufruf eines Proxys eine erfolgreiche Integration ausgeführt wird.
Vorbereitung
- Bestätigen Sie Ihre Apigee-Anmeldedaten und die Organisationsdetails. Diese Informationen sind erforderlich, um auf das Application Integration-Feature und den Proxy-Assistenten in der Apigee-UI zuzugreifen.
- Erstellen und veröffentlichen Sie eine Integration mit einem API-Trigger und mindestens einer Aufgabe.
- Wenn Sie noch keine Integration erstellt haben, die einen API-Trigger verwendet, führen Sie die Schritte unter API-Nutzlast abrufen und E-Mail senden aus.
- Notieren Sie sich den Namen der von Ihnen erstellten Integration oder die vorhandene Integration, die Sie verwenden möchten, da dieser in einem späteren Schritt benötigt wird.
- Erstellen Sie ein Google-Dienstkonto im dem Google Cloud-Projekt, in dem auch Ihre Apigee-Organisation erstellt wurde, und gehen Sie so vor:
- Weisen Sie dem Dienstkonto die Aufrufer von Apigee-Integrationen-Rolle
(roles/integrations.applicationIntegrationInvokerRole)
zu. Informationen zu den vordefinierten Apigee Integration-Rollen finden Sie unter Vordefinierte IAM-Rollen. - Erlauben Sie Ihrem Nutzerkonto (Hauptkonto), Dienstkonten mit der Berechtigung
iam.serviceAccounts.actAs
an Ressourcen anzuhängen. Informationen zu Dienstkontoberechtigungen finden Sie unter Rollen für die Dienstkontoauthentifizierung .
Sie müssen dieses Dienstkonto angeben, wenn Sie den API-Proxy bereitstellen.
- Weisen Sie dem Dienstkonto die Aufrufer von Apigee-Integrationen-Rolle
- Wenn Sie Application Integration ohne Einschränkungen verwenden möchten, können Sie für die Integrationen bezahlen. Application Integration ist als Add-on-Dienst für Ihr Abo verfügbar. Wenn Sie die Application Integration-Berechtigung bereits erworben haben und die Berechtigung für Ihr Google Cloud-Projekt oder Ihre Apigee-Organisation aktivieren möchten, wenden Sie sich an den Apigee-Support. Wenn Sie die Application Integration-Berechtigung erst erwerben möchten, wenden Sie sich an den Apigee-Vertrieb. Nachdem Application Integration für Sie aktiviert wurde, führen Sie die folgenden Aufgaben aus:
- Aktivieren Sie folgende APIs:
- Apigee API (apigee.googleapis.com)
- Application Integration 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.
- 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}}}'
- Prüfen Sie mit dem folgenden Befehl, ob die Add-ons erfolgreich aktiviert wurden:
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 } } }
- Weisen Sie Ihrem Apigee-Standarddienstkonto (
service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
) die folgenden IAM-Rollen zu:- Application Integration Invoker (
roles/integrations.applicationIntegrationInvokerRole
)
Informationen zum Zuweisen zusätzlicher Rollen oder Berechtigungen für ein Dienstkonto finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.
- Application Integration Invoker (
- Aktivieren Sie folgende APIs:
Zielproxy für Apigee Integration-Integration erstellen
So erstellen Sie einen Integrations-Zielproxy in der Apigee-Benutzeroberfläche:
- Wechseln Sie zur Apigee-Benutzeroberfläche und melden Sie sich an.
- Wählen Sie Ihre Organisation im Drop-down-Menü oben links in der Benutzeroberfläche aus.
- Klicken Sie in der Hauptansicht auf API-Proxys.
Alternativ können Sie im linken Navigationsmenü Develop > API-Proxies auswählen.
- Wählen Sie in der Drop-down-Liste Umgebung die Umgebung aus, in der Sie einen neuen API-Proxy erstellen möchten.
- Klicken Sie auf Neu erstellen.
- Wählen Sie in der Anzeige der Proxytypen Integrationsziel aus.
Der Assistent zum Erstellen von Proxys wird gestartet.
- Geben Sie auf der Konfigurationsseite Proxy-Details die folgenden Details an:
- Name: Geben Sie einen Namen für den Proxy ein.
Proxynamen können alphanumerische Zeichen, Bindestriche und Unterstriche enthalten.
- Basispfad: Wird automatisch basierend auf dem Proxynamen eingefüllt.
Der Basispfad ist Teil der URL, die zum Senden von Anfragen an Ihre API verwendet wird. Apigee verwendet die URL, um eingehende Anfragen zuzuordnen und an den richtigen API-Proxy weiterzuleiten.
- Beschreibung: (Optional) Geben Sie eine kurze Beschreibung des Proxys ein.
Beispiel:
Proxy test for Application Integration
. - Integrationsregion: Wählen Sie die Region der Integration aus der Drop-down-Liste aus.
- Integrationsziel: Wählen Sie den Namen des Integrationsziels aus der Drop-down-Liste aus. Beachten Sie, dass die Einträge in der Liste der Integrationsziele der ausgewählten Integrationsregion entsprechen.
- Trigger: Wählen Sie den mit der Integration verknüpften API-Trigger aus der Drop-down-Liste aus.
- Endpunkttyp: Wählen Sie Synchronisierung aus.
- Name: Geben Sie einen Namen für den Proxy ein.
- Klicken Sie auf Next (Weiter).
- Übernehmen Sie auf der Konfigurationsseite Allgemeine Richtlinien die Standardauswahl und klicken Sie auf Weiter.
- Klicken Sie auf der Seite Zusammenfassung auf Erstellen.
Ein Integrations-Zielproxy wurde erfolgreich erstellt.
Proxy bereitstellen
Führen Sie folgende Schritte aus, um den neu erstellten Proxy bereitzustellen:
- Wählen Sie in der Apigee-Benutzeroberfläche Entwickeln > API Proxys.
Die Benutzeroberfläche enthält eine Liste der API-Proxys und deren Bereitstellungsstatus:
- Wählen Sie in der Drop-down-Liste Umgebung die Umgebung aus, in der Sie den API-Proxy bereitstellen möchten.
Klicken Sie auf den kürzlich erstellten Proxy, den Sie bereitstellen möchten. In der UI wird standardmäßig die Seite Übersicht angezeigt.
- Klicken Sie zum Bereitstellen der Änderungen zuerst auf Bereitstellen, um das Dialogfeld Bereitstellen aufzurufen.
- Geben Sie Folgendes ein:
- Überarbeitung: Die Überarbeitungsnummer des Proxys, den Sie bereitstellen möchten.
- Umgebung: Die Umgebung, in der Sie den Proxy bereitstellen möchten.
- Dienstkonto: Das erstellte Dienstkonto für den Proxy.
- Klicken Sie auf Bereitstellen.
Die Benutzeroberfläche beginnt mit der Bereitstellung der ausgewählten Überarbeitung. Es kann bis zu einer Minute dauern, bis die Proxybereitstellung abgeschlossen ist.
Wenn der Proxy bereitgestellt wird, wird in der Spalte Status im Abschnitt Bereitstellungen ein grünes Symbol angezeigt, das zeigt, dass Überarbeitung 1 des Proxys bereitgestellt ist.
Integrations-Zielproxy testen
Führen Sie folgenden Befehl im Terminalfenster aus, um den Proxy aufzurufen und die Integration auszulösen:
curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME
Dabei ist YOUR_ENV_GROUP_HOSTNAME
der Hostname für eine Umgebungsgruppe, die die Umgebung enthält, in der Ihr Proxy bereitgestellt wird.
Beispiel:
curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy
Sie können prüfen, ob die Integration ausgelöst wurde, indem Sie den Proxy aufrufen:
- Öffnen Sie die Apigee-Benutzeroberfläche.
- Klicken Sie auf Entwickeln > Integrationen.
- Suchen Sie nach dem in den obigen Schritten erstellten Integrationstyp oder wählen Sie ihn aus und klicken Sie auf den Namen der Integration.
- Klicken Sie auf Logs.
- Prüfen Sie, ob für die ausgelöste Integration ein Ausführungslog vorhanden ist. Zum Aufrufen der Logdetails klicken Sie auf die Zeile, um die Ausführungsdetails zu maximieren.
Nutzlast der Proxyanfrage aktualisieren (optional)
Führen Sie die folgenden Schritte aus, um die Nutzlast der Proxy-Anfrage zu aktualisieren:
- Wählen Sie in der Apigee-Benutzeroberfläche Entwickeln > API-Proxys im linken Navigationsmenü aus.
- Klicken Sie auf den kürzlich erstellten Proxy.
Standardmäßig zeigt die Benutzeroberfläche im Proxy-Editor den Tab Übersicht für diesen Proxy an.
- Klicken Sie auf den Tab Entwickeln.
- Wählen Sie im Bereich Navigator unter der Überschrift Richtlinien Integrationsanfrage festlegen aus.
- Entfernen Sie die Kommentare für den Block
<Parameters>
und geben Sie die Parameterdetails ein.Um einzelne Parameter anzugeben, verwenden Sie das Element
<Parameter>
. Verwenden Sie das Element<ParameterArray>
, um Parameter-Arrays anzugeben. - Klicken Sie auf Speichern.
Nächste Schritte
Sehen Sie sich das Designerlayout für die Integration an und machen Sie sich mit den verschiedenen Integrationskonzepten vertraut, die unter Alle Konzepte beschrieben werden.