本頁面由 Cloud Translation API 翻譯而成。

安裝營利服務

Private Cloud v. 4.16.05 專用 Edge

營利服務是 Apigee Edge 的延伸功能，因此不會單獨執行上傳資料集之後，您可以運用 AutoML 自動完成部分資料準備工作可在任何現有的 Apigee Edge 設定中執行。

營利相關規定

如果要在使用多個管理伺服器的 Edge 拓撲中安裝營利服務因此，如要安裝 13 個節點等節點，您必須同時安裝這兩個 Edge Management Server 節點再安裝營利功能
如要在 Edge 上安裝營利功能，而 Edge 安裝有多個 Postgres 節點，則必須以主/待機模式設定 Postgres 節點。如果您有多個 Postgres 主節點，就無法在 Edge 上安裝 Monetization。詳情請參閱「設定主待命： Postgres：

安裝總覽

下列步驟說明如何在現有的 Apigee Edge 安裝中新增營利服務：

使用 apigee-setup 公用程式來更新 Apigee 管理伺服器節點以啟用營利服務，例如目錄管理、限制和通知設定、帳單報表。

如果您有多個管理伺服器節點 (例如 13 個節點安裝)，則必須先安裝 Edge 管理伺服器節點，再安裝營利功能。
使用 apigee-setup 公用程式來更新 Apigee 訊息處理器，以便啟用營利服務，例如交易記錄政策和限制強制執行。如果發生以下情況：有多個訊息處理器，請在所有元件上安裝「營利」功能。
為您的 Edge 機構執行營利新手上路流程。
設定支援營利的開發人員服務入口網站。若需更多資訊，請參閲 http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

為營利

以下為營利安裝項目的靜音設定檔範例。視需要編輯這個檔案以設定。使用 -f 選項讓 setup.sh 加入這個檔案。

注意：通常，您會將這些屬性新增至用於安裝 Edge 的相同設定檔，如「在節點上安裝 Edge 元件」所示。

# 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

注意事項：

如果您的 Edge 設定檔未指定 SMTP 資訊，請新增該檔案。如要營利，您必須具備 SMTP 伺服器。
在單一資料中心安裝作業中，所有 ZooKeeper 節點預設為領導者。在多個資料中心安裝 Edge 時，有些 ZooKeeper 節點設為觀察器請確認上述 ZK_HOSTS 屬性已在多個資料中心安裝作業中指定領導節點。
如果啟用 Cassandra 驗證功能，您可以使用下列屬性傳遞 Cassandra 使用者名稱和密碼：
CASS_USERNAME
CASS_PASSWORD

整合營利服務部署伺服器

如要在管理伺服器節點上整合營利功能，請按照下列程序操作。

如果您要在使用多個管理伺服器節點的 Edge 拓撲上安裝營利功能 (例如 13 節點安裝)，請務必先安裝兩個管理伺服器節點，再安裝營利功能。
在管理伺服器節點上執行設定指令碼：
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

「-p mo」選項會指定整合營利功能。

「apigee」使用者必須能存取或讀取設定檔。例如，將檔案放在節點的 /tmp 目錄中。
如果要在多個管理伺服器節點中安裝營利服務，請在以下項目中重複執行步驟 2：建立第二個管理伺服器節點

設定成功後，系統會在 PostgreSQL 資料庫營利服務和相關與 Postgres Server 搭配使用

將營利服務整合至所有訊息處理器

請按照下列程序整合所有訊息處理器的營利功能節點。

在第一個訊息處理器節點的命令提示字元中，執行設定指令碼：
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

「-p mo」選項可指定整合營利方式。

設定檔必須可由「apigee」存取或讀取內容。例如，將 /tmp 目錄中的檔案節點上
對所有訊息處理器節點重複此程序。

設定成功後，訊息處理工具會透過營利服務進行更新。這個完成整合營利服務及其相關元件處理器：

營利新手上路

如要建立新機構並啟用營利功能，請先按照建立任何新機構的方式建立機構。詳情請參閱「為機構加入計畫」。

為機構啟用營利功能的其他新手上路說明

如要完成機構營利的新手上路程序，您必須：

建立營利群組：mxgroup。
將 Qpid 新增至群組。
為機構啟用營利功能。
為機構啟用通知設定。
針對要啟用營利功能的所有機構，重複執行這個程序。

使用 enable-monetization 指令執行所有這些工作。這個指令碼會使用包含下列屬性的設定檔：

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.

注意：

將 CASS_HOSTS 和 REGION 設為您在安裝營利功能時使用的值。
如果您透過多個資料中心設定啟用營利功能：
- 您必須在每一項資料中重複進行新手上路程序中央。
- 設定檔應只列出所要設定資料中心中的 Qpid 節點。

如要執行指令碼，請按照下列步驟操作：

請叫用指令碼：
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

「apigee」使用者必須能存取或讀取設定檔。例如，將檔案放在節點的 /tmp 目錄中。

如果你有多個管理伺服器，只需在其中一個管理伺服器上執行這個指令碼即可。

這個指令碼會從 Cassandra 複製機構、產品、開發人員和應用程式到營利 PostgreSQL 資料庫成功安裝營利功能後系統會自動同步處理資料的服務。
針對您要啟用營利功能的每個機構重複執行這項程序。
如果您使用的是多資料中心環境，請在其他資料中心的管理伺服器上重複執行這項程序。請確認設定檔中只列出正在設定資料中心

下次登入 Edge 使用者介面時，您會在機構的頂層選單中看到「營利」項目：

設定開發人員服務入口網站

如要設定開發人員服務入口網站以支援營利，請參閱 http://apigee.com/docs/monetization/content/configure-monetization-developer-portal。

新增 Management Server 節點藉此營利

如果您在現有的 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 檔案提供帳單文件，您可以將 Monetization 與提供 PDF 產生功能的帳單系統整合，或授權支援的第三方 PDF 程式庫。

設定機構設定

後端設定：下表列出可用於設定鑄造機構的組織層級屬性。你可以使用 PUT 呼叫來新增/更新屬性，如下所示：

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

舉例來說，上述 CURL 指令的輸出內容會如下所示：

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

屬性	說明
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	指出是否應發出對沖報表 (預設為 false)
MINT_NETTING_STMT_PER_CURRENCY	指出是否應依貨幣產生對沖明細 (預設為 false)
MINT_HAS_SELF_BILLING	指出機構是否有自付帳單 (預設為 false)
MINT_SELF_BILLING_FOR_ALL_DEV	表示機構是否開放所有開發人員自行計費(預設為錯誤)
MINT_HAS_SEPARATE_INV_FOR_PROD	指出機構是否針對每項產品開立單獨的發票 (預設為 false)
MINT_HAS_BILLING_ADJUSTMENT	指出機構是否支援帳單調整 (預設為 false)
features.isMonetizationEnabled	管理員介面用於顯示營利相關選單 (預設值為 false)
ui.config.isOperator	管理 UI 會使用這項設定，將提供者顯示為操作者反向機構 (預設值為 true)

如需使用管理 UI 調整業務機構設定，請參閱 http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services。

注意：如果您使用營利服務限制和通知功能，請指示開發人員在存取權存取權杖驗證政策後，在代理程式流程中附加限制政策。

限制政策是明確的政策，旨在在達到特定限制時封鎖 API 呼叫。政策會檢查業務限制，如果發現任何超出上限的情況，會引發錯誤設定好的值這項擴充錯誤政策的擴充內容衍生自。

Proxy 開發人員的管理 UI 中提供了 UI 範本。Proxy 開發人員在訊息流程中附加薄荷政策。執行這項政策時，系統會提出錯誤按照政策顯示錯誤回應。如果將 ContinueOnError 設為 true，即表示錯誤不會增加，且流程變數：「mint.limitsViolated」、「mint.isDevelopersuspended」和「mint.limitsPolicyError」系統會設定變數視需要用於進一步處理例外狀況