Monetarisierungsdienste installieren

Monetization Services ist eine Erweiterung von Apigee Edge und kann daher nicht als eigenständiges Produkt ausgeführt werden. . Sie kann in allen vorhandenen Apigee Edge-Konfigurationen ausgeführt werden, mit Ausnahme des All-In-One (AIO) Konfiguration. Sie können Monetarisierungsdienste nicht in einer AIO-Konfiguration installieren.

Voraussetzungen für die Monetarisierung

  • Wenn Sie die Monetarisierung auf einer Edge-Topologie installieren, die mehrere Verwaltungsserver verwendet Knoten, z. B. eine Installation mit 13 Knoten, müssen Sie beide Edge-Verwaltungsserver-Knoten installieren bevor Sie die Monetarisierung einrichten.
  • So installieren Sie die Monetarisierung in Edge, wenn die Edge-Installation mehrere Postgres-Knoten hat: Die Postgres-Knoten müssen im Master/Standby-Modus konfiguriert sein. Du kannst die Monetarisierung nicht installieren wenn Sie mehrere Postgres-Masterknoten haben. Weitere Informationen finden Sie unter Master-Standby-Replikation einrichten für Postgres
  • Mit der All-In-One-Konfiguration (AIO) ist die Monetarisierung nicht möglich.

Installation

Die folgenden Schritte veranschaulichen, wie Sie auf einem vorhandenen Apigee Edge Monetarisierungsdienste hinzufügen. Installation:

  • Aktualisieren Sie den Knoten des Apigee Management Server mit dem Dienstprogramm apigee-setup auf die Monetarisierungsdienste zu aktivieren, z. B. Katalogverwaltung, Limits und Benachrichtigungen Konfiguration, Abrechnung und Berichterstellung.

    Wenn Sie mehrere Verwaltungsserverknoten haben, z. B. eine Installation mit 13 Knoten, müssen Sie Installieren Sie beide Edge Management Server-Knoten, bevor Sie die Monetarisierung installieren.

  • apigee-setup verwenden um den Apigee Message Processor zu aktualisieren und die Laufzeitkomponenten des Monetarisierungsdienste, z. B. Richtlinien zur Transaktionsaufzeichnung und Durchsetzung von Limits Wenn Sie mehrere Message Processor haben, installiert 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), um die Monetarisierung zu unterstützen. Weitere Informationen finden Sie unter Konfigurieren Sie die Monetarisierung im Entwicklerportal.

Konfigurationsdatei im Hintergrund für Monetarisierung erstellen

Unten sehen Sie ein Beispiel für eine Konfigurationsdatei einer Installation für eine Monetarisierung im Hintergrund. Bearbeiten wenn dies für Ihre Konfiguration erforderlich ist. Verwenden Sie die Option „-f“ in „setup.sh“, 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.
# 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.
  • In einer einzelnen Rechenzentrumsinstallation werden alle ZooKeeper-Knoten standardmäßig als Führungskräfte. Wenn Sie Edge in mehreren Rechenzentren installieren, werden einige ZooKeeper-Knoten als Beobachter konfiguriert werden. Achten Sie darauf, dass die Eigenschaft ZK_HOSTS oben einen führenden Knoten in in mehreren Rechenzentren installieren.
  • Wenn Sie die Cassandra-Authentifizierung aktivieren, können Sie den Nutzernamen und das Passwort für Cassandra übergeben. mithilfe der folgenden Eigenschaften: 
    CASS_USERNAME
CASS_PASSWORD

Monetarisierungsdienste in alle Verwaltungsserver einbinden

Folgen Sie dem folgenden Verfahren, um die Monetarisierung auf Management Server-Knoten zu integrieren.

  1. Wenn Sie die Monetarisierung auf einer Edge-Topologie installieren, die mehrere Verwaltungsserver verwendet wie bei einer Installation mit 13 Knoten, und vergewissern Sie sich, dass Sie sowohl den Verwaltungsserver bevor Sie die Monetarisierung installieren.
  2. Führen Sie auf dem Knoten des Verwaltungsservers das Setupskript aus:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Mit der Option -p mo legen Sie fest, ob die Monetarisierung integriert werden soll.

    Die Konfigurationsdatei muss vom „Apigee“ zugänglich oder lesbar sein Nutzer.

  3. Wenn Sie die Monetarisierung auf mehreren Management Server-Knoten installieren, wiederholen Sie Schritt 2 auf dem zweiten Management Server-Knoten.

Nach erfolgreicher Konfiguration wird ein RDBMS-Schema für Monetarisierungsdienste im PostgreSQL-Datenbank. Damit ist die Integration der Monetarisierungsdienste und der zugehörigen mit Postgres Server.

Monetarisierungsdienste in alle Nachrichtenverarbeiter einbinden

Verwende das folgende Verfahren, um die Monetarisierung in allen Message Processor zu integrieren Knoten.

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

    Mit der Option -p mo legen Sie fest, ob die Monetarisierung integriert werden soll.

    Die Konfigurationsdatei muss vom „Apigee“ zugänglich oder lesbar sein Nutzer.

  2. Wiederholen Sie diesen Vorgang auf allen Message Processor-Knoten.

Nach erfolgreicher Konfiguration wird der Message Processor mit Monetarisierungsdiensten aktualisiert. Dieses die Integration der Monetarisierungsdienste und der zugehörigen Komponenten in der Nachricht Prozessoren.

Onboarding für die Monetarisierung

So erstellen Sie eine neue Organisation und aktivieren die Monetarisierung:

  1. Erstellen Sie die Organisation wie jede andere neue Organisation. Weitere Informationen finden Sie unter Onboarding für eine Organisation
  2. Verwenden Sie die Monetarisierungsbereitstellungs-API wie in folgendem Artikel beschrieben: Aktivieren Monetarisierung für eine Organisation. Dazu benötigen Sie einen Systemadministrator. Berechtigungen.

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 des Unternehmens:

Informationen zur Konfiguration des Portals für die Monetarisierung finden Sie unter Konfigurieren der Monetarisierung in Entwicklerportal

Verwaltungsserverknoten zu einer Monetarisierungsinstallation hinzufügen

Wenn Sie einen Verwaltungsserver zu einer vorhandenen Edge-Installation hinzufügen, müssen Sie sicherstellen, dass Sie Monetarisierungsdienste auf den neuen Verwaltungsserver umzustellen und alle Verwaltungsserver so zu konfigurieren, dass 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 Verwaltungsserver.
  3. Rufen Sie auf dem ursprünglichen Verwaltungsserver 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 restart
  5. Rufen Sie auf dem neuen Verwaltungsserver 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 restart

Zusätzliche Konfiguration

Stellen Sie Abrechnungsunterlagen als PDF-Dateien zur Verfügung.

Bei der Monetarisierung werden die Abrechnungsunterlagen für Endnutzer im HTML-Format angezeigt. Abrechnungsinformationen eingeben Dokumente als PDF-Dateien verfügbar sind, können Sie die Monetarisierung in ein Abrechnungssystem integrieren, das PDF-Dateien zur Verfügung stellt. eine unterstützte PDF-Bibliothek von Drittanbietern zu erstellen oder zu lizenzieren.

Organisationseinstellungen konfigurieren

Zum Hinzufügen/Aktualisieren von Organisationsattributen können Sie eine PUT-Anfrage wie folgt verwenden: Das Beispiel zeigt:

curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \
  -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT

Bei der Monetarisierung werden die Einstellungen der Organisation berücksichtigt. 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 eines Münzprägeanstalt.

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

Nexus steuerlich (Standardwert ist null)
MINT_DEFAULT_PROD_TAX_CATEGORY

Standard-Produktsteuerkategorie (Standardwert ist null)
MINT_IS_GROUP_ORG

IS-Gruppenorganisation (Standardeinstellung ist „false“)
MINT_HAS_BROKER

Ist fehlerhaft (Standardeinstellung ist „false“)
MINT_TIMEZONE

Zeitzone (Standardwert ist null)
MINT_TAX_ENGINE_EXTERNAL_ID

Steuernummer der Suchmaschine (Standardwert ist null)
MINT_COUNTRY

Land der Organisation (Standardwert ist null)
MINT_REG_NO

Die Registrierungsnummer der Organisation, im Vereinigten Königreich gibt es eine andere Nummer als die Steuernummer (Standardwert ist null)
MINT_BILLING_CYCLE_TYPE

"ANTEILIGE", "KALENDERMONAT" (Standardeinstellung ist "CALENDAR_MONTH")
MINT_SUPPORTED_BILLING_TYPE

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (Standardeinstellung 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 eine Selbstabrechnung hat (Standardeinstellung ist „false“)
MINT_SELF_BILLING_FOR_ALL_DEV

Gibt an, ob die Organisation eine Selbstabrechnung für alle Entwickler hat (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 (Standardwert ist „false“)
features.isMonetizationEnabled

Wird von der Verwaltungsoberfläche verwendet, um ein spezielles Menü für die Monetarisierung anzuzeigen (Standardeinstellung ist „false“)
ui.config.isOperator

Wird von der Verwaltungsoberfläche verwendet, um den Anbieter als Operator im Vergleich zur Organisation anzuzeigen (Standardeinstellung ist „true“)

Informationen zum Konfigurieren der Einstellungen der Unternehmensorganisation über die Verwaltungsbenutzeroberfläche finden Sie unter Einführung in die Monetarisierung

Einschränkungen für die Monetarisierung

Hängen Sie die Richtlinie zur Überprüfung der Monetarisierungslimits an API-Proxys an, um Monetarisierungslimits durchzusetzen. Insbesondere wird die Richtlinie unter den folgenden Bedingungen ausgelöst:

  • Der Entwickler, der auf die monetarisierte API zugreift, ist nicht registriert oder hat die Rate nicht abonniert zu erstellen.
  • Der Entwickler hat das Transaktionsvolumen für den abonnierten Tarif überschritten.
  • Das Prepaid-Kontoguthaben oder das nachträgliche Kreditlimit des Entwicklers wurde erreicht.

Die Richtlinie zur Überprüfung der Monetarisierungslimits löst Fehler aus und blockiert API-Aufrufe in Situationen wie die oben aufgeführten. Die Richtlinie erweitert die Richtlinie für Fehlerbenachrichtigungen und Sie können die Nachricht anpassen zurückgegeben. Die anwendbaren Bedingungen werden aus Geschäftsvariablen abgeleitet.

Weitere Informationen finden Sie unter Erzwingen Monetarisierungslimits für API-Proxys.