Kommunikation zwischen einem Drupal-basierten Portal und Edge

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

Das Developer Services-Portal fungiert als Client für Apigee Edge. Das Portal funktioniert also nicht als eigenständiges System. Stattdessen werden viele der vom Portal verwendeten Informationen in Edge gespeichert. Bei Bedarf stellt das Portal eine HTTP- oder HTTPS-Anfrage, um Informationen von Edge abzurufen oder an Edge zu senden.

Edge sendet keine Anfragen an das Portal, sondern antwortet nur auf Anfragen, die vom Portal gestellt wurden. Daher werden alle Interaktionen zwischen dem Portal und Edge vom Portal initiiert.

Verbindung zwischen dem Portal und Edge konfigurieren

Das Portal muss drei Informationen an Edge senden, wie unten angegeben.

  • URL des Edge- Endpunkts

    Der Standardendpunkt für die cloudbasierte Version von Edge ist https://api.enterprise.apigee.com/v1.

    Bei einer Private-Cloud-Installation hat die URL das folgende Format: http://EdgePrivateCloudIp:8080/v1 oder https://EdgePrivateCloudIp:TLSport/v1.

    Dabei ist EdgePrivateCloudIp die IP-Adresse des Edge Management-Servers und TLSport der TLS/SSL-Port für die Edge Management API. Beispiel: 8443.
  • Name der Apigee-Organisation

    Das ist der Name Ihrer Organisation in Edge. Sie richten die Organisation ein, wenn Sie Ihr Konto in Edge erstellen.
  • Nutzername und Passwort eines Entwickleradministrators

    Die Aufrufe vom Portal zu Edge werden authentifiziert und erfordern einen Nutzer mit Administratorberechtigungen für Entwickler. Wenn für Sie ein Entwicklerportal bereitgestellt wird, wird Ihrer Organisation die Rolle „Entwickleradministrator“ hinzugefügt. Diese Rolle, die einen einzelnen Nutzer namens devadmin+{org_name}@apigee.com umfasst, dient ausschließlich dazu, Ihr Entwicklerportal mit Ihrer Edge-Organisation zu verknüpfen. Da im Portal Ihre Edge-Entwickler-Apps, API-Produkte usw. angezeigt werden, muss es mit Ihrer Edge-Organisation synchronisiert bleiben. Dazu sind Management-API-Aufrufe erforderlich, die eine Authentifizierung erfordern. Der devadmin-Nutzer „user“ hat die erforderlichen Berechtigungen.

So rufen Sie die Verbindungsinformationen auf:

  1. Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal > Anwendungseinstellungen aus.

So ändern Sie die Konfiguration:

Wie Sie die Konfiguration ändern, hängt von Ihrer Portalinstallation und -version ab:

  • Cloudbasierte Installation der Portalversion 15.01.06 und höher: Sie müssen sich an den Apigee Edge-Support wenden, um die Verbindungsinformationen zu ändern. Beispielsweise, wenn Sie den Namen der Organisation ändern möchten.
  • On-Premises-Installation und cloudbasiertes Portal vor Version 15.01.06: Ändern Sie die Verbindungsinformationen wie unten beschrieben:
  1. Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal-Einstellungen aus.
  2. Geben Sie den Namen Ihrer Organisation unter Management API-Organisation ein.
  3. Geben Sie die URL des Edge-Endpunkts in Management API Endpoint URL ein.
  4. Geben Sie die Anmeldedaten des Administrators der Organisation unter Endpunkt authentifizierter Nutzer und Passwort des authentifizierten Nutzers ein.
  5. Wählen Sie Verbindung testen aus, um zu prüfen, ob die Verbindung hergestellt wurde.
  6. Wählen Sie Konfiguration speichern aus.

Zugriff auf Edge über das Portal ermöglichen

Da viele der vom Portal verwendeten Informationen in Edge gespeichert sind, muss das Portal auf Edge zugreifen können. Das Portal initiiert die Kommunikation mit Edge, indem es REST-Anfragen über HTTP und HTTPS sendet. Wenn ein Entwickler beispielsweise eine neue App im Portal registriert, sendet das Portal eine Anfrage an Edge, um Informationen über die App an Edge zu senden.

Sowohl Edge als auch das Portal können in der Cloud oder lokal bereitgestellt werden. Sie können auch verschiedene Bereitstellungstypen kombinieren. Sie können sie beispielsweise beide in der Cloud, beide lokal oder eine in der Cloud und eine lokal bereitstellen:

  • Wenn sowohl das Portal als auch Edge von Apigee in der Cloud bereitgestellt werden, sollten keine Probleme beim Senden von Anfragen vom Portal an Edge auftreten.
  • Wenn Sie das Portal lokal bereitstellen, müssen Sie dafür sorgen, dass das Portal Anfragen an Edge senden kann, unabhängig davon, ob Edge in der Cloud oder lokal bereitgestellt wird.
  • Wenn Sie Edge lokal bereitstellen, muss das Portal Zugriff auf Edge haben. Das bedeutet, dass Ihr Edge-Server Anfragen vom Portal akzeptieren muss, unabhängig davon, ob das Portal in der Cloud oder lokal bereitgestellt wird.

Video: In einem kurzen Video erfahren Sie, wie das Entwicklerportal mit Apigee Edge kommuniziert und ob die Verbindung funktioniert.

Apps und API-Schlüssel über das Portal verwalten

Wenn der Entwickler die App-Registrierung auf dem Portal abschließt, sendet das Portal Informationen zur App an Edge, einschließlich des App-Namens und der der Anwendung zugeordneten API-Produkte.

Wenn Edge die App erfolgreich registriert, gibt Edge einen einzelnen API-Schlüssel an das Portal zurück. Der Entwickler verwendet dann diesen API-Schlüssel, um auf die API-Produkte zuzugreifen, die mit der Anwendung verknüpft sind.

Im Portal werden keine Informationen zu Apps und API-Schlüsseln gespeichert. Stattdessen werden alle diese Informationen in Edge gespeichert. Wenn ein Entwickler also Informationen zu einer App im Portal aufruft, sendet das Portal eine Anfrage an Edge, um auf diese Informationen zuzugreifen. Jedes Mal, wenn der Entwickler eine App ändert, sendet das Portal diese Änderungen automatisch an Edge.

Ein Entwickler meldet sich beispielsweise im Portal an und ruft die Seite „Meine Apps“ auf. Um die Seite „Meine Apps“ zu füllen, sendet das Portal eine Anfrage an Edge, um Informationen zu den Apps und API-Schlüsseln des Entwicklers abzurufen. Diese Informationen werden dann auf der Seite „Meine Apps“ des Entwicklers im Portal angezeigt:

Wenn der Entwickler dann eine App hinzufügt, entfernt oder ändert, sendet das Portal diese Änderungen an Edge.

Da alle Informationen zu Anwendungen und API-Schlüsseln in Edge gespeichert sind, kann ein Edge-Administrator diese Informationen über die Edge-Benutzeroberfläche ändern. Ein Administrator kann z. B. Folgendes tun:

  • Entwickleranwendung hinzufügen, entfernen oder ändern
  • API-Schlüssel für eine App widerrufen oder genehmigen

Unten sehen Sie dieselbe App, die „Meine Wetter-App“, wie sie einem Administrator in der Edge-Benutzeroberfläche angezeigt wird:

Entwickler über das Portal verwalten

Wenn sich ein Entwickler als neuer Portalnutzer registriert, wird er in Edge und im Portal erstellt. Im Gegensatz zu Apps und API-Schlüsseln werden Informationen zu Entwicklern also sowohl in Edge als auch im Portal gespeichert.

Zu den in Edge gespeicherten Entwicklerinformationen gehören:

  • Vorname
  • Nachname
  • E-Mail-Adresse
  • Optionale zusätzliche Informationen, die über das Portal gesendet werden

Im Portal werden dieselben Informationen wie in Edge gespeichert, aber auch zusätzliche Informationen, darunter:

  • Portalpasswort
  • Status des Portalkontos: aktiv oder blockiert
  • Portalrolle: authentifizierter Nutzer, Administrator, andere
  • Rollenbasierte Berechtigungen: Legen fest, welche Aktionen der Entwickler im Portal ausführen darf.

Wenn sich ein Entwickler im Portal anmeldet, ist das Portal für die Authentifizierung des Entwicklers und die Durchsetzung rollenbasierter Berechtigungen verantwortlich.

Da im Portal alle Informationen zu einem Entwickler gespeichert werden, gilt das Portal als das System of Record für Entwicklerinformationen, nicht Edge. Wenn der Entwickler seine Informationen im Portal ändert, werden diese Informationen im Portal gespeichert und gegebenenfalls an Edge gesendet. Wenn der Entwickler beispielsweise seinen Vornamen ändert, werden diese Informationen an Edge gesendet. Wenn der Entwickler sein Passwort jedoch ändert, werden diese Informationen nur lokal im Portal gespeichert.

Weitere Informationen finden Sie unter Nutzerkonten hinzufügen und verwalten.

App-Entwickler zwischen Portal und Edge synchronisieren

Edge initiiert keine Kommunikation mit dem Portal. Wenn Sie als Edge-Administrator Informationen zu einem Entwickler in der Edge-Benutzeroberfläche ändern, gibt es keine Garantie dafür, wann diese Informationen an das Portal gesendet werden. Verwenden Sie daher die Verwaltungsfunktionen des Portals, um Entwickler zu erstellen, zu ändern und zu löschen, und nicht Edge.

Ein Portaladministrator kann eine Synchronisierung zwischen dem Portal und Edge erzwingen, um Informationen aus Edge in das Portal herunterzuladen. Wenn Sie Entwickler jedoch nur im Portal und nicht in Edge ändern, sollten Sie diese Synchronisierung nie ausführen müssen. Da Sie in Edge beim Erstellen eines Entwicklers kein Passwort festlegen können, wird für alle in Edge erstellten Entwickler ein zufälliger Wert als Portalpasswort festgelegt. Daher muss der Entwickler den Prozess zur Passwortwiederherstellung durchlaufen, bevor er sich im Portal anmelden kann.

Portal mit App-Entwicklern in Edge synchronisieren

:
  • Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
  • Wählen Sie im Drupal-Verwaltungsmenü Personen aus.
  • Wählen Sie oben auf der Seite die Schaltfläche Dev Portal Developer Sync (Entwicklersynchronisierung im Entwicklerportal) aus, um die Synchronisierung mit den App-Entwicklern in Edge vorzunehmen.