營利服務是 Apigee Edge 的擴充功能,因此無法做為獨立程序執行。這項工具會在任何現有的 Apigee Edge 設定中執行,但 All-In-One (AIO) 設定除外。您無法在 AIO 設定中安裝營利服務。
營利規定
- 如果要在使用多個管理伺服器節點的 Edge 拓撲中安裝 營利 (例如安裝 13 個節點),則必須先安裝這兩個 Edge Management Server 節點,才能安裝 Monetization。
- 如要在 Edge 中安裝 Monetization,並在 Edge 中安裝多個 Postgres 節點,您必須在主要/待命模式下設定 Postgres 節點。如果您有多個 Postgres 主要節點,就無法在 Edge 上安裝 營利服務。詳情請參閱設定 Postgres 的主要待命複製功能一文。
- 使用全方位 (AIO) 設定無法營利。
安裝總覽
下列步驟說明如何在現有的 Apigee Edge 安裝項目中新增營利服務:
- 使用
apigee-setup
公用程式更新 Apigee 管理伺服器節點來啟用營利服務,例如目錄管理、限制和通知設定、帳單和報表。如果您有多個管理伺服器節點 (例如 13 個節點安裝),則必須先安裝這兩個 Edge Management Server 節點,才能安裝營利服務。
- 使用
apigee-setup
公用程式更新 Apigee 訊息處理器,以便啟用「營利服務」的執行階段元件,例如交易記錄政策以及限制強制執行。如果您有多個訊息處理器,請全數安裝「營利」工具。 - 為 Edge 機構執行營利新手上路流程。
- 設定 Apigee 開發人員服務入口網站 (或簡稱為入口網站),以支援營利。詳情請參閱在開發人員入口網站中設定營利功能的說明。
建立無聲的營利設定檔
以下為營利安裝的無訊息設定檔範例。根據您的設定,視需要編輯這個檔案。使用 -f 選項來設定 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>"
注意:
- 如果 Edge 設定檔未指定 SMTP 資訊,請新增這項資訊。營利服務需要 SMTP 伺服器。
- 安裝單一資料中心時,根據預設,所有 ZooKeeper 節點都設為主要節點。在多個資料中心安裝 Edge 時,系統會將某些 ZooKeeper 節點設為觀察器。確認上方的 ZK_HOSTS 屬性在安裝多個資料中心時指定主要節點。
- 如果您啟用 Cassandra 驗證,可以透過下列屬性傳遞 Cassandra 使用者名稱和密碼:
CASS_USERNAME CASS_PASSWORD
將營利服務與所有管理伺服器整合
請按照下列程序整合管理伺服器節點的營利功能。
- 如果要在使用多個管理伺服器節點的 Edge 拓撲中安裝 營利 (例如安裝 13 個節點),請務必先安裝這兩個管理伺服器節點,然後再安裝營利服務。
- 在 Management Server 節點上執行設定指令碼:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
-p mo
選項會指定整合「營利」功能。設定檔必須可供「apigee」使用者存取或讀取。
- 如果要在多個管理伺服器節點中安裝營利服務,請在第二個管理伺服器節點上重複執行步驟 2。
成功設定後,系統會在 PostgreSQL 資料庫中建立營利服務的 RDBMS 結構定義。這樣就能完成營利服務及其相關元件與 Postgres Server 的整合作業。
整合營利服務與所有訊息處理器
請按照下列程序整合所有訊息處理器節點的營利功能。
- 在第一個訊息處理器節點上,在命令提示字元中執行設定指令碼:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
-p mo
選項會指定整合「營利」功能。設定檔必須可供「apigee」使用者存取或讀取。
- 對所有訊息處理器節點重複執行這項程序。
成功設定後,「訊息處理者」會更新營利服務。這個動作會完成營利服務及其與訊息處理器的關聯元件。
營利新手上路
如何建立新機構並啟用營利功能:
- 建立機構的方式與建立任何新機構一樣。詳情請參閱「建立機構」一文。
- 按照「為機構啟用營利功能」一文的說明使用 monetization Provisioning API。如要這麼做,您必須具備系統管理員權限。
您下次登入 Edge UI 時,會在機構的頂層選單中看到「營利」項目:
如要設定入口網站以支援營利,請參閱在開發人員入口網站設定營利功能。
將管理伺服器節點新增至營利安裝服務
如果將管理伺服器新增至現有的 Edge 安裝項目,請務必將營利服務新增至新的管理伺服器,並設定所有管理伺服器,讓伺服器能夠進行通訊。
如要新增管理伺服器,請按照下列步驟操作:
- 安裝新版管理伺服器。
- 在新的管理伺服器上安裝營利。
- 在「原始」管理伺服器上呼叫以下內容:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- 重新啟動「原始」管理伺服器:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- 在新版管理伺服器上,呼叫以下內容:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- 重新啟動新版管理伺服器:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
其他設定
以 PDF 檔案格式提供帳單文件
營利計畫會以 HTML 格式向使用者顯示帳單文件。如要以 PDF 檔案提供帳單文件,您可以將營利功能與提供 PDF 產生文件的帳單系統整合,或是取得支援第三方 PDF 程式庫的授權。
調整機構設定
如要新增/更新機構屬性,您可以使用 PUT
要求,如以下範例所示:
curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \ -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT
營利狀態則取決於機構的設定。例如:
{ ... "displayName": "Orgnization name", "name": "org4", "properties": { "property": [ ... { "name": "MINT_CURRENCY", "value": "USD" }, { "name": "MINT_COUNTRY", "value": "US" }, { "name": "MINT_TIMEZONE", "value": "GMT" } ] } }
下表列出可用於設定 Mint 機構的機構層級屬性。
屬性 | 說明 |
---|---|
MINT_TAX_MODEL
|
可接受的值為「DISCLOSED」、「UNDISCLOSED」、「HYBRID」(預設值為空值) |
MINT_CURRENCY
|
ISO 貨幣代碼 (預設為空值) |
MINT_TAX_NEXUS
|
課稅關聯 (預設為空值) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
預設產品稅目 (預設為空值) |
MINT_IS_GROUP_ORG
|
IS 群組機構 (預設為「false」) |
MINT_HAS_BROKER
|
已毀損 (預設為 false) |
MINT_TIMEZONE
|
時區 (預設為空值) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
稅務引擎 ID (預設為空值) |
MINT_COUNTRY
|
機構所在的國家/地區 (預設值為空值) |
MINT_REG_NO
|
組織的登記編號,英國提供的編號與稅號不同 (預設值為空值) |
MINT_BILLING_CYCLE_TYPE
|
"PRORATED", "calendar_MONTH" (預設為「calendar_MONTH」) |
MINT_SUPPORTED_BILLING_TYPE
|
"PREPAID"/"POSTPAID"/"BOTH" (預設為「PREPAID」) |
MINT_IS_SEPARATE_INV_FOR_FEES
|
指出是否要另外產生費用應付憑據 (預設為「false」) |
MINT_ISSUE_NETTING_STMT
|
指出是否應核發 Netting 陳述式 (預設為「false」) |
MINT_NETTING_STMT_PER_CURRENCY
|
指出是否應為每個貨幣產生 Netting 陳述式 (預設值為「false」) |
MINT_HAS_SELF_BILLING
|
表示機構是否提供自助計費功能 (預設值為「false」) |
MINT_SELF_BILLING_FOR_ALL_DEV
|
表示機構是否為所有開發人員提供自行計費功能 (預設值為「false」) |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
表示機構組織是否針對每項產品開立獨立的應付憑據 (預設值為「false」) |
MINT_HAS_BILLING_ADJUSTMENT
|
指出機構是否支援帳單調整 (預設值為「false」) |
features.isMonetizationEnabled
|
管理 UI 會使用這個選單顯示營利專屬選單 (預設值為「false」) |
ui.config.isOperator
|
管理 UI 會使用此屬性將提供者顯示為操作者國際機構 (預設值為「true」) |
如要瞭解如何使用管理 UI 設定商家機構設定,請參閱「開始使用營利功能」。
營利限制
如要強制執行營利限制,請將「營利限制檢查」政策附加至 API Proxy。 具體來說,系統會在下列情況下觸發這項政策:
- 存取營利 API 的開發人員尚未註冊或尚未訂閱費率方案。
- 開發人員已超出訂閱費率方案的交易量。
- 開發人員預付帳戶餘額或後付信用額度已達上限。
營利限制檢查政策會在類似上述情況中引發錯誤,並封鎖 API 呼叫。這項政策會擴充「提出錯誤」政策,您可以自訂傳回的訊息。適用條件是取自業務變數。
詳情請參閱「對 API Proxy 強制執行營利限制」。