Interaktion von Portalnutzern mit Ihrem Portal

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

Mit dem Entwicklerportal können Ihre Portalnutzer sofort ein Nutzerkonto erstellen, sich anmelden und die Apps verwalten, die Ihre APIs verwenden.

In den folgenden Abschnitten wird beschrieben, wie Portalnutzer mit Ihrem Portal interagieren.

Im Portal anmelden

In den folgenden Abschnitten wird beschrieben, wie sich Portalnutzer mit ihren Nutzeranmeldedaten (integrierter Identitätsanbieter) oder mit SAML (Beta) im integrierten Portal anmelden.

Wenn Sie sowohl den integrierten als auch den SAML-Identitätsanbieter aktivieren, können Portalnutzer ihre bevorzugte Methode für die Anmeldung auswählen.

Mit Nutzeranmeldedaten anmelden (integrierter Identitätsanbieter)

Wenn der integrierte Identitätsanbieter aktiviert ist, können sich Portalnutzer mit ihren Anmeldedaten (Nutzername und Passwort) im integrierten Portal anmelden, wie in den folgenden Abschnitten beschrieben:

Nutzerkonto im integrierten Portal erstellen

Damit Nutzer des Portals Ihre APIs nutzen können, müssen sie mit dem integrierten Identitätsanbieter ein integriertes Nutzerkonto erstellen.

Portalnutzer erstellen im integrierten Portal wie folgt ein Nutzerkonto:

  1. Rufen Sie das Portal auf.

  2. Klicken Sie auf Sign In (Anmelden).

    Die Anmeldeseite wird geöffnet.

  3. Klicken Sie auf Konto erstellen.

    Die Seite "Konto erstellen" wird angezeigt.

    Dialogfeld "Ihr Konto erstellen"

  4. Füllen Sie es aus.

    Sie müssen Werte für alle erforderlichen Felder eingeben. Passwörter müssen aus mindestens acht Zeichen bestehen und mindestens eine Ziffer, einen Kleinbuchstaben, einen Großbuchstaben und ein Sonderzeichen enthalten.

  5. Lesen Sie die Bedingungen und stimmen Sie ihnen zu.

  6. Klicken Sie auf Konto erstellen.

  7. Füllen Sie das CAPTCHA-Formular aus und klicken Sie auf Bestätigen, falls diese Option angezeigt wird.

    Das Entwicklerkonto wird erstellt und eine Bestätigungs-E-Mail wird gesendet.

  8. Klicken Sie innerhalb von zehn Minuten auf den Link in der Bestätigungs-E-Mail, um die Registrierung abzuschließen.

    Wenn Sie nicht innerhalb von zehn Minuten auf den Link klicken, müssen Sie die Schritte in diesem Verfahren wiederholen, um ein Konto zu erstellen und eine neue Eingabeaufforderung zu erhalten.

  9. Melden Sie sich im integrierten Portal an (wie unten beschrieben).

Im integrierten Portal anmelden

Nutzer, die sich im integrierten Portal registriert haben und genehmigt wurden, nutzen den integrierten Identitätsanbieter, um sich mit ihren Anmeldedaten (Nutzername und Passwort) anzumelden.

So melden sich Portalnutzer an:

  1. Rufen Sie das Portal auf.
  2. Klicken Sie auf Sign In (Anmelden). Auf der Anmeldeseite wird Folgendes angezeigt: Anmeldeseite
  3. Geben Sie die E-Mail-Adresse und das Passwort ein.
  4. Klicken Sie auf Sign In (Anmelden).

Passwort ändern

So ändern Portalnutzer mit dem integrierten Identitätsanbieter das Passwort:

  1. Rufen Sie das Portal auf.
  2. Klicken Sie auf Sign In (Anmelden).
  3. Klicken Sie auf Passwort zurücksetzen.
  4. Geben Sie die E-Mail-Adresse des Kontos ein, das zurückgesetzt werden soll.

  5. Klicken Sie auf Link zum Zurücksetzen des Passworts senden.

    Ein Link zum Zurücksetzen des Passworts wird an die E-Mail-Adresse gesendet.

  6. Klicken Sie auf den Link in der Bestätigungs-E-Mail.

  7. Geben Sie das neue Passwort ein und bestätigen Sie es.

    Passwörter müssen aus mindestens acht Zeichen bestehen und mindestens eine Ziffer, einen Kleinbuchstaben, einen Großbuchstaben und ein Sonderzeichen enthalten.

  8. Klicken Sie auf Neues Passwort erstellen.

Mit der SAML-Authentifizierung im Portal anmelden (Beta)

Wenn der SAML-Identitätsanbieter aktiviert ist, melden sich Portalnutzer mithilfe der SAML-Authentifizierung folgendermaßen im integrierten Portal an:

  1. Rufen Sie das Portal auf.
  2. Klicken Sie auf Sign In (Anmelden).

  3. Klicken Sie auf Mit SAML anmelden.

    Sie werden zum SAML-Anbieter weitergeleitet.

  4. Wenn Sie dazu aufgefordert werden, geben Sie die Anmeldedaten für Ihren SAML-Identitätsanbieter ein.

API-Referenzdokumentation ansehen

Portalnutzer können die API-Referenzdokumentation, die Sie in Ihrem Portal veröffentlicht haben, so aufrufen:

  1. Rufen Sie das Portal auf.

  2. Klicken Sie in der oberen Navigationsleiste auf APIs. Die Seite „APIs“ wird angezeigt. Beispiel:

    Seite "APIs"

  3. Filtern Sie die Liste der APIs mit den Tools im linken Bereich nach Kategorie, Titel oder Beschreibung.

  4. Klicken Sie auf eine API-Karte, um die API-Referenzdokumentation aufzurufen. Die API-Referenzdokumentation wird geöffnet.

Portalnutzer können die APIs kennenlernen und ausprobieren oder das Dokument herunterladen, das zum Rendern der API-Referenzdokumentation verwendet wird. Weitere Informationen zum Rendern der API-Referenzdokumentation finden Sie unter APIs veröffentlichen.

Mithilfe von Entwicklerteams die Verantwortung für eine App teilen (Beta)

Entwicklerteams ermöglichen Portalnutzern, die Verantwortung für eine App mit anderen Portalnutzern zu teilen. In den folgenden Abschnitten wird beschrieben, wie Entwicklerteams erstellt und verwaltet werden.

Informationen zu den Rollen des Entwicklerteams

In der folgenden Tabelle sind die Rollen zusammengefasst, die den Mitgliedern des Entwicklerteams zugewiesen werden können:

Rolle Beschreibung
Anwendungsadministrator
  • Leseberechtigungen für Mitglieder des Entwicklerteams und Details zum Entwicklerteam.
  • Lese- und Schreibberechtigungen für Apps.
Owner Vollständige Lese- und Schreibberechtigungen für Mitglieder des Entwicklerteams, Details zum Entwicklerteam und Apps.
Betrachter Leseberechtigungen für Mitglieder des Entwicklerteams, Details zum Entwicklerteam und Apps.

Seite „Teams“ aufrufen

Auf der Seite „Teams“ werden die Entwicklerteams angezeigt, für die Sie Mitglied sind.

So rufen Sie die Seite „Teams“ auf:

  1. Im Portal anmelden.
  2. Wählen Sie im Portal im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.

Die Seite Teams wird angezeigt. Hier können Sie:

Entwicklerteams hinzufügen

So fügen Sie ein Entwicklerteam hinzu:

  1. Im Portal anmelden.
  2. Wählen Sie im Portal im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.
  3. Klicken Sie auf + Neues Team.
  4. Geben Sie einen Namen und eine Beschreibung ein.

  5. Wenn Sie dem Entwicklerteam ein Mitglied hinzufügen möchten, klicken Sie auf + Weiteres Mitglied hinzufügen, geben Sie die E-Mail-Adresse des Portalnutzers ein und wählen Sie eine Entwicklerteamrolle aus.

    Wiederholen Sie den Vorgang, um weitere Mitglieder hinzuzufügen.

  6. Wenn Sie ein Mitglied aus dem Entwicklerteam löschen möchten, klicken Sie neben dem jeweiligen Mitglied des Entwicklerteams auf das Symbol "Löschen".

  7. Klicken Sie auf Erstellen.

Mitgliedschaft und Rollen des Entwicklerteams bearbeiten

So bearbeiten Sie die Mitgliedschaften und Rollen des Entwicklerteams:

  1. Im Portal anmelden.
  2. Wählen Sie im Portal im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.
  3. Klicken Sie in die Zeile des Entwicklerteams, das Sie bearbeiten möchten und für das Sie der Inhaber sind.

  4. Führen Sie einen oder mehrere der folgenden Schritte aus:

    • Bearbeiten Sie den Namen, die Beschreibung und den primären Kontakt.
    • Mitglieder des Entwicklerteams hinzufügen oder entfernen.
    • Rollen von Mitgliedern eines Entwicklerteams aktualisieren

  5. Klicken Sie auf Speichern.

Sich selbst aus einem Entwicklerteam entfernen

So entfernen Sie sich selbst aus einem Entwicklerteam:

  1. Im Portal anmelden.
  2. Wählen Sie im Portal im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.
  3. Klicken Sie in die Zeile des Entwicklerteams, aus dem Sie sich entfernen möchten.
  4. Klicken Sie auf Team verlassen.

Entwicklerteam löschen

So löschen Sie ein Entwicklerteam:

  1. Im Portal anmelden.
  2. Wählen Sie im Portal im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.
  3. Klicken Sie in die Zeile des Entwicklerteams, das Sie löschen möchten.
  4. Klicken Sie auf Symbol "Löschen".
  5. Klicken Sie zur Bestätigung noch einmal auf Bestätigen.

Apps registrieren

Registrieren Sie Entwickler-Apps und Entwicklerteam-Apps wie in den folgenden Abschnitten beschrieben.

Entwickler-Apps registrieren

Portalnutzer können Apps so registrieren, um die veröffentlichten APIs zu verwenden:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie auf + Neue App, um eine neue App zu erstellen.
  3. Geben Sie im Dialogfeld "Neue App" einen Namen und eine Beschreibung für die App ein.

  4. Wählen Sie den Inhaber der App aus der Drop-down-Liste Inhaber aus.

    Standardmäßig sind Sie der Inhaber der App. Wählen Sie bei Bedarf ein Entwicklerteam aus dem Drop-down-Menü aus, um die Verantwortung für die App mit anderen Mitgliedern aus dem Entwicklerteam zu teilen. Weitere Informationen

  5. Wählen Sie im Abschnitt "API-Katalog" eine oder mehrere APIs aus.

    APIs werden im Katalog in authentifizierte APIs mit erforderlicher Callback-URL und öffentliche APIs eingeteilt. Sie müssen mindestens eine API auswählen, um eine App zu erstellen.

  6. Wenn Sie eine API im Abschnitt "Authentifizierte APIs" auswählen, geben Sie eine Callback-URL ein.

    Weitere Informationen finden Sie unter Callback-URLs.

  7. Klicken Sie auf Erstellen.

Apps des Entwicklerteams registrieren

Mitglieder des Entwicklerteams können Apps für ein Entwicklerteam registrieren, um die von Ihnen veröffentlichten APIs zu verwenden, wie unten beschrieben.

Weitere Informationen:

So registrieren Sie Apps von Entwicklerteams:

  1. Wählen Sie im Drop-down-Menü „Nutzerkonto“ die Option Teams aus.
  2. Klicken Sie auf die Zeile des Entwicklerteams, für das Sie eine App registrieren möchten.
  3. Klicken Sie auf + Neue App, um eine neue App zu erstellen.
  4. Geben Sie im Dialogfeld "Neue App" einen Namen und eine Beschreibung für die App ein.

  5. Wählen Sie den Inhaber der App aus der Drop-down-Liste Inhaber aus.

    Das Entwicklerteam ist standardmäßig der Inhaber der App. Wählen Sie bei Bedarf ein anderes Entwicklerteam oder sich selbst als Inhaber aus dem Drop-down-Menü aus.

  6. Wählen Sie im Abschnitt "API-Katalog" eine oder mehrere APIs aus.

    APIs werden im Katalog in authentifizierte APIs mit erforderlicher Callback-URL und öffentliche APIs eingeteilt. Sie müssen mindestens eine API auswählen, um eine App zu erstellen.

  7. Wenn Sie eine API im Abschnitt "Authentifizierte APIs" auswählen, geben Sie eine Callback-URL ein.

    Weitere Informationen finden Sie unter Callback-URLs.

  8. Klicken Sie auf Erstellen.

APIs in einer App verwalten

Als API-Ersteller können Sie APIs veröffentlichen, damit Portalnutzer Ihre API-Produkte nutzen können.

Portalnutzer verwalten, welche APIs ihre Anwendungen verwenden. Die APIs werden auf der Detailseite der Anwendung hinzugefügt. Bei einigen APIs erfolgt die Genehmigung nicht automatisch. Der Status Genehmigung ausstehend gibt an, dass eine API angefordert wurde, aber noch nicht erteilt wurde.

Portalnutzer können die APIs in einer App so über Ihr Portal verwalten:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie in der Liste auf die App.
  3. Klicken Sie im Abschnitt "APIs" auf Symbol zum Aktivieren oder Symbol zum Deaktivieren, um den Zugriff auf eine API über die App zu aktivieren bzw. zu deaktivieren.
  4. Fügen Sie für eine authentifizierte API die erforderliche Callback-URL hinzu oder bearbeiten Sie sie.

API-Schlüssel und Secret für eine App aufrufen

So können Portalnutzer den API-Schlüssel für eine App über Ihr Portal verwalten:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie in der Liste auf die App.
  3. Die API-Schlüssel werden im Abschnitt "API-Schlüssel" aufgelistet.
  4. Prüfen Sie, ob der API-Schlüssel den Status "Aktiv" hat. Falls für Ihren API-Schlüssel eine Genehmigung erforderlich ist, aber noch nicht genehmigt wurde, lautet der Status Genehmigung ausstehend.
  5. Klicken Sie auf Secret ansehen, um das Secret aufzurufen.
  6. Bewegen Sie den Mauszeiger auf den API-Schlüssel oder das Secret und klicken Sie auf delete-icon, um ihn in die Zwischenablage zu kopieren.

API-Schlüssel für eine App rotieren

Ein Portalnutzer kann den API-Schlüssel einer App regelmäßig oder als Reaktion auf einen potenziellen Datenleck oder eine manipulierte Funktion rotieren. Wenn ein Portalnutzer einen API-Schlüssel rotiert, wird ein neuer API-Schlüssel mit denselben API-Berechtigungen erstellt wie der ursprüngliche Schlüssel. Der ursprüngliche API-Schlüssel bleibt aktiv, während Sie ihn außer Kraft setzen. Sie müssen den alten API-Schlüssel widerrufen, um zu verhindern, dass seine Anmeldedaten akzeptiert werden, wie unter API-Schlüssel für eine Anwendung widerrufen beschrieben.

So können Portalnutzer einen API-Schlüssel für eine App von Ihrem Portal rotieren:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie in der Liste auf die App.
  3. Klicken Sie im Abschnitt "API-Schlüssel" auf Schlüssel hinzufügen.
  4. Klicken Sie im Dialogfeld auf Bestätigen, um den Vorgang zu bestätigen.
  5. Optional können Sie den alten API-Schlüssel wie unten beschrieben aufheben.

API-Schlüssel für eine App aufheben

Wenn ein Portalnutzer einen API-Schlüssel rotiert, wie im vorherigen Abschnitt beschrieben, bleibt der API-Schlüssel aktiv, während Sie seine Verwendung einstellen. Sie müssen einen API-Schlüssel aufheben, um zu verhindern, dass seine Anmeldedaten akzeptiert werden.

So können Portalnutzer einen API-Schlüssel für eine App von Ihrem Portal aufheben:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie auf den Namen der App.
  3. Klicken Sie im Abschnitt "API-Schlüssel" in der Spalte "Aktionen" für den zu widerrufenden API-Schlüssel auf revoke icon.

  4. Klicken Sie auf Bestätigen, um den Vorgang zu bestätigen.

    Der Status des Schlüssels wird auf "Aufgehoben" aktualisiert.

App-Details bearbeiten

So können Portalnutzer App-Details bearbeiten:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie in der Liste auf die App.
  3. Bearbeiten Sie auf dem Tab „App-Details“ die Felder „Name“ und „Beschreibung“.
  4. Verwalten Sie die APIs in einer Anwendung je nach Bedarf.
  5. Klicken Sie auf Speichern.

Apps löschen

Portalnutzer können eine App so aus Ihrem Portal löschen:

  1. Wählen Sie Apps aus dem Drop-down-Menü des Nutzerkontos aus.
  2. Klicken Sie in der Liste auf die App.
  3. Klicken Sie auf Delete.
  4. Klicken Sie auf Bestätigen, um den Vorgang zu bestätigen.

Die App wird gelöscht und aus der App-Liste entfernt.