Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Entwicklerportale mit Funktionen für soziale Veröffentlichungen werden immer mehr für die Kommunikation mit der Entwicklungs-Community verwendet. Dies beinhaltet die Kommunikation von statischen Inhalten wie API-Dokumentation und Nutzungsbedingungen sowie dynamische Community-Inhalte wie Blogs und Foren.
Als API-Anbieter benötigen Sie eine Möglichkeit, Ihre APIs bereitzustellen, Entwickler über Ihre APIs zu informieren, Entwickler zu registrieren und Entwicklern die Registrierung von Apps zu ermöglichen. Die APIs für Entwickler freizugeben, ist nur ein Teil der Schaffung einer wirklich dynamischen Community. Außerdem muss Ihre Entwickler-Community Feedback geben, Support- und Funktionsanfragen stellen und eigene Inhalte einreichen können, auf die andere Entwickler zugreifen können.
Apigee Edge bietet ein Developer Services-Portal, mit dem Sie Ihre eigene benutzerdefinierte Website erstellen und veröffentlichen können, um all diese Dienste für Ihre Entwickler-Community 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 Funktionen in Form von Modulen, mit denen Sie Inhalte für Websites erstellen und verwalten können.
Mit dem vorkonfigurierten Entwicklerportal können Sie API-Dokumentationen erstellen, das Bloggen unterstützen und Foren bereitstellen. Sie können das Entwicklerportal auch an Ihre spezifischen Anforderungen anpassen. Mit der Anpassung können Sie die Darstellung des Portals und die Interaktion der Entwickler mit dem Portal ändern.
Die meisten Anpassungen werden über das Drupal-Menü vorgenommen. Wenn Sie sich als Nutzer mit Administratorberechtigungen im Portal anmelden, wird das Drupal-Menü oben auf jeder Portalseite angezeigt:
Über die Verwaltung wird der Prozess gesteuert, bei dem Entwickler Zugriff auf das Portal anfordern, wie Entwickler die Apps registrieren, die auf Ihre APIs zugreifen, wie Sie Entwicklern bestimmte Rollen und Berechtigungen im Zusammenhang mit Ihren APIs zuweisen und wann der Entwicklerzugriff auf APIs widerrufen werden soll.
Außerdem können Sie dort die Monetarisierung konfigurieren und steuern. Mit der Monetarisierung erhalten Entwickler über das Entwicklerportal Selfservice-Zugriff auf „Abrechnung und Berichte“, „Katalog und Tarife“ sowie Monetarisierungseinstellungen.
Arten von Portalnutzern
Die folgende Abbildung zeigt zwei Arten von Portalnutzern:
- Entwickler sind die Nutzer, die mithilfe Ihrer APIs Apps erstellen. App-Entwickler können sich über das Portal über Ihre APIs informieren, ein Konto im Portal registrieren, Apps registrieren, die Ihre APIs verwenden, mit der Entwickler-Community interagieren und sich in einem Dashboard statistische Informationen zur App-Nutzung ansehen.
-
Das API-Team ist der API-Anbieter, der Portalinhalte erstellt, seine APIs für App-Entwickler verfügbar macht, API-Dokumentation bereitstellt und einen Mechanismus für Entwickler zum Registrieren von Apps und zum Abrufen von API-Schlüsseln bereitstellt. Das API-Team führt eine grundlegende Konfiguration des Entwicklerportals durch, um:
- Automatische oder manuelle Anfragen für API-Schlüssel konfigurieren
- API-Dokumentation, Foren und Blogs verwalten und optional alle Änderungen überarbeiten
- Nutzerkommentare und Moderation von Foren
- Durch die rollenbasierte Zugriffssteuerung (Role-Based Access Control, RBAC) wird der Zugriff auf Funktionen im Portal gesteuert. Ein Administrator kann beispielsweise Einstellungen aktivieren, damit ein registrierter Nutzer Forumsbeiträge erstellen oder Testkonsolen verwenden kann.
- E-Mail-Benachrichtigungen für Administratoren und Entwickler zur Nutzererstellung und -genehmigung anpassen
- Webformulare wie „Kontakt“ anpassen
In dieser Abbildung ist eine dritte Art von Portalnutzer nicht zu sehen: der API-Produktmanager. Der API-Produktmanager ist dafür verantwortlich, zu definieren, wie das API-Team das Portal erstellt, einschließlich:
- Definition der Verpackung von APIs in Produkten
- Regeln für die App-Freigabe definieren
- Wenn die Monetarisierung im Portal aktiviert ist, definieren Sie die Preis- und Abrechnungspläne für API-Produkte. Weitere Informationen zur Monetarisierung finden Sie unter Monetarisierungsübersicht.
Entwicklerportal anpassen
Als API-Anbieter sollten Sie überlegen, wie Sie das Entwicklerportal so anpassen, dass es am besten zu Ihren APIs passt, und die erforderlichen Informationen für Ihre Entwickler-Community zur Verfügung stellen, damit sie Ihre APIs verwenden kann. Einige Aspekte, die Sie bei Ihrem benutzerdefinierten Portal berücksichtigen sollten:
- Einfacher Zugriff auf Ihre APIs
- Dokumentation, z. B. Anleitungen und Referenzdokumente
- Von der Community erstellte Inhalte wie Blogs und Diskussionsforen
- Beispielcode
- Ein einfacher Registrierungsprozess, bei dem neue Entwickler, Apps und APIs schnell genehmigt werden können
- Verwaltete Rechte und Anmeldedaten
- Stufenweise Zugriffssteuerung
- Ein Design, das zu Ihrer Organisation passt
Das Portal ist mit einer grundlegenden Konfiguration vordefiniert. Das Portal ist beispielsweise standardmäßig so konfiguriert, dass sich jeder als Entwickler registrieren kann. Jede Registrierung muss jedoch von einem Administrator genehmigt werden, bevor sich der Entwickler im Portal anmelden kann. Nach der Genehmigung der Registrierung kann der Entwickler eine App registrieren, um einen API-Schlüssel anzufordern, und über das Portal auf API-Ressourcen zugreifen.
Die Schritte im Standardregistrierungsprozess sind:
- 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 bei Anfragen an Ihre API weiter.
Diese Lösung ist bereits ab Werk sehr anpassbar. Sie können beispielsweise das Standardregistrierungs- und Autorisierungsschema überschreiben, damit ein neuer Entwickler nach der Registrierung automatisch genehmigt und angemeldet wird. Alternativ können Sie verlangen, dass der Entwickler eine Reihe von Nutzungsbedingungen akzeptiert, bevor er sich zum ersten Mal anmelden kann.
Außerdem haben Sie die volle Kontrolle über die Inhalte, die im Entwicklerportal verfügbar sind. Das Entwicklerportal enthält bereits Beispielinhalte wie API-Dokumentationen, Blogbeiträge und Forumsdiskussionen. Sie können eigene Inhalte bereitstellen und die Darstellung der einzelnen Inhaltstypen anpassen.
Weitere Informationen finden Sie unter Darstellung anpassen.
Entwicklerportal verwalten
Entwickler verwenden Ihr Entwicklerportal, um auf Ihre API zuzugreifen und sie zu verwenden. Administratoren führen Kontoverwaltungsaufgaben aus, z. B.:
- Anpassen des Registrierungsprozesses für Entwickler, einschließlich Registrierungsfelder, integriertem Captcha und automatischer oder manueller Genehmigung
- Entwickler hinzufügen oder genehmigen 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 dem Entwickler dann automatisch eine E-Mail, dass ein Konto für ihn erstellt wurde.
- Konto eines Entwicklers ändern Administratoren können beispielsweise den Kontostatus des Nutzers von „Aktiv“ in „Blockiert“ ändern oder die Profilinformationen des Entwicklers wie den Namen des Unternehmens ändern.
- Entfernen eines Entwicklers Administratoren können das Konto eines Entwicklers deaktivieren oder löschen.
- Rollen und Berechtigungen zuweisen: Administratoren können einem Entwicklerkonto eine bestimmte Rolle zuweisen. Eine Rolle ist mit verschiedenen Berechtigungen verknüpft, z. B. mit der Berechtigung zum Erstellen von Büchern oder anderen Inhalten. Sie können auch die Berechtigungen ändern, die mit einer Rolle verknüpft sind, oder neue Rollen erstellen.
Weitere Informationen finden Sie unter Nutzerkonten hinzufügen und verwalten.
Zusammenfassung der Funktionen des Entwicklerportals
In der folgenden Tabelle sind die Funktionen des Entwicklerportals zusammengefasst:
| Funktion | Details |
|---|---|
| Unterstützte Browser |
Weitere Informationen finden Sie unter Unterstützte Software und unterstützte Versionen. |
|
Nutzerregistrierung |
|
|
Nutzerverwaltung |
|
|
Darstellung des Portals |
|
|
Inhalte und Community verwalten |
|
|
Berechtigungen |
|
|
Verwalten von API-Schlüsseln |
|
|
|
|
|
Blogs |
|
|
Foren |
|
|
Dokumentation |
|
|
Menus |
|
|
Suchen |
|
|
Linkprüfung |
|