Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Das Entwicklerportal ist sofort einsatzbereit und bietet Ihren App-Entwicklern die Möglichkeit, sich zu registrieren, anzumelden und die Apps zu verwalten, die Ihre APIs nutzen.
In den folgenden Abschnitten wird beschrieben, wie App-Entwickler mit Ihrem Portal interagieren:
Wie die Registrierung und Anmeldung von App-Entwicklern in Edge verfolgt werden
Die Entwicklerregistrierung und die Portalanmeldung werden mit dem benutzerdefinierten Attribut _apiportal in Edge verfolgt.
Wenn sich ein Entwickler selbst registriert, wird das benutzerdefinierte Attribut _apiportal der Entwicklerkonfiguration hinzugefügt und der Entwicklerstatus wird auf unverified gesetzt, um anzuzeigen, dass sich der Entwickler nicht im Portal angemeldet hat. Beispiel: {"status":"unverified","portals":{}}
Wenn sich der Entwickler das erste Mal in einem Portal anmeldet, wird das benutzerdefinierte Attribut _apiportal aktualisiert, um den Portalnamen und die Zeit des Zugriffs zu erfassen und den Entwicklerstatus auf active zu setzen. Jedes Mal, wenn sich der Entwickler im Portal anmeldet, wird das benutzerdefinierte Attribut aktualisiert, um den lastVisit-Wert (im Epochenformat) für dieses Portal zurückzusetzen. Beispiele: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}
App-Entwicklerkonto registrieren
Bevor App-Entwickler Ihre APIs verwenden können, müssen sie sich über ein Konto registrieren.
Wenn sich ein App-Entwickler bei Ihrem Portal registriert, gilt Folgendes:
- Informationen zum App-Entwickler werden in Edge erstellt und gespeichert. Weitere Informationen
- Der App-Entwickler erscheint in der Liste der registrierten App-Entwickler. Weitere Informationen finden Sie unter Entwicklerseite.
Alternativ können Sie App-Entwickler in ihrem Namen über die Edge-Benutzeroberfläche registrieren, wie unter App-Entwickler registrieren beschrieben.
Neue App-Entwickler können sich so selbst bei Ihrem Portal registrieren:
- Rufen Sie das Portal auf.
- Klicken Sie auf Anmelden.
Klicke auf Registrieren.
Das folgende Dialogfeld wird angezeigt.
Geben Sie die erforderlichen Informationen ein (Vorname, Nachname und E-Mail-Adresse).
Klicken Sie auf Erstellen.
Das folgende Dialogfeld wird angezeigt.
Klicken Sie auf den sicheren Link in der E-Mail, um das Portal zu öffnen und die authentifizierte Sitzung einzurichten.
Im Portal anmelden
Nachdem sich App-Entwickler bei Ihrem Portal registriert haben, melden sie sich über die Anmeldeseite an.
Jedes Mal, wenn sich ein App-Entwickler in einem Portal anmeldet, wird ein sicherer Link gesendet, um die Identität zu bestätigen und eine Sitzung mit dem Portal einzurichten, statt ein gemeinsames Geheimnis wie ein Passwort zu verwenden.
App-Entwickler können sich so in Ihrem Portal anmelden:
- Rufen Sie das Portal auf.
- Klicken Sie auf Sign In (Anmelden).
- Geben Sie die mit dem Konto verknüpfte E-Mail-Adresse ein.
Klicken Sie auf Login.
Das folgende Dialogfeld wird angezeigt.
Klicken Sie auf den sicheren Link in der E-Mail, um das Portal zu öffnen und die authentifizierte Sitzung einzurichten.
Apps registrieren
Nach der Anmeldung im Portal können App-Entwickler Apps für die Verwendung der von Ihnen veröffentlichten API-Produkte wie folgt registrieren:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf + App, um eine neue App zu erstellen.
- Geben Sie im Dialogfeld „App erstellen“ einen Namen und eine Beschreibung für die App ein.
- Klicken Sie auf Erstellen.
- Verwalten Sie die API-Produkte in der App, wie unten beschrieben.
API-Produkte in einer App verwalten
App-Entwickler können die API-Produkte in ihren Apps verwalten. Die API-Produkte werden auf der Detailseite der App hinzugefügt. Bei einigen API-Produkten erfolgt die Genehmigung nicht automatisch. Der Status Ausstehend gibt ein API-Produkt an, für das der Zugriff angefordert, aber noch nicht gewährt wurde.
App-Entwickler können die API-Produkte in einer App wie folgt über Ihr Portal verwalten:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Klicken Sie auf Produkte verwalten.
Klicken Sie auf die Ein-/Aus-Schaltfläche Zugriff, um den Zugriff auf ein API-Produkt über die App zu aktivieren oder zu deaktivieren.
Hinweis: Wenn der App-Entwickler den Zugriff auf ein privates oder internes API-Produkt deaktiviert, wird das API-Produkt aus der App entfernt und muss vom Portaladministrator manuell wieder hinzugefügt werden, wie unter Apps registrieren und API-Schlüssel verwalten beschrieben.
Klicken Sie auf Anfrage, um die Genehmigung für ein API-Produkt anzufordern, das noch nicht zulässig ist.
Klicken Sie auf Speichern.
API-Schlüssel für eine App aufrufen
App-Entwickler können den API-Schlüssel für eine App wie folgt über Ihr Portal verwalten:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Sehen Sie sich den API-Schlüssel im Abschnitt Schlüssel an.
- Klicken Sie auf Secret ansehen, um das Secret des API-Schlüssels anzuzeigen.
- Prüfen Sie, ob der Status des API-Schlüssels „Genehmigt“ lautet.
API-Schlüssel für eine App rotieren
Ein App-Entwickler kann den API-Schlüssel einer App regelmäßig oder als Reaktion auf ein potenzielles Datenleck oder eine Manipulation rotieren. Wenn ein App-Entwickler einen API-Schlüssel rotiert, wird ein neuer API-Schlüssel mit denselben API-Produktberechtigungen wie der ursprüngliche Schlüssel erstellt. Der ursprüngliche API-Schlüssel ist als veraltet markiert, bleibt aber aktiv, bis Sie ihn außer Betrieb nehmen. Sie müssen einen verworfenen Schlüssel deaktivieren, damit seine Anmeldedaten nicht mehr akzeptiert werden, wie unter API-Schlüssel für eine App deaktivieren beschrieben.
App-Entwickler können den primären API-Schlüssel für eine App in Ihrem Portal wie folgt rotieren:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Platzieren Sie im Bereich „Schlüssel“ den Cursor über dem aktuellen API-Schlüssel, um das Aktionsmenü aufzurufen.
- Klicken Sie auf
, um das Aktionsmenü zu maximieren. - Klicken Sie auf Drehen.
- Klicken Sie im Dialogfeld auf Erstellen, um den Vorgang zu bestätigen.
- Sie können den API-Schlüssel auch wie unten beschrieben deaktivieren.
API-Schlüssel für eine App deaktivieren
Wenn ein App-Entwickler einen API-Schlüssel wie im vorherigen Abschnitt beschrieben rotiert, wird er als verworfen markiert. Er bleibt aber aktiv, bis Sie ihn außer Betrieb nehmen. Sie müssen einen verworfenen Schlüssel deaktivieren, damit seine Anmeldedaten nicht mehr akzeptiert werden.
App-Entwickler können einen API-Schlüssel für eine App auf Ihrem Portal wie folgt deaktivieren:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Klicken Sie im Abschnitt „Schlüssel“ auf Schlüsselverlauf, um die Liste der verworfenen Schlüssel aufzurufen.
- Bewegen Sie den Mauszeiger auf den veralteten API-Schlüssel, den Sie deaktivieren möchten, um das Aktionsmenü aufzurufen.
- Klicken Sie auf , um das Aktionsmenü zu maximieren.
- Klicke auf Deaktivieren.
- Klicken Sie auf Deaktivieren, um den Vorgang zu bestätigen.
Der Status des Schlüssels wird in „Widerrufen“ geändert.
App-Details bearbeiten
App-Entwickler können die App-Details so bearbeiten:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Bearbeiten Sie die Felder Name oder Beschreibung.
- Klicken Sie auf Speichern.
Die App wird gelöscht und aus der Liste „Meine Apps“ entfernt.
Apps löschen
App-Entwickler können eine App wie folgt aus Ihrem Portal löschen:
- Wählen Sie Meine Apps aus dem Nutzer-Drop-down aus.
- Klicken Sie auf den Namen der App.
- Klicken Sie rechts oben auf der Seite auf Löschen.
Die App wird gelöscht und aus der Liste „Meine Apps“ entfernt.