Instalowanie usług zarabiania

Edge for Private Cloud w wersji 4.16.05

Usługi zarabiania to rozszerzenie Apigee Edge, dlatego nie działa jako samodzielny proces. Działa w ramach dowolnej istniejącej konfiguracji Apigee Edge.

Wymagania dotyczące zarabiania

  • Jeśli instalujesz funkcję zarabiania w topologii brzegowej, która korzysta z wielu serwerów zarządzania węzłów, takich jak instalacja z 13 węzłami, musisz zainstalować oba węzły serwera zarządzania brzegiem przed zainstalowaniem funkcji Zarabianie.
  • Aby zainstalować Monetyzację w Edge, gdy instalacja Edge ma wiele węzłów Postgres, węzły Postgres muszą być skonfigurowane w trybie głównym/w trybie gotowości. Nie możesz zainstalować Monetization na Edge, jeśli masz wiele węzłów głównych Postgres. Więcej informacji znajdziesz w artykule Konfigurowanie replikacji typu master-standby w Postgres.

Omówienie instalacji

Aby dodać usługi zarabiania w dotychczasowej instalacji Apigee Edge:

  • Użyj narzędzia apigee-setup, aby zaktualizować węzeł serwera zarządzania Apigee i włączyć usługi zarabiania, na przykład zarządzanie katalogiem, konfigurację limitów i powiadomień oraz raportowanie i obsługę płatności.

    Jeśli masz wiele węzłów serwera zarządzania, na przykład instalację z 13 węzłami, musisz zainstaluj oba węzły serwera zarządzania brzegiem przed zainstalowaniem funkcji zarabiania.
  • Użyj narzędzia apigee-setup do zaktualizowania procesora wiadomości Apigee, aby włączyć komponenty w czasie wykonywania usług generowania przychodów, na przykład zasady rejestrowania transakcji i egzekwowania limitów. Jeśli masz wiele usług przetwarzania wiadomości, zainstaluj funkcję zarabiania na wszystkich z nich.
  • Przeprowadź proces wdrażania funkcji zarabiania w organizacjach Edge.
  • Skonfiguruj portal usług dla deweloperów tak, aby obsługiwał zarabianie. Więcej informacji: http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Tworzę plik konfiguracji cichej dla instancji Zarabianie

Poniżej znajduje się przykładowy plik konfiguracji w trybie cichym dla instalacji funkcji zarabiania. Edytuj zgodnie z potrzebami konfiguracji. Aby dołączyć ten plik, użyj opcji -f, aby utworzyć plik setup.sh.

Uwaga: zwykle dodajesz te właściwości do tego samego pliku konfiguracji, który użyty do zainstalowania Edge, zgodnie z instrukcjami w sekcji Zainstaluj Edge w węźle.

# 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
Uwagi:
  • Jeśli plik konfiguracji Edge nie zawiera informacji o SMTP, dodaj je. Zarabianie wymaga serwera SMTP.
  • W przypadku instalacji w pojedynczym centrum danych wszystkie węzły ZooKeeper są domyślnie skonfigurowane jako węzły główne. Podczas instalowania Edge w wielu centrach danych niektóre węzły ZooKeeper zostaną skonfigurowane jako obserwatorzy. Upewnij się, że usługa ZK_HOSTS powyżej określa węzeł główny w instalacji z wieloma centrami danych.
  • Jeśli włączysz uwierzytelnianie Cassandra, możesz przekazać nazwę użytkownika i hasło Cassandra, używając tych właściwości:
    CASS_USERNAME
    CASS_PASSWORD

Integracja usług umożliwiających generowanie przychodu ze wszystkimi serwerami zarządzania

Aby zintegrować zarabianie na węzłach serwera zarządzania, wykonaj podaną niżej procedurę.

  1. Jeśli instalujesz Monetyzację w topologii Edge, która korzysta z wielu węzłów serwera zarządzania, na przykład z 13 węzłami, przed zainstalowaniem Monetyzacji upewnij się, że zainstalowano oba węzły serwera zarządzania.
  2. Na węźle serwera zarządzania uruchom skrypt konfiguracji:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Opcja „-p mo” określa integrację zarabiania.

    Plik konfiguracji musi być dostępny lub czytelny dla „apigee” użytkownika. Na przykład umieść plik z katalogu /tmp. w węźle.
  3. Jeśli instalujesz Monetyzację na wielu węzłach serwera zarządzania, powtórz krok 2 na drugim węźle serwera zarządzania.

Po udanej konfiguracji w bazie danych PostgreSQL zostanie utworzony schemat RDBMS dla usług zarabiania. Na tym kończy się integracja usług zarabiania i powiązanych z nimi usług z Postgres Server.

Integracja usług zarabiania ze wszystkimi procesorami wiadomości

Skorzystaj z poniższej procedury, aby zintegrować zarabianie na wszystkich urządzeniach obsługujących wiadomości węzłów.

  1. Na pierwszym węźle usługi Message Processor uruchom w wierszu poleceń skrypt konfiguracji:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Opcja „-p mo” umożliwia integrację z Monetyzacją.

    Plik konfiguracji musi być dostępny lub czytelny dla „apigee” użytkownika. Umieść na przykład plik w katalogu /tmp w węźle.
  2. Powtórz tę procedurę na wszystkich węzłach usługi Message Processor.

Po pomyślnej konfiguracji usługa Message Processor zostanie zaktualizowana o usługi zarabiania. W ten sposób zakończysz integrację usług generowania przychodów i powiązanych z nimi komponentów z procesorami wiadomości.

Wprowadzanie w zarabianiu

Aby utworzyć nową organizację z włączonym zarabianiem, najpierw utwórz organizację w taki sam sposób jak każdą inną nową organizację. Więcej informacji znajdziesz w artykule Rejestrowanie organizacji.

Dodatkowe informacje o włączaniu zarabiania w organizacji

Aby ukończyć proces wdrażania organizacji w zakresie zarabiania, musisz:

  1. Utwórz grupę generującą przychody: mxgroup.
  2. Dodaj Qpid do grupy.
  3. Włącz zarabianie w organizacji.
  4. Włącz ustawienia powiadomień dla organizacji.
  5. Powtórz te czynności dla wszystkich organizacji, w których chcesz włączyć zarabianie.

Użyj przycisku enable-monetization. aby wykonać wszystkie te zadania. Skrypt ten pobiera plik konfiguracji zawierający tych właściwości:

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.

Uwagi:

  • Ustaw parametry CASS_HOSTS i REGION na te same wartości, które zostały użyte podczas instalacji funkcji Monetyzacja.
  • Jeśli włączasz funkcję zarabiania w konfiguracji z wieloma centrami danych:
    • Musisz powtórzyć proces wdrażania na serwerze zarządzającym w każdym centrum danych.
    • Plik konfiguracji powinien zawierać tylko węzły Qpid w konfigurowanym centrum danych.

Aby uruchomić skrypt:

  1. Uruchom skrypt:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    Plik konfiguracji musi być dostępny lub czytelny dla użytkownika „apigee”. Na przykład umieść plik z katalogu /tmp. w węźle.

    Jeśli masz wiele serwerów zarządzania, musisz uruchomić ten skrypt tylko na jednym z nich.

    Ten skrypt powiela organizację, usługi, deweloperów i aplikacje z bazy danych Cassandra do bazy danych PostgreSQL Monetization. Po pomyślnym zainstalowaniu funkcji Monetization. Usługi, do których dane są synchronizowane automatycznie.
  2. Powtórz tę procedurę w przypadku każdej organizacji, w której chcesz włączyć zarabianie.
  3. Jeśli korzystasz z wielu centrów danych, powtórz ten proces na karcie Zarządzanie serwer w drugim centrum danych. Upewnij się, że plik konfiguracji zawiera tylko węzły Qpid w skonfigurowanym centrum danych.

Gdy następnym razem zalogujesz się w interfejsie Edge, w menu najwyższego poziomu organizacji zobaczysz pozycję Monetyzacja:

Konfiguracja programisty Portal usług

Aby skonfigurować portal Usługi dla deweloperów, aby obsługiwał zarabianie, zapoznaj się z informacjami na stronie http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Dodawanie węzła serwera zarządzania do instalacji generującej przychody

Jeśli dodasz serwer zarządzania do istniejącej instalacji Edge, musisz dodać usługi zarabiania do nowego serwera zarządzania i skonfigurować wszystkie serwery zarządzania, aby mogły się komunikować.

Aby dodać serwer zarządzania:

  1. Zainstaluj nowy serwer zarządzania.
  2. Zainstaluj funkcję zarabiania na nowym serwerze zarządzania.
  3. Na pierwotnym serwerze zarządzania wywołaj:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Ponownie uruchom pierwotny serwer zarządzania:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Na nowym serwerze zarządzania wywołaj to polecenie:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-mgmt-cluster
  6. Uruchom ponownie nowy serwer zarządzający:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Dodatkowa konfiguracja

Prześlij dokumenty rozliczeniowe jako Pliki PDF

Funkcja generowania przychodu wyświetla użytkownikom dokumenty rozliczeniowe w formacie HTML. Aby podać informacje rozliczeniowe dokumenty jako pliki PDF, można zintegrować funkcję Generowanie przychodu z systemem rozliczeniowym, który obsługuje pliki PDF generowanie lub licencjonowanie obsługiwanej biblioteki PDF innej firmy;

Konfigurowanie ustawień organizacji

Ustawienia backendu: w tabeli poniżej znajdziesz atrybuty na poziomie organizacji, które są dostępne do skonfigurowania organizacji menniczej. Do dodawania/aktualizowania tych elementów można używać wywołania PUT jak poniżej:

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

Na przykład wynik powyższego polecenia CURL będzie wyglądać tak:

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

Atrybuty

Opis

MINT_TAX_MODEL

Akceptowane wartości to: DISCLOSED,

UNDISCLOSED, HYBRID (domyślnie wartość null)

MINT_CURRENCY

Kod ISO waluty (domyślnie ma wartość null)

MINT_TAX_NEXUS

obecność fizyczna w zakresie podatków (domyślnie wartość null);

MINT_DEFAULT_PROD_TAX_CATEGORY

Domyślna kategoria podatku od produktów (domyślnie wartość null)

MINT_IS_GROUP_ORG

Organizacja grupy IS (wartość domyślna to false)

MINT_HAS_BROKER

Jest uszkodzony (domyślnie to fałsz)

MINT_TIMEZONE

Strefa czasowa (wartość domyślna to wartość null)

MINT_TAX_ENGINE_EXTERNAL_ID

Identyfikator mechanizmu podatkowego (domyślnie puste)

MINT_COUNTRY

Kraj organizacji (wartość domyślna to wartość null)

MINT_REG_NO

Numer rejestracyjny organizacji w Wielkiej Brytanii podaje inny numer niż identyfikator podatkowy (wartość domyślna to wartość null)

MINT_BILLING_CYCLE_TYPE

PRORATED, CALENDAR_MONTH (domyślna jest CALENDAR_MONTH)

MINT_SUPPORTED_BILLING_TYPE

PREPAID/POSTPAID/BOTH (domyślnie PREPAID)

MINT_IS_SEPARATE_INV_FOR_FEES

Wskazuje, czy ma zostać wygenerowana osobna faktura za opłatę (wartość domyślna to false)

MINT_ISSUE_NETTING_STMT

Wskazuje, czy powinna zostać wystawiona instrukcja dodawania sieci (domyślnie jest to fałsz)

MINT_NETTING_STMT_PER_CURRENCY

Wskazuje, czy należy generować oświadczenie o rozliczeniu według waluty (wartość domyślna to false).

MINT_HAS_SELF_BILLING

Wskazuje, czy organizacja rozlicza się samodzielnie (wartość domyślna to fałsz)

MINT_SELF_BILLING_FOR_ALL_DEV

Wskazuje, czy organizacja ma włączone samodzielne rozliczanie dla wszystkich deweloperów (wartość domyślna to false).

MINT_HAS_SEPARATE_INV_FOR_PROD

Wskazuje, czy organizacja ma oddzielną fakturę na produkt (domyślnie jest to fałsz).

MINT_HAS_BILLING_ADJUSTMENT

Wskazuje, czy organizacja obsługuje korekty płatności (wartość domyślna to false)

features.isMonetizationEnabled

Używany przez interfejs zarządzania do wyświetlania menu dotyczącego zarabiania (wartość domyślna to false).

ui.config.isOperator

Używany przez interfejs zarządzania do wyświetlania dostawcy jako Operatora lub Organizacji

(wartość domyślna to prawda)

Informacje o konfigurowaniu ustawień organizacji biznesowych za pomocą interfejsu zarządzania znajdziesz na stronie http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Uwaga: jeśli korzystasz z limitów usług zarabiania i powiadomień poinstruuj swoich programistów, aby dołączyli zasady dotyczące limitów w procesie serwera proxy po zasad weryfikacji tokenów dostępu.

Limity to wyraźne zasady, które mają blokować wywołania interfejsu API po osiągnięciu określonego limitu. Zasada sprawdza limity firmy i wywołuje błąd, jeśli jakiekolwiek limity przekraczają skonfigurowaną wartość. Jest to rozszerzenie zasady zgłaszania błędów, ale warunki są ustalane od zmiennych biznesowych.

Szablon interfejsu użytkownika jest dostępny w interfejsie zarządzania dla deweloperów proxy. Deweloper proxy powinien dołączać zasady tworzenia wiadomości. Po wykonaniu tej zasady zostanie zgłoszona usterka z odpowiedzią zgodnie z zasadami. Jeśli parametr ContinueOnError ma wartość Prawda, błąd nie zostanie zgłoszony, a zmienna przepływu „mint.limitsViolated”, „mint.isDeveloperSuspended” i „mint.limitsPolicyError” zostaną ustawione. W razie potrzeby można ich użyć do dalszego obsługiwania wyjątków.