Edge for Private Cloud Version 4.19.01
Monetarisierungsdienste sind eine Erweiterung von Apigee Edge und werden daher nicht als eigenständiger Prozess ausgeführt. Sie wird in jeder vorhandenen Apigee Edge-Konfiguration mit Ausnahme der All-in-One-Konfiguration (AIO) ausgeführt. Sie können keine Monetarisierungsdienste in einer AIO-Konfiguration installieren.
Monetarisierungsanforderungen
- Wenn Sie die Monetarisierung in einer Edge-Topologie installieren, in der mehrere Management Server-Knoten verwendet werden (z. B. eine Installation mit 13 Knoten), müssen Sie vor der Installation der Monetarisierung beide Edge Management Server-Knoten installieren.
- Zum Installieren der Monetarisierung in Edge, wenn die Edge-Installation mehrere Postgres-Knoten hat, müssen die Postgres-Knoten im Master-/Standby-Modus konfiguriert werden. 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 bei der All-In-One-Konfiguration (AIO) nicht verfügbar.
Installation
Die folgenden Schritte veranschaulichen, wie Monetarisierungsdienste auf einer vorhandenen Apigee Edge-Installation hinzugefügt werden:
- Verwenden Sie das Dienstprogramm
apigee-setup
, um den Knoten des Apigee-Verwaltungsservers zu aktualisieren und Monetarisierungsdienste zu aktivieren, z. B. die Katalogverwaltung, Limits und Benachrichtigungen, die Abrechnung und die Berichterstellung.Wenn Sie mehrere Management Server-Knoten haben, z. B. eine Installation mit 13 Knoten, müssen Sie vor der Installation der Monetarisierung beide Edge Management Server-Knoten installieren.
- Aktualisieren Sie mit dem Dienstprogramm
apigee-setup
den Apigee Message Processor, um die Laufzeitkomponenten der Monetarisierungsdienste zu aktivieren, z. B. die Richtlinie zur Transaktionsaufzeichnung und die Erzwingung von Einschränkungen. Wenn du mehrere Message Processor hast, installiere die Monetarisierung auf allen. - Führen Sie den Onboardingprozess für die Monetarisierung für Ihre Edge-Organisationen durch.
- Konfigurieren Sie das Apigee Developer Services-Portal (oder einfach das Portal) für die Monetarisierung. Weitere Informationen findest du unter Konfigurieren der Monetarisierung im Entwicklerportal.
Im Hintergrund erstellte Konfigurationsdatei für die Monetarisierung erstellen
Unten sehen Sie ein Beispiel einer stillen Konfigurationsdatei für eine Monetarisierungsinstallation. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option „-f“, um „setup.sh“ zu aktivieren, um diese Datei einzubeziehen.
# Edge configuration properties # Specify IP address or DNS name of node. IP1=192.168.1.1 # Management Server, OpenLDAP, 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. # 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 diese hinzu. Für die Monetarisierung ist ein SMTP-Server erforderlich.
- In der Installation eines einzelnen Rechenzentrums werden alle ZooKeeper-Knoten standardmäßig als Leader konfiguriert. Wenn Sie Edge in mehreren Rechenzentren installieren, werden einige ZooKeeper-Knoten als Beobachter konfiguriert. Achten Sie darauf, dass die obige ZK_HOSTS-Eigenschaft 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 mithilfe der folgenden Attribute übergeben:
CASS_USERNAME CASS_PASSWORD
Integration der Monetarisierungsdienste in alle Verwaltungsserver
Gehen Sie so vor, um die Monetarisierung auf Verwaltungsserverknoten zu integrieren.
- Wenn Sie die Monetarisierung in einer Edge-Topologie installieren, die mehrere Verwaltungsserver-Knoten verwendet (z. B. eine Installation mit 13 Knoten), müssen Sie vor der Installation der Monetarisierung beide Verwaltungsserver-Knoten installieren.
- Führen Sie auf dem Verwaltungsserver-Knoten das Einrichtungsskript aus:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
Mit der Option
-p mo
wird die Integration der Monetarisierung festgelegt.Die Konfigurationsdatei muss für den „apigee“-Benutzer zugänglich oder lesbar sein.
- Wenn Sie die Monetarisierung auf mehreren Verwaltungsserver-Knoten installieren, wiederholen Sie Schritt 2 auf dem zweiten Verwaltungsserver-Knoten.
Nach erfolgreicher Konfiguration wird in der PostgreSQL-Datenbank ein RDBMS-Schema für Monetarisierungsdienste erstellt. Damit ist die Integration der Monetarisierungsdienste und der zugehörigen Komponenten in den Postgres-Server abgeschlossen.
Integration der Monetarisierungsdienste in alle Nachrichtenverarbeiter
Führen Sie die folgenden Schritte aus, um die Monetarisierung auf allen Message Processor-Knoten zu integrieren.
- Führen Sie auf dem ersten Message Processor-Knoten an der Eingabeaufforderung das Einrichtungsskript aus:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
Mit der Option
-p mo
wird die Integration der Monetarisierung festgelegt.Die Konfigurationsdatei muss für den „apigee“-Benutzer zugänglich oder lesbar sein.
- Wiederholen Sie diesen Vorgang auf allen Message Processor-Knoten.
Nach erfolgreicher Konfiguration wird der Message Processor mit Monetarisierungsdiensten aktualisiert. Damit ist die Integration der Monetarisierungsdienste und der zugehörigen Komponenten in die Nachrichtenprozessoren abgeschlossen.
Onboarding für die Monetarisierung
So erstellst du eine neue Organisation und aktivierst die Monetarisierung:
- Erstellen Sie die Organisation wie jede neue Organisation auch. Weitere Informationen finden Sie unter Organisation aufnehmen.
- Verwende die Monetarisierungsbereitstellungs-API, wie unter Monetarisierung für eine Organisation aktivieren beschrieben. Dazu benötigen Sie Systemadministratorberechtigungen.
Wenn Sie sich das nächste Mal bei der Edge-Benutzeroberfläche anmelden, sehen Sie den Eintrag „Monetarisierung“ im Menü der obersten Ebene für die Organisation:
Informationen zur Konfiguration des Portals für die Monetarisierung findest du unter Konfigurieren der Monetarisierung im Entwicklerportal.
Verwaltungsserver-Knoten zu einer Monetarisierungsinstallation hinzufügen
Wenn Sie einer vorhandenen Edge-Installation einen Verwaltungsserver hinzufügen, müssen Sie dem neuen Verwaltungsserver Monetarisierungsdienste hinzufügen und alle Verwaltungsserver konfigurieren, damit sie kommunizieren können.
So fügen Sie einen Verwaltungsserver hinzu:
- Installieren Sie den neuen Verwaltungsserver.
- Installieren Sie die Monetarisierung auf dem neuen Managementserver.
- Rufen Sie auf dem ursprünglichen Verwaltungsserver Folgendes auf:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- Starten Sie den ursprünglichen Verwaltungsserver neu:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- Rufen Sie auf dem neuen Verwaltungsserver Folgendes auf:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- Starten Sie den neuen Verwaltungsserver neu:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
Zusätzliche Konfiguration
Stellen Sie Abrechnungsunterlagen als PDF-Dateien bereit.
Bei der Monetarisierung werden Endnutzern Abrechnungsunterlagen im HTML-Format angezeigt. Wenn Sie Abrechnungsunterlagen als PDF-Dateien zur Verfügung stellen möchten, können Sie die Monetarisierung in ein Abrechnungssystem einbinden, das PDF-Generierung ermöglicht, oder eine unterstützte PDF-Bibliothek eines Drittanbieters lizenzieren.
Organisationseinstellungen konfigurieren
Zum Hinzufügen/Aktualisieren von Organisationsattributen 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
Die Monetarisierung 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". Der Standardwert ist null. |
MINT_CURRENCY
|
ISO-Währungscode (der Standardwert ist null) |
MINT_TAX_NEXUS
|
Nexus (Steuerbesteuerung) (Standardwert ist null) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
Steuerkategorie des Standardprodukts (der Standardwert ist null) |
MINT_IS_GROUP_ORG
|
Organisation der IS-Gruppe (Standard ist „false“) |
MINT_HAS_BROKER
|
Fehlerhaft (Standardeinstellung: false) |
MINT_TIMEZONE
|
Zeitzone (Standardwert ist null) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
Steuernummer (der Standardwert ist null) |
MINT_COUNTRY
|
Land der Organisation (Standardeinstellung ist null) |
MINT_REG_NO
|
Die Registrierungsnummer der Organisation. Das Vereinigte Königreich gibt eine andere Nummer als die Steuernummer an (Standard ist null) |
MINT_BILLING_CYCLE_TYPE
|
"PRORATED", "CALENDAR_MONTH" (Standard ist "CALENDAR_MONTH") |
MINT_SUPPORTED_BILLING_TYPE
|
"PREPAID"/"POSTPAID"/"BOTH" (Standard ist "PREPAID") |
MINT_IS_SEPARATE_INV_FOR_FEES
|
Gibt an, ob eine separate Gebührenrechnung generiert werden soll (Standardeinstellung ist „false“) |
MINT_ISSUE_NETTING_STMT
|
Gibt an, ob eine Netting-Anweisung ausgegeben werden soll (Standardeinstellung ist „false“) |
MINT_NETTING_STMT_PER_CURRENCY
|
Gibt an, ob eine Netting-Anweisung pro Währung generiert werden soll (Standardwert ist „false“) |
MINT_HAS_SELF_BILLING
|
Gibt an, ob die Organisation die Selbstabrechnung verwendet (Standardeinstellung ist „false“) |
MINT_SELF_BILLING_FOR_ALL_DEV
|
Gibt an, ob die Organisation die Selbstabrechnung für alle Entwickler verwendet (Standard ist „false“). |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
Gibt an, ob die Organisation eine separate Rechnung pro Produkt hat (Standard ist „false“) |
MINT_HAS_BILLING_ADJUSTMENT
|
Gibt an, ob die Organisation Rechnungsgutschriften unterstützt (Standardwert ist „false“) |
features.isMonetizationEnabled
|
Wird von der Verwaltungs-UI verwendet, um das Monetarisierungsmenü anzuzeigen (Standard ist „false“) |
ui.config.isOperator
|
Wird von der Verwaltungs-UI verwendet, um den Anbieter als Operator im Vergleich zu Organisation anzuzeigen (Standardeinstellung ist „true“) |
Informationen zum Konfigurieren der Einstellungen einer Unternehmensorganisation über die Verwaltungs-UI finden Sie unter Erste Schritte mit der Monetarisierung.
Einschränkungen bei der Monetarisierung
Um Monetarisierungsbeschränkungen zu erzwingen, hängen Sie die Richtlinie zur Überprüfung der Monetarisierungsbeschränkungen 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 den Tarif nicht abonniert.
- Der Entwickler hat das Transaktionsvolumen für den abonnierten Tarif überschritten.
- Das Prepaidguthaben des Entwicklerkontos oder das Postpaid-Kreditlimit wurde erreicht.
Durch die Richtlinie zur Überprüfung der Monetarisierungslimits werden Fehler gemeldet und API-Aufrufe in Situationen wie den oben genannten blockiert. Die Richtlinie erweitert die Richtlinie „Fehler auslösen“ und Sie können die zurückgegebene Nachricht anpassen. Die anwendbaren Bedingungen werden von Geschäftsvariablen abgeleitet.
Weitere Informationen finden Sie unter Monetarisierungsbeschränkungen für API-Proxys erzwingen.