Integriertes Portal erstellen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Apigee Edge bietet ein nutzerfreundliches, integriertes Portal, über das Sie den Zugriff auf Ihre APIs dokumentieren und verwalten und Ihre App-Entwickler-Community stärken können.

Alle Nutzer von Apigee Edge haben Zugriff auf die integrierten Portalentwicklungstools, mit denen sie schnell ihr eigenes Entwicklerportal erstellen können und damit eine Alternative zur Drupal-basierten Portalentwicklung darstellen. Einen Vergleich der Funktionen finden Sie unter Vergleich von Funktionen für Entwicklerportale.

Wichtige Funktionen und Vorteile

Das integrierte Portal bietet Ihnen die folgenden wichtigen Funktionen und Vorteile:

Funktion	Vorteile
Entwicklung von Portalinhalten	Erstellen Sie Ihre Portalinhalte schnell und einfach. Seiten mit dem nutzerfreundlichen Seiteneditor erstellen Inhalte mit Markdown und HTML verfassen Menüs zur Navigation im Portal hinzufügen
Erscheinungsbild des Portals	Mit den SCSS-Stylesheets und dem personalisierten Branding lässt sich das Erscheinungsbild Ihres Portals vollständig anpassen.
API-Dokumentation	Generieren Sie automatisch eine API-Referenzdokumentation gemäß Ihren OpenAPI-Spezifikationen.
Self-Service-Registrierung	Bieten Sie Entwicklern eine Self-Service-Registrierung, damit sie mithilfe Ihrer APIs Anwendungen erstellen können.
Zielgruppenverwaltung	Zugriff auf Portalinhalte und -APIs steuern
Analysen	Google Analytics und benutzerdefiniertes Analyse-Tracking konfigurieren
Erweiterte Anpassungen	Erweiterte Portalanpassungen vornehmen. Beispiele: Domain personalisieren Benutzerdefinierte Registrierungsfelder hinzufügen Portal mithilfe von Skripts erweitern E-Mail-Adresse konfigurieren

Jetzt mit dem Aufbau Ihres Portals beginnen

So sorgt Apigee für Sicherheit im integrierten Portal

In der folgenden Tabelle wird beschrieben, wie Apigee über integrierte Funktionen im integrierten Portal die Sicherheit berücksichtigt.

Funktion	Adressen
Macht HTTPS und Transport Layer Security (TLS) erforderlich	Erzwingt verschlüsselte Kommunikation
Enthält apigee.io-Domainregistrierung mit Public Suffix List	Verhindert, dass „supercookies“ auf Subdomains von apigee.io gesetzt werden
Unterstützt die Konfiguration von Content Security Policy (CSP)	Schutz vor Cross-Site-Scripting (XSS) und anderen Angriffen durch Codeinjektion
Erforderlich: Formulareingabe bereinigen Websiteweite JavaScript-Injection, auf Administratoren beschränkt	Schützt vor HTML-, SQL- oder Back-End-Injection-Angriffen
Enthält x-content-type-options: nosniff-XSS-Header	Verhindert, dass Browser MIME-Typen erraten können
Enthält x-frame-options: deny-XSS-Header	Verhindert die Einbettung von Portalinhalten in einen iFrame
Enthält x-xss-protection: 1-XSS-Header	Verhindert das Laden von Seiten, wenn sie reflektierte Cross-Site-Scripting-Angriffe (XSS) erkennen
Verwendet CSRF-Tokens	Schutz vor websiteübergreifender Anfragefälschung
Nutzung: Verschlüsselung ruhender Daten in Google Cloud Google-Nutzerdaten und Aufbewahrungsrichtlinien Mandantenisolierung Datenaufbewahrung protokollieren und debuggen (6 Wochen)	Schutz von Kundendaten

Wie das integrierte Portal mit Edge kommuniziert

Die Mehrheit der vom Entwicklerportal verwendeten Informationen wird in Apigee Edge gespeichert. Das Portal fungiert als Client für Edge. Bei Bedarf sendet das Entwicklerportal eine HTTP- oder HTTPS REST-Anfrage, um Informationen von Edge abzurufen oder an Edge zu senden. Wenn beispielsweise ein Portalnutzer eine neue App im Portal registriert, sendet das Portal eine Anfrage an Edge, um Informationen über die App zu speichern.

Weitere Informationen finden Sie in folgenden Abschnitten.

Speicherort der App-Registrierung und der API-Schlüssel

Wenn ein Portalnutzer den App-Registrierungsprozess auf dem integrierten Portal abschließt, sendet das Portal Informationen über die App an Apigee Edge, einschließlich des App-Namens und der mit der App verknüpften API-Produkte. Wenn Edge die App erfolgreich registriert, gibt Edge einen einzelnen API-Schlüssel an das Portal zurück. Der Portalnutzer verwendet diesen API-Schlüssel, um auf die API-Produkte zuzugreifen, die der Anwendung zugeordnet sind.

Informationen zu den Apps und API-Schlüsseln werden nur in Edge gespeichert. Sie werden nicht im Portal gespeichert. Wenn ein Portalnutzer das Portal verwendet, um Informationen zu einer App aufzurufen, beispielsweise über die Seite „My Apps“ (Meine Apps), stellt das Portal eine Anfrage mit dem API-Schlüssel an Edge, um auf die Informationen zuzugreifen.

Wenn ein Portalnutzer eine App hinzufügt, entfernt oder ändert, sendet das Portal die zu speichernden Änderungen an Edge.

Da alle Informationen zu Apps und API-Schlüsseln in Edge gespeichert werden, kann ein Edge-Administrator die Informationen mithilfe der Edge-Benutzeroberfläche oder der Management API ändern. Ein Administrator kann z. B. Folgendes tun:

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

Weitere Informationen finden Sie unter Anwendungen registrieren und API-Schlüssel verwalten.

Speicherort von Informationen zum Anwendungsentwicklerkonto

Informationen zum Entwicklerkonto werden in Edge so gespeichert:

• Wenn ein Portalnutzer mit dem integrierten Identitätsanbieter ein Konto erstellt, werden die Informationen im Identitätsanbieter gespeichert und auf der Nutzerseite.
• Wenn ein Portalnutzer mit dem SAML-Identitätsanbieter sich im Portal anmeldet, wird ein Schattendatensatz der Informationen im Identitätsanbieter gespeichert. wird auf der Nutzerseite angezeigt.
• Nachdem ein Portalnutzer eine Entwickler-App registriert hat, werden die Informationen des Nutzerkontos mit Edge synchronisiert und sind auf der Entwicklerseite verfügbar.

Die folgenden Nutzerkontoinformationen werden in Edge gespeichert:

• Vor- und Nachname
• E-Mail-Adresse
• Nutzername
• Status des Portalkontos (aktiv oder inaktiv)
• Portalrolle (authentifizierter Nutzer, Administrator, andere)
• Rollenbasierte Berechtigungen
• Teams, in denen der Portalnutzer Mitglied ist (wenn Sie sich in der Betaversion der Teamfunktion angemeldet haben)

Die E-Mail-Adresse ist der Primärschlüssel, der von Edge zur Identifizierung des Entwicklers verwendet wird, und jeder muss eindeutig sein. Aus dem Primärschlüssel generiert Edge eine eindeutige Entwickler-ID für jede Organisation, zu der der Entwickler gehört.

Weitere Informationen finden Sie unter Anwendungsentwickler registrieren.

Speicherort der Informationen des Entwicklerteams (Beta)

Wenn ein Entwicklerteam von einem Portalnutzer im Portal erstellt wird, werden die Informationen des Entwicklerteams in Edge gespeichert, darunter:

• Name und Beschreibung des Entwicklerteams
• Mitglieder des Entwicklerteams und ihre Rollen
• Apps, denen das Entwicklerteam zugewiesen ist
• Dem Entwicklerteam zugewiesene Zielgruppen
• Zeitpunkt der Erstellung des Entwicklerteams

Eine eindeutige, automatisch generierte E-Mail-Adresse wird für das Entwicklungsteam generiert und dient als Primärschlüssel, der von Edge zur Identifizierung des Entwicklerteams verwendet wird.

Weitere Informationen finden Sie in den Artikeln Verantwortlichkeit für eine App über Entwicklertools teilen (Beta) und Entwicklerteams verwalten.

Über das Beispielportal

Wenn Sie ein neues Portal erstellen, erhalten Sie eine Reihe von Startseiten als Ausgangspunkt. Die Startseite umfasst Demoinhalte, um Sie für Ihre eigene Portalentwicklung zu inspirieren, wenn Sie den Text und die Bilder durch Ihren eigenen Inhalt ersetzen. Im Beispielportaldesign werden Material Design und SCSS verwendet.

Im Folgenden wird die Startseite des Beispielportals angezeigt.

Die Beispielseiten, die im Beispielportal bereitgestellt werden, sind:

Seite	Beschreibung
Startseite	Startseite des Portals, die die dargestellten APIs beschreibt Sie dient als Standardstartseite für Ihr Portal (index.html). Veranschaulicht die Verwendung von Winkelmaterialien, wie unter Winkelmaterialien hinzufügen beschrieben.
Kurzanleitung	In dieser Kurzanleitung erfahren Sie, wie Sie das Portal anpassen können. Klicken Sie im Beispielportal auf Quick Start, um auf der Seite Get Started (Erste Schritte) Inhalte hinzuzufügen.
Erste Schritte	Beispielcontentseite. Auf der Seite Erste Schritte im Beispielportal erfahren Sie, wie Sie diese Seite bearbeiten und der oberen Navigationsleiste hinzufügen.
APIs	Liste der verfügbaren APIs Wenn Sie eine interaktive API-Referenzdokumentation generieren, werden dieser Seite automatisch Links zu den Inhalten hinzugefügt. Hinweis: Die Inhalte dieser Seite werden basierend auf den APIs, die Sie in Ihrem Portal veröffentlichen, automatisch generiert. Sie können den Inhalt der Seite nicht direkt bearbeiten. Sie erscheint nicht in der Seitenliste. Sie können den Stil der Seite mit dem Portal-Designeditor ändern.
Meine Apps	Liste der registrierten Apps für einen autorisierten Nutzer. Weitere Informationen finden Sie unter Wie Portal-Nutzer mit Ihrem Portal interagieren. Hinweis: Der Inhalt dieser Seite wird anhand der registrierten Nutzer-Apps automatisch erstellt. Sie können den Inhalt der Seite nicht direkt bearbeiten. Sie erscheint nicht in der Seitenliste. Sie können den Stil der Seite mit dem Designeditor ändern.
Anmelden	Anmeldeseite für registrierte Nutzer. Neue Nutzer können sich auf dieser Seite durch eine Klick auf Registrieren registrieren. Siehe Interaktion von Portalnutzern mit Ihrem Portal. Hinweis: Die Anmeldeseite ist automatisch in Ihrem Portal enthalten. Auf der Anmeldeseite können Sie das Logo anpassen und der Seite „Konto erstellen“ benutzerdefinierte Registrierungsfelder hinzufügen. Sie können den Inhalt der Seite nicht direkt bearbeiten. Sie erscheint nicht in der Seitenliste.
Nutzungsbedingungen	Beispielseite für Nutzungsbedingungen.

Unterstützte Browser

Integrierte Apigee-Portale unterstützen dieselben Browserversionen wie Apigee Edge.