Unterstützung der Monetarisierung durch Azure API Management

GILT FÜR: Alle API Management-Ebenen

Mit der Azure API-Verwaltungsdienstplattform können Sie:

Veröffentlichen Sie APIs, für die Ihre Verbraucher abonniert sind.
Risikominderung bei der Implementierung.
Beschleunigen Sie Projektzeitpläne.
Skalieren Sie Ihre APIs mit Vertrauen.

In diesem Dokument konzentrieren wir uns auf API-Verwaltungsfeatures, die die Implementierung Ihrer Monetarisierungsstrategie ermöglichen, z. B. eine reibungslose Erfahrung für:

Entdecken Sie Ihre öffentlichen APIs.
Geben Sie Zahlungsdetails ein.
Aktivieren eines Abonnements.
Nutzen Sie die API.
Überwachen sie die Nutzung.
Automatische Bezahlung für die Verwendung der API.

Im folgenden Diagramm werden die folgenden wichtigsten API-Verwaltungsfeatures vorgestellt:

API-Ermittlung

Starten Sie Ihre API und integrieren Sie API-Verbraucher mithilfe des integrierten Entwicklerportals der API-Verwaltung. Betonen Sie gute Qualitätsentwicklungsinhalte für das Entwicklerportal, sodass API-Verbraucher Ihre APIs nahtlos erkunden und verwenden können. Testen Sie die Inhalte und Informationen auf Barrierefreiheit, Gründlichkeit und Benutzerfreundlichkeit.

Informationen zum Hinzufügen von Inhalten und Steuern des Brandings des Entwicklerportals finden Sie im Überblick über das Entwicklerportal.

API-Paketierung

Mit der API-Verwaltung können Sie verwalten, wie Ihre APIs mithilfe des Konzepts von Produkten und Richtlinien verpackt und präsentiert werden.

Products

APIs werden über Produkte veröffentlicht. Mit Produkten können Sie Folgendes definieren:

Auf welche APIs ein Abonnent zugreifen kann.
Bestimmte Einschränkungsrichtlinien, z. B. das Einschränken eines bestimmten Abonnements auf ein Kontingent von Anrufen pro Monat.

Wenn ein API-Consumer ein Produkt abonniert, erhält er einen API-Schlüssel, den er zum Tätigen von Aufrufen verwenden kann. Zunächst wird das Abonnement auf einen submitted Status festgelegt. Aktivieren Sie das Abonnement, damit Abonnenten die APIs verwenden können.

Sie können die API-Verwaltungsprodukte so konfigurieren, dass sie Ihre zugrunde liegende API verpacken, um Ihr Umsatzmodell zu spiegeln, mit:

Eine 1:1-Beziehung zwischen den einzelnen Ebenen in Ihrem Umsatzmodell.
Ein entsprechendes API-Verwaltungsprodukt.

Beispielprojekte verwenden API-Management-Produkte als oberstes Mittel zur Kodifizierung der Monetarisierungsstrategie. Die API Management Produkte spiegeln die Ertragsmodelltarife wider und indizieren das jeweilige Preismodell für jeden Tarif. Diese Einrichtung bietet einen flexiblen, konfigurationsgesteuerten Ansatz zur Vorbereitung der Monetarisierungsstrategie.

Politik

Wenden Sie API-Verwaltungsrichtlinien an, um die Dienstqualität für jedes Produkt zu steuern. Beispielprojekte verwenden zwei spezifische Richtlinienfunktionen, um die Dienstqualität im Einklang mit dem Umsatzmodell zu steuern.

Richtlinienfunktion	Description
Kontingent	Definiert die Gesamtanzahl der Aufrufe, die der Benutzer über einen bestimmten Zeitraum an der API tätigen kann, z. B. 100 Aufrufe pro Monat. Sobald der Benutzer das Kontingent erreicht hat, schlagen die Aufrufe der API fehl, und der Aufrufer empfängt einen `403 Forbidden` Antwortstatuscode.
Zinslimit	Definiert die Anzahl der Aufrufe über ein Gleitzeitfenster, das an der API ausgeführt werden kann, z. B. 200 Aufrufe pro Minute. Entwickelt, um Spitzen bei der API-Nutzung zu verhindern, die über die kostenpflichtige Dienstqualität mit dem ausgewählten Produkt hinausgehen. Wenn die Anrufrate überschritten wird, empfängt der Aufrufer einen `429 Too Many Requests` Antwortstatuscode.

Weitere Informationen zu Richtlinien finden Sie unter "Richtlinien in Azure API Management".

API-Verbrauch

Gewähren Sie API-Verbrauchern über Produkte mit API-Abonnements Zugriff auf Ihre APIs.

API-Verbraucher richten API-Abonnements ein, wenn Sie sich für ein bestimmtes API-Verwaltungsprodukt registrieren.
Integrieren Sie den Abonnementprozess mit dem Zahlungsanbieter unter Verwendung der API-Verwaltungsdelegierung.
Nach der erfolgreichen Bereitstellung von Zahlungsdetails erhalten Benutzer Zugriff auf die API mit einem generierten, eindeutigen Sicherheitsschlüssel für das Abonnement.

Weitere Informationen zu Abonnements finden Sie unter Abonnements in Azure API Management.

API-Verwendungsüberwachung

Mithilfe der integrierten Analysen der API-Verwaltung erhalten Sie Einblicke in Ihre API-Nutzung und Leistung. Diese Analysen bieten Berichte von:

API
Geografie
API-Vorgänge
Produkt
Anfrage
Subscription
Uhrzeit
Benutzer

Überprüfen Sie die Analyseberichte regelmäßig, um zu verstehen, wie Ihre Monetarisierungsstrategie von API-Verbrauchern übernommen wird.

Weitere Informationen finden Sie unter Überwachen der API-Verwaltung.

Sicherheit

Steuern Sie die Zugriffsebene für jeden Benutzer auf jedes Produkt mithilfe der Produkte, API-Richtlinien und Abonnements der API-Verwaltung. Verhindern Sie Missbrauch und Missbrauch, indem Sie API-Zugriff auf Abonnementebene gewähren, wenn der Benutzer sich erfolgreich beim Zahlungsanbieter authentifiziert hat, auch wenn das spezifische API-Produkt kostenlos ist.

Einbindung

Erstellen Sie ein nahtloses Monetarisierungserlebnis sowohl über die Front-End- als auch die Back-End-Integration zwischen API Management und Ihrem ausgewählten Zahlungsanbieter. Verwenden Sie die API-Verwaltungsdelegierung für die Front-End-Integration und die REST-API für die Back-End-Integration.

Delegierung

In den Beispielprojekten können Sie die API-Verwaltungsdelegierung verwenden, um benutzerdefinierte Integrationen mit den Partnerzahlungsanbietern vorzunehmen. Die Demo verwendet die Delegierung sowohl für die Anmelde-/Abmelde- als auch für die Produktabonnement-Erfahrungen.

Registrierungs-/Anmeldevorgang

Der Entwickler wählt den Anmelde- oder Registrierungslink im API Management-Entwicklerportal aus.
Der Webbrowser leitet an den Delegierungsendpunkt um (konfiguriert auf einer Seite in der benutzerdefinierten Abrechnungsportal-App).
Die benutzerdefinierte Abrechnungsportal-App bietet eine Benutzeroberfläche zur Anmeldung/Registrierung.
Nach erfolgreicher Anmeldung/Registrierung wird der Benutzer authentifiziert und zurück zur Startseite des API-Verwaltungs-Entwicklerportals umgeleitet.

Ablauf für Produktabonnements

Der Entwickler wählt ein Produkt im API Management-Entwicklerportal aus und wählt die Schaltfläche " Abonnieren " aus.
Der Webbrowser leitet an den Delegierungsendpunkt um (konfiguriert auf einer Seite in der benutzerdefinierten Abrechnungsportal-App).
Die benutzerdefinierte Abrechnungsportal-App:
- Stellt eine benutzeroberfläche dar, die basierend auf dem Zahlungsanbieter (Stripe oder Adyen) konfiguriert ist.
- Führt den Benutzer durch den relevanten Checkout-Prozess.
Der Benutzer wird zurück zur Startseite des API Management-Produkts umgeleitet.
- Das Produkt ist aktiv, und die API-Schlüssel sind verfügbar.

REST API

Verwenden Sie die REST-API für API-Verwaltung, um den Betrieb Ihrer Monetarisierungsstrategie zu automatisieren.

In den Beispielprojekten wird die API programmatisch verwendet:

Rufen Sie API-Verwaltungsprodukte und -richtlinien ab, um eine synchronisierte Konfiguration ähnlicher Konzepte in Zahlungsanbietern wie Stripe zu ermöglichen.
Regelmäßiges Befragen von API Management, um API-Nutzungsmetriken für jedes Abonnement abzurufen und den Abrechnungsprozess zu betreiben.

Weitere Informationen finden Sie in der REST-API-Referenz zur Azure-API-Verwaltung.

DevOps

Implementieren Sie die Versionssteuerung und automatisieren Sie Bereitstellungsänderungen an der API-Verwaltung mithilfe von Azure Resource Manager, einschließlich der Konfiguration von Features, die Ihre Monetarisierungsstrategie implementieren, z. B.:

Products
Politik
Das Entwicklerportal

In Beispielprojekten werden die Azure Resource Manager-Skripts durch eine JSON-Datei erweitert, die das Preismodell jedes API Management-Produkts definiert. Mit dieser Erweiterung können Sie die Konfiguration zwischen API-Verwaltung und dem ausgewählten Zahlungsanbieter synchronisieren. Die gesamte Lösung wird unter einem einzigen Quellcodeverwaltungs-Repository verwaltet, um:

Koordinieren Sie alle Änderungen, die mit der laufenden Weiterentwicklung der Monetarisierungsstrategie verbunden sind, als einheitliche Version.
Führen Sie die Änderungen aus, und folgen Sie den Governance- und Überwachungsanforderungen.

Initialisierung und Bereitstellung

Die API-Verwaltung kann entweder über Folgendes bereitgestellt werden:

Das Azure-Portal
Eine Infrastruktur als Codeansatz mithilfe von Azure Resource Manager-Vorlagen

Freigeben über