Monetization Services ist eine Erweiterung von Apigee Edge und wird daher nicht als eigenständiger Prozess ausgeführt. Es wird in jeder vorhandenen Apigee Edge-Einrichtung ausgeführt, mit Ausnahme der All-in-One-Konfiguration (AIO) Sie können Monetization Services nicht in einer AIO-Konfiguration installieren.
Anforderungen für die Monetarisierung
- Wenn Sie die Monetarisierung in einer Edge-Topologie mit mehreren Management Server Knoten installieren, z. B. in einer Installation mit 13 Knoten, müssen Sie beide Edge Management Server-Knoten installieren, bevor Sie die Monetarisierung installieren.
- Wenn Sie die Monetarisierung in Edge installieren möchten, wobei die Edge-Installation mehrere Postgres-Knoten umfasst, die Postgres-Knoten müssen im Master/Standby-Modus konfiguriert sein. Sie können die Monetarisierung in Edge nicht installieren, wenn Sie mehrere Postgres-Masterknoten haben. Weitere Informationen finden Sie unter Master-Standby-Replikation für Postgres einrichten.
- Die Monetarisierung ist mit der All-in-One-Konfiguration (AIO) nicht verfügbar.
Installation
In den folgenden Schritten wird veranschaulicht, wie Sie Monetization Services zu einer vorhandenen Apigee Edge Installation hinzufügen:
- Verwenden Sie das
apigee-setupDienstprogramm, um den Apigee Management Server-Knoten zu aktualisieren und Monetization Services zu aktivieren, z. B. für die Katalogverwaltung, die Konfiguration von Limits und Benachrichtigungen sowie die Abrechnung und Berichterstellung.Wenn Sie mehrere Management Server-Knoten haben, z. B. in einer Installation mit 13 Knoten, müssen Sie beide Edge Management Server-Knoten installieren, bevor Sie die Monetarisierung installieren.
- Verwenden Sie das
apigee-setupDienstprogramm, um den Apigee Message Processor zu aktualisieren und die Laufzeitkomponenten von den Monetization Services zu aktivieren, z. B. die Richtlinie zur Transaktionserfassung und die Limitdurchsetzung. Wenn Sie mehrere Message Processor haben, installieren Sie die Monetarisierung auf allen. - Führen Sie den Onboarding-Prozess für die Monetarisierung für Ihre Edge-Organisationen aus.
- Konfigurieren Sie das Apigee Developer Services-Portal (oder einfach das Portal) für die Unterstützung der Monetarisierung. Weitere Informationen finden Sie unter Monetarisierung im Entwicklerportal konfigurieren.
Konfigurationsdatei für die unbeaufsichtigte Konfiguration für die Monetarisierung erstellen
Unten sehen Sie ein Beispiel für eine Datei für die unbeaufsichtigte Konfiguration für eine Monetarisierungsinstallation. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option `-f` für setup.sh, um diese Datei einzufügen.
# Edge configuration properties # Specify IP address or DNS name of node. IP1=192.168.1.1 # Management Server, SymasLDAP, New Edge UI, ZooKeeper, Cassandra IP2=192.168.1.2 # ZooKeeper, Cassandra IP3=192.168.1.3 # ZooKeeper, Cassandra IP4=192.168.1.4 # Router, Message Processor IP5=192.168.1.5 # Router, Message Processor IP6=192.168.1.6 # Qpid IP7=192.168.1.7 # Qpid IP8=192.168.1.8 # Postgres IP9=192.168.1.9 # Postgres # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost. HOSTIP=$(hostname -i) # Edge sys admin credentials ADMIN_EMAIL=your@email.com APIGEE_ADMINPW=yourPassword # If omitted, you are prompted for it. # Specify the Management Server port. APIGEE_PORT_HTTP_MS=8080 # # Monetization configuration properties. # # Postgres credentials from Edge installation. PG_USER=apigee # Default from Edge installation PG_PWD=postgres # Default from Edge installation # Specify Postgres server. MO_PG_HOST="$IP8" # Only specify one Postgres node. # Create a Postgres user for Monetization. # Default username is "postgre". # If you specify a different user, that user must already exist. MO_PG_USER=postgre MO_PG_PASSWD=moUserPWord # Specify one ZooKeeper host. # Ensure this is a ZooKeeper leader node in a multi-datacenter environment. ZK_HOSTS="$IP2" # Specify Cassandra information. # Ensure CASS_HOSTS is set to the same value as when you installed Edge. # Must use IP addresses for CASS_HOSTS, not DNS names. CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1" # Default is "Apigee", unless it was changed during Edge install. CASS_CLUSTERNAME=Apigee # Cassandra uname/pword required only if you enabled Cassandra authentication. # If your password uses special characters, wrap it in single quotes. # CASS_USERNAME= # CASS_PASSWORD= # Specify the region. # Default is dc-1 unless you are in a multi-datacenter environment. REGION=dc-1 # If your Edge config file did not specify SMTP information, add it. # Monetization requires an SMTP server. SMTPHOST=smtp.gmail.com SMTPPORT=465 SMTPUSER=your@email.com SMTPPASSWORD=yourEmailPassword SMTPSSL=y SMTPMAILFROM="My Company <myco@company.com>"
Hinweise:
- Wenn in Ihrer Edge-Konfigurationsdatei keine SMTP-Informationen angegeben sind, fügen Sie sie hinzu. Für die Monetarisierung ist ein SMTP-Server erforderlich.
- In einer Installation mit einem einzelnen Rechenzentrum werden standardmäßig alle ZooKeeper-Knoten als Leader konfiguriert. Wenn Sie Edge in mehreren Rechenzentren installieren, werden einige ZooKeeper-Knoten als Observer konfiguriert. Achten Sie darauf, dass das Attribut „ZK_HOSTS“ oben einen Leader-Knoten in einer Installation mit mehreren Rechenzentren angibt.
- Wenn Sie die Cassandra-Authentifizierung aktivieren, können Sie den Cassandra-Nutzernamen und das Passwort
mit den folgenden Attributen übergeben:
CASS_USERNAME CASS_PASSWORD
Monetization Services in alle Management Server einbinden
Gehen Sie so vor, um die Monetarisierung in Management Server-Knoten einzubinden.
- Wenn Sie die Monetarisierung in einer Edge-Topologie mit mehreren Management Server Knoten installieren, z. B. in einer Installation mit 13 Knoten, müssen Sie beide Management Server Knoten installieren, bevor Sie die Monetarisierung installieren.
- Führen Sie auf dem Management Server-Knoten das Setupscript aus:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
Die Option
-p mogibt an, dass die Monetarisierung eingebunden werden soll.Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein.
- Wenn Sie die Monetarisierung auf mehreren Management Server-Knoten installieren, wiederholen Sie Schritt 2 auf dem zweiten Management Server-Knoten.
Nach erfolgreicher Konfiguration wird in der PostgreSQL-Datenbank ein RDBMS-Schema für Monetization Services erstellt. Damit ist die Einbindung von Monetization Services und der zugehörigen Komponenten in den Postgres-Server abgeschlossen.
Monetization Services in alle Message Processor einbinden
Gehen Sie so vor, um die Monetarisierung in alle Message Processor Knoten einzubinden.
- Führen Sie auf dem ersten Message Processor-Knoten in der Eingabeaufforderung das Setupscript aus:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
Die Option
-p mogibt an, dass die Monetarisierung eingebunden werden soll.Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein.
- Wiederholen Sie diesen Vorgang auf allen Message Processor-Knoten.
Nach erfolgreicher Konfiguration wird der Message Processor mit Monetization Services aktualisiert. Damit ist die Einbindung von Monetization Services und der zugehörigen Komponenten in die Message Processor abgeschlossen.
Onboarding für die Monetarisierung
So erstellen Sie eine neue Organisation und aktivieren die Monetarisierung:
- Erstellen Sie die Organisation wie jede andere neue Organisation. Weitere Informationen finden Sie unter Organisation einbinden.
- Verwenden Sie die Monetarisierungs-Bereitstellungs-API, wie unter Monetarisierung für eine Organisation aktivieren beschrieben. Dazu benötigen Sie Systemadministrator berechtigungen.
Wenn Sie sich das nächste Mal in der neuen Edge-Benutzeroberfläche anmelden, sehen Sie den Eintrag „Monetarisierung“ im Menü der obersten Ebene für die Organisation:

Informationen zum Konfigurieren des Portals für die Unterstützung der Monetarisierung finden Sie unter Monetarisierung im Entwicklerportal konfigurieren.
Management Server-Knoten zu einer Monetarisierungsinstallation hinzufügen
Wenn Sie einer vorhandenen Edge-Installation einen Management Server hinzufügen, müssen Sie Monetization Services zum neuen Management Server hinzufügen und alle Management Server so konfigurieren, dass sie miteinander kommunizieren können.
So fügen Sie einen Management Server hinzu:
- Installieren Sie den neuen Management Server.
- Installieren Sie die Monetarisierung auf dem neuen Management Server mit dem folgenden Befehl:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f /opt/silent.conf
Zusätzliche Konfiguration
Abrechnungsdokumente als PDF-Dateien bereitstellen
In Monetization Services werden Abrechnungsdokumente für Endnutzer im HTML-Format angezeigt. Wenn Sie Abrechnungs dokumente als PDF-Dateien bereitstellen möchten, können Sie Monetization Services in ein Abrechnungssystem einbinden, das die PDF Generierung unterstützt, oder eine unterstützte PDF-Bibliothek eines Drittanbieters lizenzieren.
Organisationseinstellungen konfigurieren
Wenn Sie Organisationsattribute hinzufügen oder aktualisieren möchten, können Sie eine PUT Anfrage verwenden, wie im folgenden
Beispiel gezeigt:
curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \ -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT
Monetization Services antwortet mit den Einstellungen der Organisation. Beispiel:
{
...
"displayName": "Orgnization name",
"name": "org4",
"properties": {
"property": [
...
{
"name": "MINT_CURRENCY",
"value": "USD"
},
{
"name": "MINT_COUNTRY",
"value": "US"
},
{
"name": "MINT_TIMEZONE",
"value": "GMT"
}
]
}
}In der folgenden Tabelle sind die Attribute auf Organisationsebene aufgeführt, die zum Konfigurieren einer Mint-Organisation verfügbar sind.
| Attribute | Beschreibung |
|---|---|
MINT_TAX_MODEL
|
Zulässige Werte sind „DISCLOSED“, „UNDISCLOSED“ und „HYBRID“ (Standardwert ist „null“). |
MINT_CURRENCY
|
ISO-Währungscode (Standardwert ist „null“) |
MINT_TAX_NEXUS
|
Steuerliche Anknüpfungspunkte (Standardwert ist „null“) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
Standardmäßige Produktsteuerkategorie (Standardwert ist „null“) |
MINT_IS_GROUP_ORG
|
Ist eine Gruppenorganisation (Standardwert ist „false“) |
MINT_HAS_BROKER
|
Hat einen Broker (Standardwert ist „false“) |
MINT_TIMEZONE
|
Zeitzone (Standardwert ist „null“) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
Steuer-Engine-ID (Standardwert ist „null“) |
MINT_COUNTRY
|
Land der Organisation (Standardwert ist „null“) |
MINT_REG_NO
|
Registrierungsnummer der Organisation. Im Vereinigten Königreich wird eine andere Nummer als die Steuernummer angegeben (Standardwert ist „null“). |
MINT_BILLING_CYCLE_TYPE
|
„PRORATED“, „CALENDAR_MONTH“ (Standardwert ist „CALENDAR_MONTH“) |
MINT_SUPPORTED_BILLING_TYPE
|
„PREPAID“ / „POSTPAID“ / „BOTH“ (Standardwert ist „PREPAID“) |
MINT_IS_SEPARATE_INV_FOR_FEES
|
Gibt an, ob eine separate Rechnung für Gebühren erstellt werden soll (Standardwert ist „false“) |
MINT_ISSUE_NETTING_STMT
|
Gibt an, ob eine Aufrechnungsabrechnung ausgestellt werden soll (Standardwert ist „false“) |
MINT_NETTING_STMT_PER_CURRENCY
|
Gibt an, ob eine Aufrechnungsabrechnung pro Währung erstellt werden soll (Standardwert ist "false") |
MINT_HAS_SELF_BILLING
|
Gibt an, ob die Organisation eine Selbstabrechnung hat (Standardwert ist „false“) |
MINT_SELF_BILLING_FOR_ALL_DEV
|
Gibt an, ob die Organisation eine Selbstabrechnung für alle Entwickler hat (Standardwert ist "false") |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
Gibt an, ob die Organisation eine separate Rechnung pro Produkt hat (Standardwert ist "false") |
MINT_HAS_BILLING_ADJUSTMENT
|
Gibt an, ob die Organisation Abrechnungsanpassungen unterstützt (Standardwert ist "false") |
features.isMonetizationEnabled
|
Wird von der neuen Edge-Benutzeroberfläche verwendet, um das Menü für die Monetarisierung anzuzeigen (Standardwert ist "false") |
ui.config.isOperator
|
Wird von der neuen Edge-Benutzeroberfläche verwendet, um den Anbieter als Operator im Vergleich zur Organisation anzuzeigen (Standardwert ist "true") |
Informationen zum Konfigurieren der Einstellungen für Geschäftsorganisationen mit der neuen Edge-Benutzeroberfläche finden Sie unter Erste Schritte mit der Monetarisierung.
Limits für die Monetarisierung
Wenn Sie Limits für die Monetarisierung erzwingen möchten, hängen Sie die Richtlinie „Monetarisierungslimits prüfen“ an API-Proxys an. Die Richtlinie wird unter den folgenden Bedingungen ausgelöst:
- Der Entwickler, der auf die monetarisierte API zugreift, ist nicht registriert oder hat kein Abo für den Tarif
- Der Entwickler hat das Transaktionsvolumen für den abonnierten Tarif überschritten.
- Das Guthaben des Prepaid-Kontos des Entwicklers oder das Kreditlimit des Postpaid-Kontos wurde erreicht.
Die Richtlinie „Monetarisierungslimits prüfen“ löst Fehler aus und blockiert API-Aufrufe in Situationen wie den oben genannten. Die Richtlinie erweitert die Richtlinie „Fehler auslösen“ und Sie können die zurückgegebene Nachricht anpassen. Die anwendbaren Bedingungen werden aus Geschäftsvariablen abgeleitet.
Weitere Informationen finden Sie unter Monetarisierungslimits für API-Proxys erzwingen.