Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Entwicklerportale mit Social Publishing-Funktionen werden zunehmend für die Kommunikation mit der Entwickler-Community genutzt. Dazu gehört die Vermittlung statischer Inhalte wie API-Dokumentation und Nutzungsbedingungen sowie dynamischer von der Community beigetragener Inhalt wie Blogs und Foren.
Als API-Anbieter benötigen Sie eine Möglichkeit, Ihre APIs verfügbar zu machen, Entwickler über Ihre APIs zu informieren, Entwickler zu registrieren und Entwicklern die Registrierung von Apps zu ermöglichen. Die Bereitstellung Ihrer APIs für Entwickler ist nur ein Teil des Aufbaus einer wirklich dynamischen Community. Ihre Entwickler-Community sollte außerdem Feedback geben, Support und Funktionsanfragen stellen sowie eigene Inhalte einreichen, auf die andere Entwickler zugreifen können.
Apigee Edge bietet Ihnen ein Developer Services-Portal, mit dem Sie Ihre eigene benutzerdefinierte Website erstellen und starten können, um Ihrer Entwicklungs-Community all diese Dienste bereitzustellen. Jeder Edge-Kunde kann sein eigenes Entwicklerportal erstellen, entweder in der Cloud oder lokal.
Im folgenden Video wird das Apigee Developer Services-Portal vorgestellt.
Die folgende Abbildung zeigt die Startseite des standardmäßigen Entwicklerportals:
Das Entwicklerportal ist im Wesentlichen ein Content-Management-System (CMS), das auf dem Open-Source-Projekt Drupal (http://www.drupal.org) basiert. Drupal bietet eine Reihe von Kernfunktionen in Form von Modulen, die es Ihnen erleichtern, Inhalte für Websites zu erstellen und zu verwalten.
Über das Entwicklerportal können Sie sofort API-Dokumentationen erstellen, Blogs unterstützen und Foren mit Unterhaltungsthreads bereitstellen. Sie können das Entwicklerportal auch an Ihre spezifischen Anforderungen anpassen. Über die Anpassung können Sie die Darstellung des Portals und auch die Art und Weise ändern, wie Entwickler mit dem Portal interagieren.
Die meisten Anpassungen werden über das Drupal-Menü vorgenommen. Wenn Sie sich als Nutzer mit Administratorberechtigungen im Portal anmelden, wird oben auf jeder Portalseite das Drupal-Menü angezeigt:
Die Verwaltung steuert, wie Entwickler Zugriff auf das Portal anfordern, wie Entwickler Anwendungen registrieren, die auf Ihre APIs zugreifen, wie Sie Entwicklern bestimmte Rollen und Berechtigungen in Bezug auf Ihre APIs zuweisen und wann der Entwicklerzugriff auf APIs widerrufen wird.
Sie verwenden das Entwicklerportal auch zur Konfiguration und Steuerung der Monetarisierung. Durch die Monetarisierung erhalten Entwickler Selfservice-Zugriff auf Abrechnung und Berichte, Kataloge und Pläne sowie monetarspezifische Einstellungen über das Entwicklerportal.
Arten von Portalnutzern
Die folgende Abbildung zeigt zwei Arten von Portalnutzern:
- Entwickler sind die Community der Nutzer, die Apps mithilfe deiner APIs erstellen. App-Entwickler nutzen das Portal, um mithilfe von SmartDocs mehr über Ihre APIs zu erfahren, ein Konto im Portal zu registrieren, Apps zu registrieren, die Ihre APIs verwenden, mit der Entwickler-Community zu interagieren und statistische Informationen über ihre App-Nutzung in einem Dashboard anzusehen.
-
Das API-Team ist der API-Anbieter, der Portalinhalte erstellt, App-Entwicklern seine APIs zur Verfügung stellt, API-Dokumentation bereitstellt und Entwicklern einen Mechanismus zur Registrierung von Apps und zum Abrufen von API-Schlüsseln bietet. Das API-Team führt die grundlegende Konfiguration des Entwicklerportals durch, um:
- Automatische oder manuelle Anfragen für API-Schlüssel konfigurieren
- Pflegen Sie die API-Dokumentation, Foren und Blogs und überarbeiten Sie optional alle Änderungen.
- Umgang mit Nutzerkommentaren und Forenmoderationen
- Erzwingen Sie die rollenbasierte Zugriffssteuerung (Role-Based Access Control, RBAC), um den Zugriff auf Features im Portal zu steuern. Beispielsweise kann ein Administrator Steuerelemente aktivieren, um einem registrierten Nutzer zu erlauben, Forenbeiträge zu erstellen oder Testkonsolen zu verwenden
- Passen Sie E-Mail-Benachrichtigungen an Administratoren und Entwickler zur Erstellung und Genehmigung von Nutzern an
- Webformulare wie Kontaktformulare anpassen
In dieser Abbildung ist eine dritte Art von Portalnutzern nicht zu sehen: der API-Produktmanager. Der API-Produktmanager definiert, wie das API-Team das Portal erstellt. Dies umfasst Folgendes:
- Definieren, wie APIs in Produkte verpackt werden
- Regeln für die App-Genehmigung definieren
- Definieren der Preise und Abrechnungstarife für API-Produkte, wenn die Monetarisierung im Portal aktiviert ist. Weitere Informationen zur Monetarisierung findest du unter Monetarisierung.
Entwicklerportal anpassen
Überlegen Sie als API-Anbieter, wie Sie das Entwicklerportal an Ihre APIs anpassen und Ihrer Entwickler-Community die notwendigen Informationen zur Verwendung Ihrer APIs bereitstellen können. Beachten Sie Folgendes für Ihr benutzerdefiniertes Portal:
- Einfacher Zugriff auf Ihre APIs
- Dokumentation wie Anleitungen und Referenzdokumente
- Inhalte von der Community wie Blogs und Diskussionsforen
- Beispielcode
- Ein einfacher Anmeldeprozess, bei dem neue Entwickler, Apps und APIs schnell genehmigt werden können
- Verwaltete Rechte und Anmeldedaten
- Gestaffelte Zugriffssteuerung
- Ein Design, das zu Ihrer Organisation passt
Das Portal verfügt über eine vordefinierte Grundkonfiguration. Standardmäßig ist das Portal beispielsweise so konfiguriert, dass sich jeder als Entwickler registrieren kann. Ein Administrator muss jedoch jede Registrierung genehmigen, bevor sich der Entwickler im Portal anmelden kann. Nach der Registrierungsgenehmigung kann der Entwickler eine App registrieren, um einen API-Schlüssel anzufordern und über das Portal auf API-Ressourcen zuzugreifen.
Der Standardregistrierungsprozess umfasst folgende Schritte:
- Der Entwickler registriert sich über das Entwicklerportal. Daraufhin sendet das Portal eine E-Mail an die Administratoren, um das Konto zu genehmigen.
- Ein Administrator genehmigt das Konto und der Entwickler wird per E-Mail darüber informiert, dass er sich jetzt anmelden kann.
- Der Entwickler registriert eine App und wählt die von der App verwendeten API-Produkte aus. Daraufhin weist das Portal der App einen eindeutigen API-Schlüssel zu.
- Der Entwickler gibt den API-Schlüssel weiter, wenn er Anfragen an Ihre API sendet.
Diese vorkonfigurierte Version lässt sich individuell anpassen. Sie können beispielsweise das standardmäßige Registrierungs- und Autorisierungsschema überschreiben, sodass ein neuer Entwickler automatisch genehmigt und nach der Registrierung angemeldet wird. Alternativ können Sie den Entwickler auffordern, eine Reihe von Nutzungsbedingungen zu akzeptieren, bevor er sich zum ersten Mal anmelden kann.
Außerdem haben Sie die vollständige Kontrolle über die Inhalte, die im Entwicklerportal verfügbar sind. Im Entwicklerportal können sofort Beispielinhalte wie API-Dokumentation, Blogposts und Forendiskussionen präsentiert werden. Du kannst eigene Inhalte bereitstellen und das Erscheinungsbild jedes Inhaltstyps anpassen.
Weitere Informationen finden Sie unter Darstellung anpassen.
Entwicklerportal verwalten
Entwickler nutzen Ihr Entwicklerportal, um auf Ihre API zuzugreifen und sie zu verwenden. Administratoren führen Kontoverwaltungsaufgaben wie die folgenden aus:
- Anpassen des Registrierungsprozesses für Entwickler, einschließlich Registrierungsfeldern, integriertem Captcha und automatischer oder manueller Genehmigung
- Hinzufügen oder Genehmigen von Entwicklern Standardmäßig kann sich jeder Entwickler über das Entwicklerportal registrieren, muss aber von einem Administrator über die Benutzeroberfläche des Entwicklerportals genehmigt werden. Administratoren können Entwickler auch direkt im Portal erstellen. Das Portal sendet dann automatisch eine E-Mail an den Entwickler, dass ein Konto für ihn erstellt wurde.
- Das Konto eines Entwicklers ändern Administratoren können beispielsweise den Kontostatus des Nutzers von „Aktiv“ zu „Blockiert“ ändern oder die Profilinformationen des Entwicklers wie den Namen des Unternehmens ändern.
- Einen Entwickler entfernen Administratoren können das Konto eines Entwicklers deaktivieren oder löschen.
- Zuweisen von Rollen und Berechtigungen: Administratoren können einem Entwicklerkonto eine bestimmte Rolle zuweisen. Einer Rolle sind verschiedene Berechtigungen zugeordnet, z. B. die Berechtigung zum Erstellen von Büchern oder anderen Inhalten. Sie können auch die mit einer Rolle verknüpften Berechtigungen ändern oder neue Rollen erstellen.
Weitere Informationen finden Sie unter Nutzerkonten hinzufügen und verwalten.
Zusammenfassung der Funktionen des Entwicklerportals
Die folgende Tabelle enthält eine Zusammenfassung der Funktionen des Entwicklerportals:
| Funktion | Details |
|---|---|
| Unterstützte Browser | |
|
Nutzerregistrierung |
|
|
Nutzerverwaltung |
|
|
Darstellung von Portalen |
|
|
Inhalts- und Community-Verwaltung |
|
|
Berechtigungen |
|
|
Verwalten von API-Schlüsseln |
|
|
|
|
|
Blogs |
|
|
Foren |
|
|
Dokumentation |
|
|
Speisekarten |
|
|
Suche |
|
|
Linkprüfung |
|