Instalowanie usług zarabiania

Usługi generowania przychodu to rozszerzenie Apigee Edge, dlatego nie działają one jako samodzielna usługa. proces tworzenia konta. Działa w ramach dowolnej istniejącej konfiguracji Apigee Edge, z wyjątkiem konfiguracji All-In-One (AIO) konfiguracji. Nie możesz zainstalować usług zarabiania w konfiguracji AIO.

Wymagania dotyczące zarabiania

  • Jeśli instalujesz funkcję zarabiania w topologii brzegowej, która używa 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ć funkcję Monetization on Edge, w której instalacja Edge ma wiele węzłów Postgres, węzły Postgres muszą być skonfigurowane w trybie mastera/standby. Nie możesz zainstalować funkcji zarabiania na Edge, jeśli masz wiele węzłów głównych Postgres. Więcej informacji: Skonfiguruj replikację w trybie Głównym dla serwera Postgres,
  • Generowanie przychodu jest niedostępne w konfiguracji All-In-One (AIO).

Omówienie instalacji

Poniższe kroki pokazują, jak dodać usługi zarabiania do istniejącej już Apigee Edge instalacja:

  • Użyj narzędzia apigee-setup, aby zaktualizować węzeł serwera zarządzania Apigee do włączyć usługi zarabiania, np. zarządzanie katalogiem, limity i powiadomienia; konfiguracji, rozliczeń i raportowania.

    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 funkcji apigee-setup w celu zaktualizowania procesora wiadomości Apigee w celu włączenia komponentów środowiska wykonawczego usługi generowania przychodu, np. zasady rejestrowania transakcji i egzekwowanie limitów. Jeśli masz kilka procesorów wiadomości, we wszystkich zainstaluj funkcję zarabiania.
  • Przeprowadź proces wdrażania funkcji zarabiania w organizacjach Edge.
  • Skonfiguruj portal usług dla deweloperów Apigee (lub po prostu portal), aby w pełni korzystać z możliwości zarabiania. Więcej informacji: Skonfiguruj zarabianie w portalu dla programistów.

Tworzenie pliku konfiguracji dyskretnej na potrzeby generowania przychodu

Poniżej znajduje się przykładowy plik konfiguracji cichej instalacji służącej do generowania przychodu. Edytuj zgodnie z potrzebami konfiguracji. Aby dołączyć ten plik, użyj opcji -f, aby utworzyć plik setup.sh.

# 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>"

Uwagi:

  • Jeśli plik konfiguracyjny Edge nie zawiera informacji SMTP, dodaj je. Aby zarabiać, musisz: Serwer SMTP.
  • W jednej instalacji centrum danych wszystkie węzły ZooKeeper są domyślnie skonfigurowane jako przywódcom. Jeśli instalujesz Edge w wielu centrach danych, niektóre węzły ZooKeeper być skonfigurowana jako obserwatorzy. Upewnij się, że powyższa właściwość ZK_HOSTS określa węzeł wiodący w instalacja z wieloma centrami danych.
  • Po włączeniu uwierzytelniania Cassandra możesz przekazywać nazwę użytkownika i hasło Cassandra przy użyciu tych właściwości:
    CASS_USERNAME
    CASS_PASSWORD

Integracja usług do generowania przychodów ze wszystkimi serwerami zarządzania

Aby zintegrować zarabianie w węzłach serwera zarządzania, wykonaj czynności opisane poniżej.

  1. Jeśli instalujesz funkcję zarabiania w topologii brzegowej, która używa wielu serwerów zarządzania takich jak instalacja z 13 węzłami, sprawdź, czy zainstalowano oba serwery zarządzania. węzłów przed zainstalowaniem funkcji zarabiania.
  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, czy chcesz zintegrować zarabianie.

    Plik konfiguracji musi być dostępny lub czytelny dla „apigee” użytkownika.

  3. Jeśli instalujesz funkcję Zarabianie na wielu węzłach serwera zarządzania, powtórz krok 2 na drugi węzeł serwera zarządzania.

Po udanej konfiguracji schemat RDBMS dla usług zarabiania jest tworzony w bazy danych PostgreSQL. W ten sposób zakończymy integrację usług zarabiania i powiązanych z nimi usług z Postgres Server.

Integracja usług zarabiania ze wszystkimi systemami przetwarzania wiadomości

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

  1. W wierszu polecenia w pierwszym węźle procesora wiadomości uruchom skrypt konfiguracji:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Opcja -p mo określa, czy chcesz zintegrować zarabianie.

    Plik konfiguracji musi być dostępny lub czytelny dla „apigee” użytkownika.

  2. Powtórz tę procedurę na wszystkich węzłach procesora wiadomości.

Po udanej konfiguracji procesor wiadomości zostaje zaktualizowany o usługi zarabiania. Ten kończy integrację usług zarabiania i powiązanych z nimi komponentów z Wiadomością. Procesory.

Wprowadzenie do zarabiania

Aby utworzyć nową organizację i włączyć zarabianie:

  1. Utwórz organizację tak samo jak każdą nową organizację. Więcej informacji: Zarejestruj organizację.
  2. Użyj interfejsu API do zarządzania monetyzacją, postępując zgodnie z opisem w tym artykule: Włącz dla organizacji. Aby to zrobić, zwróć się do administratora systemu uprawnień.

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

Aby skonfigurować portal do obsługi zarabiania, przeczytaj sekcję Konfigurowanie zarabiania w portalu dla programistów.

Dodawanie węzła serwera zarządzania do instalacji funkcji Zarabianie

Jeśli dodasz serwer zarządzania do istniejącej instalacji Edge, musisz dodać do generowania przychodu z nowego serwera zarządzania i skonfiguruj wszystkie serwery zarządzania tak, aby które mogą się komunikować.

Aby dodać serwer zarządzania:

  1. Zainstaluj nowy serwer zarządzania.
  2. Zainstaluj funkcję zarabiania na nowym serwerze zarządzania.
  3. Na oryginalnym serwerze zarządzania wywołaj następujące polecenie:
    /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. Ponownie uruchom nowy serwer zarządzania:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Dodatkowa konfiguracja

Przesyłanie dokumentów rozliczeniowych w postaci plików 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;

Skonfiguruj ustawienia organizacji

Aby dodać lub zaktualizować atrybuty organizacji, możesz użyć żądania PUT w następujący sposób przykład pokazuje:

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

W odpowiedzi na pytanie o generowanie przychodu używane są ustawienia organizacji. Na przykład:

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

Poniższa tabela zawiera atrybuty na poziomie organizacji, których można użyć do skonfigurowania tworzenia organizacji.

Atrybuty Opis
MINT_TAX_MODEL

Akceptowane wartości to „DISCLOSED”, „UNDISCLOSED”, „HYBRID” (wartość domyślna to wartość null)

MINT_CURRENCY

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

MINT_TAX_NEXUS

Zakład podatkowy (wartość domyślna to wartość null)

MINT_DEFAULT_PROD_TAX_CATEGORY

Domyślna kategoria podatkowa produktu (wartość domyślna to wartość null)

MINT_IS_GROUP_ORG

Organizacja grupy udziału w wyświetleniach (domyślnie „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 silnika podatkowego (wartość domyślna to wartość null)

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” (wartość domyślna to „CALENDAR_MONTH”)

MINT_SUPPORTED_BILLING_TYPE

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (wartość domyślna to „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 ma zostać wystawiona instrukcja nettingu (domyślnie jest to „false”)

MINT_NETTING_STMT_PER_CURRENCY

Wskazuje, czy zestawienie netto ma być generowane dla poszczególnych walut (domyślnie jest to „false”)

MINT_HAS_SELF_BILLING

Wskazuje, czy organizacja rozlicza się samodzielnie (wartość domyślna to „false”)

MINT_SELF_BILLING_FOR_ALL_DEV

Wskazuje, czy organizacja samodzielnie rozlicza wszystkich deweloperów (domyślnie jest „false”)

MINT_HAS_SEPARATE_INV_FOR_PROD

Wskazuje, czy organizacja ma oddzielną fakturę na produkt (domyślnie jest to „false”)

MINT_HAS_BILLING_ADJUSTMENT

Wskazuje, czy organizacja obsługuje wyrównania płatności (domyślnie jest „false”)

features.isMonetizationEnabled

Używany przez interfejs zarządzania do wyświetlania menu dotyczącego zarabiania (domyślnie jest to „false”)

ui.config.isOperator

Używane przez interfejs zarządzania do wyświetlania dostawcy jako operatora jako organizacji (domyślnie jest „true”)

Informacje o konfigurowaniu ustawień organizacji za pomocą interfejsu zarządzania znajdziesz w artykule Jak zacząć korzystać z funkcji zarabiania

Limity zarabiania

Aby egzekwować limity zarabiania, do serwerów proxy interfejsów API dodaj zasadę Sprawdzanie limitów zarabiania. W szczególności zasada jest wyzwalana, gdy są spełnione te warunki:

  • Deweloper, który uzyskuje dostęp do interfejsu API monetyzacji, nie jest zarejestrowany lub nie subskrybuje stawki .
  • Deweloper przekroczył liczbę transakcji w ramach subskrybowanego abonamentu.
  • Saldo konta programisty opłacone z góry lub limit kredytu po wykonaniu usługi zostało osiągnięte.

Zasada sprawdzania limitów zarabiania powoduje błędy i blokuje wywołania interfejsu API w takich sytuacjach: tych wymienionych powyżej. Rozszerza tę zasadę i umożliwia dostosowanie wiadomości . Odpowiednie warunki są określane na podstawie zmiennych biznesowych.

Więcej informacji znajdziesz w sekcji Egzekwowanie zasad limity zarabiania na serwerach proxy API.