Schritte zur Einrichtung der Monetarisierung

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X.
info

Hinweis

Bevor Sie die Monetarisierung mit Ihrer Apigee-Organisation verwenden können, müssen Sie die folgenden Voraussetzungen erfüllen:

  • Erstellen Sie ein Apigee Edge-Konto, wie unter Apigee Edge-Konto erstellen beschrieben.
  • Erwerben Sie die Monetarisierung. Edge enthält anfangs nicht die Monetarisierungs-API und integriert die Monetarisierung nicht in die Verwaltungs-UI. Sie müssen die Monetarisierungsfunktion erwerben, um die Monetarisierungs-API und die UI-Komponenten für die Monetarisierung in Edge für Ihre Apigee-Organisation einzubinden.

Nachdem Sie die Monetarisierung erworben haben, müssen Sie die folgenden Aufgaben ausführen:

  • Arbeiten Sie mit dem Apigee-Konfigurationsteam zusammen, um die Ersteinrichtung der Monetarisierung abzuschließen. Weitere Informationen finden Sie unter Ersteinrichtung mit Apigee.
  • Konfigurieren Sie die Monetarisierung. Weitere Informationen finden Sie unter Monetarisierung konfigurieren.
  • Monetarisieren Sie Ihre APIs. Weitere Informationen finden Sie unter APIs monetarisieren.
  • Verwalten Sie die Monetarisierung, indem Sie Berichte erstellen, Kontostände verwalten usw. Weitere Informationen finden Sie unter Monetarisierung verwalten.

Ersteinrichtung mit Apigee

Arbeiten Sie mit dem Apigee Edge-Konfigurationsteam zusammen, um die Ersteinrichtung der Monetarisierung abzuschließen. Basierend auf Ihren Eingaben richtet das Konfigurationsteam Folgendes ein:

  • Ob Ihre Organisation ein Telekommunikationsunternehmen ist.
  • Welchen Abrechnungstyp Sie für Entwickler unterstützen möchten, die Ihre Tarifpakete kaufen: Prepaid, Postpaid oder beides. Weitere Informationen finden Sie unter Prepaid- und Postpaid-Konten.
  • Ob Sie detaillierte oder zusammenfassende Daten aus der Monetarisierung in Ihr Buchhaltungssystem extrahieren möchten und welches Datenformat erforderlich ist.
  • Benutzerdefinierte E-Mail-Antwortadresse. Für E-Mail-Benachrichtigungen zur Monetarisierung die an Unternehmen und Entwickler gesendet werden, ist die Standardadresse noreply@apigee.com konfiguriert. Sie müssen einen benutzerdefinierten Antwortnamen und eine benutzerdefinierte Antwortadresse für Ihre Organisation anfordern.

Das Apigee-Konfigurationsteam führt ein Skript aus, um die Monetarisierung mit Ihrer Organisation und allen Entwicklern, Anwendungen und API-Produkten zu synchronisieren, die Sie mit Apigee Edge erstellt haben. Der Apigee-Support fordert Sie möglicherweise auf, Ihre Organisation in Zukunft zu synchronisieren. Weitere Informationen finden Sie unter Apigee Edge-Daten mit der Monetarisierung synchronisieren. Synchronisieren Sie keine Monetarisierungsdaten, es sei denn, Sie werden von Apigee dazu aufgefordert.

Monetarisierung konfigurieren

In der folgenden Tabelle sind die Schritte zusammengefasst, die zum Konfigurieren der Monetarisierung für Ihre Apigee-Organisation erforderlich sind.
Schritt Beschreibung
Organisationsprofil bearbeiten Im Rahmen der Ersteinrichtung der Monetarisierung richtet das Apigee Edge-Konfigurationsteam Ihr Organisationsprofil ein.

Sie müssen das Organisationsprofil bearbeiten, um gegebenenfalls Informationen zu Ihrer Organisation hinzuzufügen oder zu aktualisieren. Möglicherweise müssen Sie beispielsweise den Abrechnungstyp, die Währungseinstellungen oder das Steuermodell aktualisieren.

Unterstützte Währungen verwalten Im Rahmen der Ersteinrichtung der Monetarisierung gibt das Apigee Edge-Konfigurationsteam die von Ihrer Organisation unterstützten Währungen an und legt die Standardwährung fest.

Sie können die von Ihrer Organisation unterstützten Währungen abrufen und unterstützte Währungen hinzufügen oder löschen (um die von einem Entwickler oder einem Tarifpaket verwendeten Währungen widerzuspiegeln).

Hinweis: Bei der Monetarisierung wird automatisch ein täglicher Job ausgeführt, der den Wechselkurs in US-Dollar für jede unterstützte Währung abruft. Standardmäßig wird der Job jeden Tag um 00:00:01 Uhr ausgeführt. Weitere Informationen finden Sie unter Monetarisierungsjobs planen.

Nutzungsbedingungen angeben Optional können Sie Ihrem Organisationsprofil Nutzungsbedingungen hinzufügen, bevor Sie Tarifpakete veröffentlichen. Nachdem Sie ein Tarifpaket veröffentlicht haben, wird die aktuelle Version der Nutzungsbedingungen im Entwicklerportal angezeigt.

Hinweis: Die Nutzungsbedingungen befinden sich außerhalb Ihres Organisationsprofils. In Ihrem Organisationsprofil geben Sie den Speicherort (öffentliche URL) der Nutzungsbedingungen an. Sie können mehrere Versionen der Nutzungsbedingungen hinzufügen, um Änderungen im Laufe der Zeit widerzuspiegeln.

Monetarisierungslimits erzwingen Hängen Sie die Richtlinie „MonetizationLimitsCheck“ an API-Proxys an, um die Monetarisierungslimits zu erzwingen.

Die Richtlinie wird insbesondere unter den folgenden Bedingungen ausgelöst:

  • Der Entwickler, der auf die monetarisierte API zugreift, ist nicht registriert oder hat kein Abo für das Tarifpaket abgeschlossen.
  • Der Entwickler hat das Transaktionsvolumen für das abonnierte Tarifpaket überschritten.
  • Das Guthaben des Prepaid-Kontos oder das Kreditlimit des Postpaid-Kontos des Entwicklers wurde erreicht.
Benachrichtigungen einrichten Konfigurieren Sie Benachrichtigungen, um Entwickler oder API-Anbieter über ein bestimmtes Ereignis zu informieren, z. B. ein neu veröffentlichtes Tarifpaket.

APIs monetarisieren

Wenn Sie APIs monetarisieren, bündeln Sie ein oder mehrere API-Produkte in einem API-Produktbundle und definieren das zugehörige Tarifpaket.

Ein API-Produktbundle ist für Entwickler erst sichtbar, wenn Sie ein Tarifpaket für das Paket veröffentlichen (mit einem Startdatum, das dem aktuellen Datum oder einem zukünftigen Datum entspricht). Entwickler können ihre Apps nur registrieren, um ein API-Produktbundle zu verwenden, indem sie eines der derzeit gültigen Tarifpakete kaufen. Wenn für ein API-Produktbundle kein veröffentlichtes Tarifpaket vorhanden ist, das derzeit gültig ist, wird das Paket nicht monetarisiert.

In der folgenden Tabelle sind die Schritte zusammengefasst, die zum Monetarisieren Ihrer APIs erforderlich sind.

Schritt Beschreibung
API-Produktbundles verwalten

Erstellen Sie API-Produktbundles, um Ihre API-Produkte zu gruppieren.

Hinweis: In der Classic Edge-UI und der Monetarisierungs-API werden Produktbundles als API-Pakete bezeichnet.

Informationen zum Verwalten von API-Produktbundles mit der API finden Sie unter:

Richtlinie zur Transaktionsaufzeichnung konfigurieren

Konfigurieren Sie die Richtlinie zur Transaktionsaufzeichnung für jedes Ihrer API-Produkte. In der Richtlinie zur Transaktionsaufzeichnung wird festgelegt, was in den Transaktionsdatensätzen für ein API-Produkt erfasst werden soll, einschließlich aller benutzerdefinierten Attribute.

Informationen zum Konfigurieren der Richtlinie zur Transaktionsaufzeichnung mit der API finden Sie unter:

Tarifpakete verwalten und veröffentlichen

Erstellen Sie ein Tarifpaket, um den Monetarisierungsansatz für Ihre APIs zu definieren. Legen Sie beispielsweise fest, ob Sie für die Nutzung Ihrer API einen Pauschalpreis oder einen variablen Preis berechnen.

Informationen zum Verwalten von Tarifpaketen mit der API finden Sie unter:

Veröffentlichtes Tarifpaket kaufen Kaufen Sie ein veröffentlichtes Tarifpaket und lassen Sie ein gekauftes Tarifpaket bei Bedarf ablaufen oder kündigen Sie es mit der API.
Monetarisierung im Entwicklerportal konfigurieren Konfigurieren Sie die Monetarisierung in Ihrem Entwicklerportal, um Entwicklern einen Selfservice-Zugriff auf Tarifpakete, automatische Zahlungsverarbeitung und -abrechnung, Berichte, Produktkataloge und andere Monetarisierungseinstellungen zu ermöglichen.

Monetarisierung verwalten

Nachdem Sie die Monetarisierung konfiguriert und Ihre API monetarisiert haben, können Sie einen oder mehrere der in der folgenden Tabelle zusammengefassten Schritte ausführen:

Schritt Beschreibung
Unternehmen und Entwickler verwalten Verwalten Sie die Unternehmen und Entwickler, die Ihre APIs verwenden. Ein Entwickler ist eine einzelne Entität, die eindeutig durch die E-Mail-Adresse identifiziert wird. Ein Unternehmen ist eine Gruppe von Entwicklern, die als eine einzelne Entität verwaltet werden.
Berichte erstellen Erstellen Sie Berichte zu Prepaid-Guthaben, Umsatz und Abweichungen. Bei Prepaid-Entwicklern können Sie Berichte zum Prepaid-Guthaben mit Bankeinzahlungen abgleichen.
Abrechnungsanpassungen vornehmen Nehmen Sie Abrechnungsanpassungen vor, um beispielsweise Abweichungen in Ihren Aufzeichnungen zu korrigieren.
Gutschriften ausstellen Stellen Sie bei Bedarf Gutschriften für Entwickler aus. Bei einem Prepaid-Entwickler wird eine Gutschrift als Reduzierung der Nutzung angezeigt, wodurch sich das Prepaid-Guthaben des Entwicklers erhöht. Bei einem Postpaid-Entwickler wird eine Gutschrift als separate Zeile in einer Rechnung angezeigt, wodurch die Gebühr in einer Rechnung reduziert wird.
Prepaid-Guthaben verwalten Sehen Sie sich das aktuelle Prepaid-Guthaben an und laden Sie Prepaid-Konten auf oder richten Sie das automatische Aufladen über einen Drittanbieter für Zahlungen ein.
Postpaid-Guthaben mit Kreditlimits verwalten Wenn Sie eine unterstützte Währung für eine Organisation hinzufügen, können Sie ein Kreditlimit für einen Postpaid-Entwickler festlegen. Das Kreditlimit gilt für alle Postpaid-Entwickler in der Organisation. Außerdem können Sie das Kreditlimit für einen einzelnen Postpaid-Entwickler festlegen. In diesem Fall überschreibt das Kreditlimit alle für die Währung festgelegten Limits nur für den angegebenen Entwickler.
Erstattungen buchen Buchen Sie Erstattungen für Kaufvorgänge für Entwickler.
Monetarisierungsjobs planen Die Monetarisierung bietet einen Jobplaner und eine Reihe von Jobs, die für die Ausführung zu bestimmten Zeiten geplant sind. Verwalten Sie den Zeitplan für Monetarisierungsjobs mit der API.
Status von Transaktionen ansehen Sehen Sie sich den Status von Transaktionen an, die in einem bestimmten Zeitraum stattgefunden haben, mit der API an.
Apigee Edge-Daten mit der Monetarisierung synchronisieren Wenn Sie von Apigee dazu aufgefordert werden, synchronisieren Sie die Daten noch einmal mit der Monetarisierung, um sicherzustellen, dass die Daten synchron sind. Sie können Folgendes synchronisieren: Organisation, API-Produkte, Entwickler und Anwendungen.
Monetarisierungsdaten aus Ihrer Organisation löschen Möglicherweise möchten Sie Monetarisierungsdaten aus Ihrer Organisation löschen, um eine Testorganisation zu löschen oder eine Organisation zu löschen.