Usługi generowania przychodu są rozszerzeniem Apigee Edge, dlatego nie działają jako samodzielny proces. Działa w ramach dowolnej istniejącej konfiguracji Apigee Edge z wyjątkiem konfiguracji All-In-One (AIO). Nie możesz zainstalować Usług zarabiania w konfiguracji AIO.
Wymagania dotyczące zarabiania
- Jeśli instalujesz funkcję Monetization w topologii brzegowej, która korzysta z wielu węzłów serwera zarządzania, na przykład w instalacji z 13 węzłami, przed zainstalowaniem funkcji Zarabianie musisz zainstalować oba węzły serwera zarządzania brzegiem.
- Aby zainstalować funkcję Monetization w Edge, gdy instalacja Edge ma wiele węzłów Postgres, węzły Postgres muszą być skonfigurowane w trybie głównym/gotowym. Nie możesz zainstalować funkcji zarabiania na Edge, jeśli masz wiele węzłów głównych Postgres. Więcej informacji znajdziesz w artykule o konfigurowaniu replikacji głównej stanu gotowości dla Postgres.
- Generowanie przychodu jest niedostępne w konfiguracji uniwersalnej (AIO).
Omówienie instalacji
Poniższe kroki pokazują, jak dodać usługi zarabiania w istniejącej instalacji Apigee Edge:
- Użyj narzędzia
apigee-setup
, aby zaktualizować węzeł serwera zarządzania Apigee w celu włączenia usług zarabiania, takich jak zarządzanie katalogami, konfiguracja limitów i powiadomień, płatności i raportowanie.Jeśli jest wiele węzłów serwera zarządzania, na przykład instalacja z 13 węzłami, przed zainstalowaniem funkcji Monetization musisz zainstalować oba węzły serwera zarządzania brzegiem.
- Za pomocą narzędzia
apigee-setup
zaktualizuj procesor wiadomości Apigee, aby włączyć komponenty środowiska wykonawczego Usług zarabiania, na przykład zasady rejestrowania transakcji i egzekwowanie limitów. Jeśli korzystasz z kilku podmiotów przetwarzających wiadomości, zainstaluj zarabianie na nich wszystkich. - Przeprowadź proces wdrażania funkcji zarabiania w swoich organizacjach Edge.
- Skonfiguruj portal Apigee Developer Services (lub po prostu portal) do obsługi zarabiania. Więcej informacji znajdziesz w artykule o konfigurowaniu zarabiania w portalu dla programistów.
Tworzenie cichego pliku konfiguracji na potrzeby zarabiania
Poniżej znajduje się przykładowy dyskretny plik konfiguracji instalacji z funkcją zarabiania. Zmodyfikuj ten plik zgodnie z potrzebami konfiguracji. Aby dołączyć ten plik, użyj opcji „-f” w pliku 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. Generowanie przychodu wymaga serwera SMTP.
- W pojedynczej instalacji centrum danych wszystkie węzły ZooKeeper są domyślnie skonfigurowane jako węzły wiodące. Gdy instalujesz Edge w wielu centrach danych, niektóre węzły ZooKeeper zostaną skonfigurowane jako obserwatorzy. Sprawdź, czy powyższa właściwość ZK_HOSTS wskazuje węzeł wiodący 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
Integrowanie usług generowania przychodu ze wszystkimi serwerami zarządzania
Wykonaj czynności opisane poniżej, aby zintegrować zarabianie w węzłach serwera zarządzania.
- Jeśli instalujesz funkcję Monetization w topologii brzegowej, która korzysta z wielu węzłów serwera zarządzania, np. w instalacji z 13 węzłami, przed zainstalowaniem funkcji Monetization musisz zainstalować oba węzły serwera zarządzania.
- W 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ę funkcji Zarabianie.Plik konfiguracji musi być dostępny i czytelny dla użytkownika „apigee”.
- Jeśli instalujesz funkcję Zarabianie w wielu węzłach serwera zarządzania, powtórz krok 2 w drugim węźle serwera zarządzania.
Po udanej konfiguracji w bazie danych PostgreSQL tworzony jest schemat RDBMS dla usług zarabiania. Na tym kończy się integracja usług zarabiania i powiązanych z nimi komponentów z serwerem Postgres.
Integrowanie usług zarabiania ze wszystkimi systemami do obsługi wiadomości
Wykonaj poniższe czynności, aby zintegrować zarabianie we wszystkich węzłach procesora wiadomości.
- W pierwszym węźle procesora wiadomości w wierszu poleceń uruchom skrypt konfiguracji:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
Opcja
-p mo
określa integrację funkcji Zarabianie.Plik konfiguracji musi być dostępny i czytelny dla użytkownika „apigee”.
- Powtórz tę procedurę we wszystkich węzłach procesora wiadomości.
Po udanej konfiguracji usługa przetwarzania wiadomości zostanie zaktualizowana do usług zarabiania. Na tym kończy się integracja usług zarabiania i powiązanych z nimi składników z podmiotami przetwarzającymi wiadomości.
Wprowadzenie do zarabiania
Aby utworzyć nową organizację i włączyć zarabianie:
- Utwórz organizację w taki sam sposób jak każdą nową. Więcej informacji znajdziesz w artykule Rejestrowanie organizacji.
- Użyj interfejsu API do zarządzania zarabianiem, jak opisano w artykule Włączanie zarabiania w organizacji. Aby to zrobić, musisz mieć uprawnienia administratora systemu.
Po kolejnym zalogowaniu się w interfejsie Edge zobaczysz w menu najwyższego poziomu wpis Zarabianie:
Aby skonfigurować portal do obsługi zarabiania, zapoznaj się z informacjami o konfigurowaniu zarabiania w portalu dla programistów.
Dodawanie węzła serwera zarządzania do instalacji generującej przychody
Jeśli dodasz serwer zarządzania do istniejącej instalacji brzegowej, musisz dodać do nowego serwera zarządzania usługi generowania przychodu i skonfigurować wszystkie serwery zarządzania tak, aby mogły się komunikować.
Aby dodać serwer zarządzania:
- Zainstaluj nowy serwer zarządzania.
- Zainstaluj funkcję Zarabianie na nowym serwerze zarządzania.
- Na pierwotnym serwerze zarządzania wywołaj to polecenie:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- Ponownie uruchom oryginalny serwer zarządzania:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- Na nowym serwerze zarządzania wywołaj to polecenie:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- 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 plikach PDF
Generowanie przychodu wyświetla użytkownikom dokumenty rozliczeniowe w formacie HTML. Aby udostępnić dokumenty rozliczeniowe w postaci plików PDF, możesz zintegrować funkcję Zarabianie z systemem rozliczeniowym, który generuje pliki PDF lub licencjonuje obsługiwaną bibliotekę PDF innej firmy.
Skonfiguruj ustawienia organizacji
Aby dodać lub zaktualizować atrybuty organizacji, możesz użyć żądania PUT
, jak pokazano w tym przykładzie:
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 funkcja zarabiania wyświetla się zgodnie z ustawieniami 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" } ] } }
W tabeli poniżej znajdziesz atrybuty na poziomie organizacji, których można użyć do konfigurowania organizacji generowania.
Atrybuty | Opis |
---|---|
MINT_TAX_MODEL
|
Akceptowane wartości to „DISCLOSED”, „UNDISCLOSED”, „HYBRID” (domyślnie jest to null). |
MINT_CURRENCY
|
Kod ISO waluty (wartość domyślna to null) |
MINT_TAX_NEXUS
|
Placówka podatkowa (wartość domyślna to null) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
Domyślna kategoria podatku od produktu (wartość domyślna to null) |
MINT_IS_GROUP_ORG
|
Organizacja grupy udziału w wyśw. (domyślnie jest to „false”) |
MINT_HAS_BROKER
|
ma uszkodzoną wartość (wartość domyślna to fałsz), |
MINT_TIMEZONE
|
Strefa czasowa (wartość domyślna to null) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
Identyfikator podatkowy wyszukiwarki (domyślnie jest to wartość null) |
MINT_COUNTRY
|
Kraj organizacji (domyślnie jest to wartość null) |
MINT_REG_NO
|
Numer rejestracyjny organizacji w Wielkiej Brytanii zawiera inny numer niż identyfikator podatkowy (wartość domyślna to null). |
MINT_BILLING_CYCLE_TYPE
|
„PRORATED”, „CALENDAR_MONTH” (wartość domyślna to „CALENDAR_MONTH”) |
MINT_SUPPORTED_BILLING_TYPE
|
"PREPAID"/"POSTPAID"/"BOTH" (domyślnie jest to "PREPAID") |
MINT_IS_SEPARATE_INV_FOR_FEES
|
Wskazuje, czy należy wygenerować oddzielną fakturę za opłatę (wartość domyślna to „false”) |
MINT_ISSUE_NETTING_STMT
|
Wskazuje, czy należy wykonać instrukcję sieciową (wartość domyślna to „false”) |
MINT_NETTING_STMT_PER_CURRENCY
|
Wskazuje, czy instrukcja netowania powinna być wygenerowana dla każdej waluty (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 rozlicza wszystkich deweloperów w imieniu wszystkich deweloperów (wartość domyślna to „false”) |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
Wskazuje, czy organizacja ma oddzielną fakturę za każdą usługę (domyślnie jest to „false”) |
MINT_HAS_BILLING_ADJUSTMENT
|
Wskazuje, czy organizacja obsługuje wyrównania płatności (wartość domyślna to „false”) |
features.isMonetizationEnabled
|
Używane przez interfejs zarządzania do wyświetlania menu konkretnego zarabiania (wartość domyślna to „false”) |
ui.config.isOperator
|
Używane przez interfejs zarządzania do wyświetlania dostawcy jako operator zamiast Organization (domyślnie jest to „true”) |
Informacje o konfigurowaniu ustawień organizacji przy użyciu interfejsu zarządzania znajdziesz w artykule Jak zacząć korzystać z funkcji zarabiania.
Limity zarabiania
Aby egzekwować limity zarabiania, dołącz zasadę sprawdzania limitów zarabiania do serwerów proxy interfejsu API. Zasada jest wyzwalana w następujących sytuacjach:
- Deweloper korzystający z interfejsu API zarabiania nie jest zarejestrowany lub nie ma subskrypcji abonamentu.
- Deweloper przekroczył liczbę transakcji w ramach subskrybowanego abonamentu.
- Osiągnięto limit środków na koncie opłacanych z góry lub po wykonaniu usługi.
Zasada sprawdzania limitów zarabiania zgłasza błędy i blokuje wywołania interfejsu API w sytuacjach opisanych powyżej. Zasada rozszerza zasadę Zgłaszanie błędu i możesz dostosować zwracany komunikat. Odpowiednie warunki są określane na podstawie zmiennych biznesowych.
Więcej informacji znajdziesz w artykule o egzekwowaniu limitów zarabiania na serwerach proxy interfejsów API.