Monetarisierungsdienste installieren

Edge for Private Cloud Version 4.17.05

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 ausgeführt.

Monetarisierungsanforderungen

  • Wenn Sie die Monetarisierung in einer Edge-Topologie installieren, in der mehrere Verwaltungsserver-Knoten verwendet werden (z. B. eine Installation mit 13 Knoten), müssen Sie vor der Installation der Monetarisierung beide Edge-Verwaltungsserver-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.

Installation

Die folgenden Schritte veranschaulichen, wie Monetarisierungsdienste auf einer vorhandenen Apigee Edge-Installation hinzugefügt werden:

  • Verwenden Sie das Dienstprogramm apigee-setup, um den Apigee-Verwaltungsserver-Knoten zu aktualisieren, um die Monetarisierungsdienste zu aktivieren, z. B. die Katalogverwaltung, Limits und Benachrichtigungen, die Abrechnung und die Berichterstellung.

    Wenn Sie mehrere Verwaltungsserver-Knoten haben, z. B. eine Installation mit 13 Knoten, müssen Sie vor der Installation der Monetarisierung beide Edge-Verwaltungsserver-Knoten installieren.
  • Verwenden Sie das Dienstprogramm apigee-setup, um den Apigee Message Processor zu aktualisieren, um die Laufzeitkomponenten der Monetarisierungsdienste zu aktivieren, z. B. die Richtlinie zur Transaktionsaufzeichnung und die Einschränkung der Erzwingung. 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 Entwicklerdienste-Portal für die Monetarisierung. Weitere Informationen finden Sie unter http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Im Hintergrund verwendete 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.

Hinweis: In der Regel fügen Sie diese Attribute der Konfigurationsdatei hinzu, mit der Sie Edge installiert haben, wie unter Edge-Komponenten auf einem Knoten installieren gezeigt.

# 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 zugehörige Passwort mit den folgenden Attributen übergeben:
    CASS_NUTZERNAME
    CASS_PASSWORT

Monetarisierungsdienste in alle Verwaltungsserver einbinden

Gehen Sie so vor, um die Monetarisierung auf Verwaltungsserverknoten zu integrieren.

  1. 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.
  2. Führen Sie auf dem Management Server-Knoten das Einrichtungsskript aus:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Die Option „-p mo“ gibt an, dass die Monetarisierung integriert werden soll.

    Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein.
  3. 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.

Monetarisierungsdienste in alle Nachrichtenverarbeiter einbinden

Führen Sie die folgenden Schritte aus, um die Monetarisierung auf allen Message Processor-Knoten zu integrieren.

  1. Führen Sie auf dem ersten Message Processor-Knoten an der Eingabeaufforderung das Setup-Skript aus:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Die Option „-p mo“ gibt an, dass die Monetarisierung integriert werden soll.

    Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein.
  2. 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 zur Monetarisierung

Wenn Sie eine neue Organisation mit aktivierter Monetarisierung erstellen möchten, müssen Sie zuerst die Organisation wie jede neue Organisation erstellen. Weitere Informationen finden Sie unter Organisation aufnehmen.

Zusätzliches Onboarding für die Monetarisierung einer Organisation

So kannst du die Monetarisierung für eine Organisation einrichten:

  1. Erstellen Sie die Monetarisierungsgruppe: mxgroup.
  2. Fügen Sie Qpid zur Gruppe hinzu.
  3. Monetarisierung für die Organisation aktivieren.
  4. Benachrichtigungseinstellungen für die Organisation aktivieren.
  5. Wiederholen Sie diesen Vorgang für alle Organisationen, für die Sie die Monetarisierung aktivieren möchten.

Verwende für alle diese Aufgaben den Befehl enable-monetization. Dieses Skript verwendet eine Konfigurationsdatei mit den folgenden Attributen:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

Hinweise:

  • Lege für CASS_HOSTS und REGION dieselben Werte fest, die du bei der Installation der Monetarisierung verwendet hast.
  • Wenn Sie die Monetarisierung in einer Konfiguration mit mehreren Rechenzentren aktivieren:
    • Sie müssen den Onboardingprozess auf dem Management Server in jedem Rechenzentrum wiederholen.
    • Die Konfigurationsdatei sollte nur die Qpid-Knoten im konfigurierten Rechenzentrum auflisten.

So führen Sie das Skript aus:

  1. Rufen Sie das Skript auf:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    Die Konfigurationsdatei muss für den Benutzer „apigee“ zugänglich sein oder gelesen werden können.

    Wenn Sie mehrere Verwaltungsserver haben, müssen Sie das Skript nur auf einem davon ausführen.

    Dieses Skript repliziert die Organisation, Produkte, Entwickler und Anwendungen aus der Cassandra-Datenbank in die PostgreSQL-Datenbank für die Monetarisierung. Nach erfolgreicher Installation der Monetarisierungsdienste werden die Daten automatisch synchronisiert.
  2. Wiederholen Sie diesen Vorgang für jede Organisation, in der Sie die Monetarisierung aktivieren möchten.
  3. Wenn Sie sich in einer Umgebung mit mehreren Rechenzentren befinden, wiederholen Sie diesen Vorgang auf dem Management Server im anderen Rechenzentrum. Die Konfigurationsdatei darf nur die Qpid-Knoten im konfigurierten Rechenzentrum enthalten.

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:

Portal für Entwicklerdienste konfigurieren

Informationen zum Konfigurieren des Developer Services-Portals für die Unterstützung der Monetarisierung finden Sie unter http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

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:

  1. Installieren Sie den neuen Verwaltungsserver.
  2. Installieren Sie die Monetarisierung auf dem neuen Managementserver.
  3. Rufen Sie auf dem ursprünglichen Management Server Folgendes auf:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-Mint-management-server mint-configure-mgmt-cluster
  4. Starten Sie den ursprünglichen Verwaltungsserver neu:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-Management-Server-Neustart
  5. Rufen Sie auf dem neuen Management Server Folgendes auf:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-Mint-management-server mint-configure-mgmt-cluster
  6. Starten Sie den neuen Verwaltungsserver neu:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-Management-Server-Neustart

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

Back-End-Einstellungen: In der folgenden Tabelle sind die Attribute auf Organisationsebene aufgeführt, die zum Konfigurieren einer Mint-Organisation verfügbar sind. Mit einem PUT-Aufruf können Sie diese Attribute wie unten gezeigt hinzufügen/aktualisieren:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

Die Ausgabe des obigen CURL-Befehls sieht in etwa so aus:

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

Attributes

Beschreibung

MINT_TAX_MODEL

Zulässige Werte sind DISCLOSED,

UNDISCLOSED, HYBRID (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 (Standardeinstellung: „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 erstellt 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(Standardeinstellung 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 Rechnungsgutschriften unterstützt (Standardeinstellung ist „false“)

features.isMonetizationEnabled

Wird von der Verwaltungsoberfläche verwendet, um ein Monetarisierungsmenü anzuzeigen (Standardeinstellung 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 mithilfe der Verwaltungs-UI finden Sie unter http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Hinweis: Wenn Sie die Limits für Monetarisierungsdienste und Benachrichtigungsfunktionen verwenden, bitten Sie Ihre Entwickler, nach der Validierungsrichtlinie des Zugriffstokens eine Beschränkungsrichtlinie im Proxyablauf anzuhängen.

Die Limit-Richtlinie ist eine explizite Richtlinie, die entwickelt wurde, um einen API-Aufruf zu blockieren, wenn ein bestimmtes Limit erreicht wurde. Die Richtlinie prüft Geschäftslimits und löst einen Fehler aus, wenn Limits den konfigurierten Wert überschreiten. Dies ist eine Erweiterung der Richtlinie zum Auslösen von Fehlern, aber die Bedingungen werden von Geschäftsvariablen abgeleitet.

In der Verwaltungsoberfläche ist eine UI-Vorlage für Proxy-Entwickler verfügbar. Der Proxy-Entwickler sollte eine Mint-Richtlinie an den Nachrichtenfluss anhängen. Beim Ausführen dieser Richtlinie wird der Fehler mit der Fehlerantwort gemäß der Richtlinie ausgelöst. Wenn ContinueOnError auf „true“ gesetzt ist, wird der Fehler nicht ausgelöst und die Variablen „mint.limitsViolated“, „mint.isDevelopersuspended“ und „mint.limitsPolicyError“ werden festgelegt, die bei Bedarf für die weitere Ausnahmebehandlung verwendet werden können.