Veröffentlichung – Übersicht

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

Beim Veröffentlichen werden Ihre APIs App-Entwicklern zur Nutzung zur Verfügung gestellt.

Video: Das folgende Video bietet eine allgemeine Einführung in die API-Veröffentlichung.

Das Veröffentlichen von APIs umfasst die folgenden Aufgaben, die in diesem Thema beschrieben werden:

  1. Erstellen Sie die API-Produkte in Edge, die Ihre APIs bündeln.
  2. Registrieren Sie App-Entwickler in Edge.
  3. Registrieren Sie Entwickler-Apps auf Edge.
  4. Stellen Sie Dokumentations- und Community-Support für Ihre APIs zur Verfügung.

Aufgabe 1: API-Produkt in Edge erstellen

Die erste Aufgabe bei der Veröffentlichung ist die Erstellung eines API-Produkts. Ein API-Produkt ist eine Sammlung von API-Ressourcen, die Anwendungsentwicklern als Paket angeboten wird. Erstellen Sie API-Produkte mithilfe der Edge-Management-API oder -Benutzeroberfläche. (Weitere Informationen zu API-Produkten finden Sie unter Was ist ein API-Produkt?).

Ein von links nach rechts verlaufendes Sequenzdiagramm, das einen Entwickler, eine Anwendung, APIs und Back-End-Dienste zeigt. Das API-Symbol und die Ressourcen werden hervorgehoben. Eine gestrichelte Linie weist den Entwickler auf ein Symbol einer vom Entwickler erstellten Anwendung hin. Pfeile von und zurück zur Anwendung zeigen den Anfrage- und Antwortablauf auf ein API-Symbol, wobei der Anwendungsschlüssel über der Anfrage positioniert wird. Das API-Symbol und die Ressourcen werden hervorgehoben. Unter dem API-Symbol befinden sich zwei Gruppen von Ressourcenpfaden, die in zwei API-Produkte gruppiert sind: Standortprodukt und Medienprodukt. Das StandortProdukt enthält Ressourcen für /Länder, /Städte und /Sprachens und das Media-Produkt enthält Ressourcen für /Bücher, /Magazine und /Filme. Rechts neben der API befinden sich die von der API aufgerufenen Back-End-Ressourcen, darunter eine Datenbank, ein Unternehmensdienstbus, Anwendungsserver und ein generisches Back-End.

In dieser Abbildung besteht die API aus zwei Produkten mit jeweils drei API-Ressourcen.

Als API-Anbieter sind Sie dafür verantwortlich, die APIs und API-Produkte für die Zugriffssteuerung, Nutzungsbeschränkungen und andere geschäftliche Anforderungen zu erstellen. Sie können zum Beispiel:

  • Ein kostenloses API-Produkt, das schreibgeschützten Zugriff auf seine API-Ressourcen ermöglicht, veröffentlichen.
  • Ein zweites API-Produkt zu einem niedrigen Preis, das Lese- / Schreibzugriff auf dieselben API-Ressourcen wie die kostenlose Version ermöglicht, jedoch mit einem niedrigen Zugriffslimit, z. B. 1.000 Anfragen pro Tag, veröffentlichen.
  • Ein drittes API-Produkt zu einem höheren Preis, das Lese- / Schreibzugriff auf dieselbe API-Ressource, jedoch mit einem hohen Zugriffslimit ermöglicht, veröffentlichen.

Wichtig ist: Edge bietet Ihnen die Flexibilität, API-Produkte zu erstellen, die den Geschäftsanforderungen Ihrer APIs entsprechen.

Weitere Informationen zum Erstellen von API-Produkten finden Sie unter API-Produkte erstellen.

Aufgabe 2: App-Entwickler in Edge registrieren

Ein Entwickler erstellt die Anwendungen, die Ihre APIs nutzen. Ein App-Entwickler registriert sich bei Apigee Edge, bevor er seine App registrieren kann. Wenn er seine App registriert, erhält er einen API-Schlüssel, mit dem die App auf die API zugreifen kann.

Mit der Anwendungsregistrierung können Sie steuern, wer Zugriff auf Ihre APIs hat. Sie können einen Anwendungsentwickler jederzeit löschen, wodurch alle mit diesem Entwickler verknüpften API-Schlüssel ungültig werden, sodass Sie dem Entwickler den Zugriff auf Ihre APIs verweigern.

Ein von links nach rechts verlaufendes Sequenzdiagramm, das einen Entwickler, eine Anwendung, APIs und Back-End-Dienste zeigt. Das Entwicklersymbol ist hervorgehoben. Eine gestrichelte Linie weist den Entwickler auf ein Symbol einer vom Entwickler erstellten Anwendung hin. Pfeile von und zurück zur Anwendung zeigen den Anfrage- und Antwortablauf auf ein API-Symbol, wobei der Anwendungsschlüssel über der Anfrage positioniert wird. Unter dem API-Symbol befinden sich zwei Gruppen von Ressourcenpfaden, die in zwei API-Produkte gruppiert sind: Standortprodukt und Medienprodukt. Das StandortProdukt enthält Ressourcen für /Länder, /Städte und /Sprachens und das Media-Produkt enthält Ressourcen für /Bücher, /Magazine und /Filme. Rechts neben der API befinden sich die von der API aufgerufenen Back-End-Ressourcen, darunter eine Datenbank, ein Unternehmensdienstbus, Anwendungsserver und ein generisches Back-End.

Als API-Anbieter entscheiden Sie, wie Entwickler registriert werden. Sie können beispielsweise einen manuellen Registrierungsprozess verwenden, bei dem sich ein potenzieller Entwickler zur Registrierung an Ihre Organisation wenden muss. Der potenzielle Entwickler muss alle erforderlichen Informationen angeben, z. B. eine E-Mail-Adresse, einen Vor- und Nachnamen sowie den Namen des Unternehmens. Wenn Sie die Anfrage des Entwicklers genehmigen, können Sie den Entwickler über die Edge-Verwaltungs-UI manuell registrieren. Weitere Informationen finden Sie unter App-Entwickler verwalten.

Apigee bietet außerdem Tools, mit denen Sie den Registrierungsprozess für Entwickler automatisieren können. Beispiel:

  • Verwenden Sie die Apigee Edge-Verwaltungs-API, um Registrierungsfunktionen in Ihre vorhandene Website zu integrieren. Die Edge Management API ist eine REST API, mit der Sie alle Aspekte des Registrierungsprozesses für Entwickler ausführen können. Weitere Informationen finden Sie unter Edge-Verwaltungs-API zum Veröffentlichen von APIs verwenden.
  • Verwenden Sie das Apigee Developer Services-Portal, um Entwickler zu registrieren. Das Portal bietet integrierte Unterstützung für die Entwicklerregistrierung, aber auch viele weitere Features zur Unterstützung Ihrer APIs. Weitere Informationen finden Sie unter Was ist ein Entwicklerportal?.

Aufgabe 3: Entwickler-App in Edge registrieren

Bevor eine App auf Ihre APIs zugreifen kann, muss die App bei Edge registriert werden. Allerdings kann nur ein registrierter Entwickler eine App in Edge registrieren.

Ein von links nach rechts verlaufendes Sequenzdiagramm, das einen Entwickler, eine Anwendung, APIs und Back-End-Dienste zeigt. Die Pfeile für Anwendung, Anfrage/Antwort und API-Schlüssel sind hervorgehoben. Eine gestrichelte Linie weist den Entwickler auf ein Symbol einer vom Entwickler erstellten Anwendung hin. Pfeile von und zurück zur Anwendung zeigen den Anfrage- und Antwortablauf auf ein API-Symbol, wobei der Anwendungsschlüssel über der Anfrage positioniert wird. Das API-Symbol und die Ressourcen werden hervorgehoben. Unter dem API-Symbol befinden sich zwei Gruppen von Ressourcenpfaden, die in zwei API-Produkte gruppiert sind: Standortprodukt und Medienprodukt. Das StandortProdukt enthält Ressourcen für /Länder, /Städte und /Sprachens und das Media-Produkt enthält Ressourcen für /Bücher, /Magazine und /Filme. Rechts neben der API befinden sich die von der API aufgerufenen Back-End-Ressourcen, darunter eine Datenbank, ein Unternehmensdienstbus, Anwendungsserver und ein generisches Back-End.

Bei der Anwendungsregistrierung wählt der Entwickler ein oder mehrere API-Produkte aus. Sie können beispielsweise mehrere API-Produkte veröffentlichen, die den jeweiligen Servicetypen und Preismodellen entsprechen. Der Anwendungsentwickler kann dann aus der Liste der verfügbaren API-Produkte eine Auswahl treffen.

Als Reaktion auf die Registrierung der Anwendung in Edge weist Edge der Anwendung einen eindeutigen API-Schlüssel zu. Die App muss diesen API-Schlüssel als Teil jeder Anfrage an eine API-Ressource übergeben. Der Schlüssel wird authentifiziert und, sofern gültig, die Anfrage gewährt. Als Dienstanbieter können Sie den Schlüssel jederzeit widerrufen, damit die Anwendung nicht mehr auf Ihre APIs zugreifen kann.

Als API-Anbieter entscheiden Sie, wie Sie Anwendungen registrieren möchten. Sie haben folgende Möglichkeiten:

  • Verwenden Sie einen manuellen Prozess, der einen Entwickler benötigt, um Ihre Anwendung zu registrieren. Entsprechend würden Sie dem API-Schlüssel den Entwickler senden, möglicherweise per E-Mail.
  • Verwenden Sie die Edge Management API, um die App-Registrierungsfunktion und die Schlüsselübermittlung in Ihre Website zu integrieren.
  • Verwenden Sie für ein kostenpflichtiges Edge-Konto das Apigee Developer Services-Portal, das integrierte Unterstützung für die Anwendungsregistrierung und die Bereitstellung von API-Schlüsseln bietet.

Weitere Informationen findest du unter Apps registrieren und API-Schlüssel verwalten.

Aufgabe 4: APIs dokumentieren

Eine wichtige Überlegung bei der Veröffentlichung von API-Produkten ist die Bereitstellung von Dokumentation und Feedback-Verfahren für Entwickler. 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 sowie Kundensupportfunktionen.

Ein von links nach rechts verlaufendes Sequenzdiagramm, das einen Entwickler, eine Anwendung, APIs und Back-End-Dienste zeigt. Das Entwicklersymbol ist hervorgehoben. Unter dem Entwickler befindet sich ein Feld für ein Entwicklerportal. Das Portal enthält API-Dokumentation, Beispiele, Anleitungen, API-Referenz und mehr. Das Portal enthält auch Blogs, Foren und ein Supportportal. Eine gestrichelte Linie weist den Entwickler auf ein Symbol einer vom Entwickler erstellten Anwendung hin. Pfeile von und zurück zur Anwendung zeigen den Anfrage- und Antwortablauf auf ein API-Symbol, wobei der Anwendungsschlüssel über der Anfrage positioniert wird. Unter dem API-Symbol befinden sich zwei Gruppen von Ressourcenpfaden, die in zwei API-Produkte gruppiert sind: Standortprodukt und Medienprodukt. Das StandortProdukt enthält Ressourcen für /Länder, /Städte und /Sprachens und das Media-Produkt enthält Ressourcen für /Bücher, /Magazine und /Filme. Rechts neben der API befinden sich die von der API aufgerufenen Back-End-Ressourcen, darunter eine Datenbank, ein Unternehmensdienstbus, Anwendungsserver und ein generisches Back-End.

Sie können Ihre eigene Website erstellen, um Ihre Dokumentation bereitzustellen. Wenn Sie ein kostenpflichtiges Edge-Konto haben, können Sie auch das Apigee Developer Services-Portal verwenden. Das Portal bietet integrierte Dokumentationen, Blogs, Foren und andere Inhalte, die zur Unterstützung Ihrer Entwickler-Community erforderlich sind.

Mit SmartDocs können Sie Ihre APIs im Entwickler Services-Portal so dokumentieren, dass die API-Dokumentation interaktiv ist. Durch die interaktive Dokumentation mit SmartDocs können Portalnutzer Folgendes tun:

  • Informationen zur API
  • Liveanfrage an die API senden
  • Von der API zurückgegebene Live-Antwort ansehen

Die folgende Abbildung zeigt beispielsweise eine API, die mithilfe von SmartDocs im Portal dokumentiert wird. Diese API stellt Wetterinformationen für einen bestimmten Standort bereit:

Ein SmartDocs API-Methodenthema, mit dem Sie eine Wetter API durch Klicken auf eine Schaltfläche im Thema aufrufen können.

Der Entwickler gibt einen Wert für den Abfrageparameter „w“ ein, um den Ort anzugeben, und klickt dann auf die Schaltfläche Anfrage senden, um die Live-Anfrage und -Antwort anzusehen. Wenn Sie eine interaktive Dokumentation zu Ihren APIs erstellen, können Portalnutzer Ihre APIs ganz einfach erlernen, testen und bewerten.

Die Edge Management API ist eine REST API, mit der Sie mit einem beliebigen HTTP-Client auf API-Dienste zugreifen können. Apigee verwendet SmartDocs, um interaktive Dokumentation für die Edge-Verwaltungs-API zu erstellen. Die API-Dokumentation finden Sie hier.

Weitere Informationen finden Sie unter SmartDocs zum Dokumentieren von APIs verwenden.