Google 會運用 AI 技術將內容翻譯成你偏好的語言，但可能會出錯。

安裝營利服務

營利服務是 Apigee Edge 的擴充功能，因此不會以獨立程序的形式執行。它可在任何現有的 Apigee Edge 設定中執行，但 All-In-One (AIO) 設定除外。您無法在 AIO 設定上安裝營利服務。

營利規定

如果您要在使用多個管理伺服器節點 (例如 13 節點安裝) 的 Edge 拓撲上安裝營利功能，則必須先安裝兩個 Edge 管理伺服器節點，再安裝營利功能。
如要在 Edge 安裝 Monetization，且 Edge 安裝作業有多個 Postgres 節點，則必須在主節點/待機模式中設定 Postgres 節點。如果您有多個 Postgres 主節點，就無法在 Edge 上安裝營利功能。詳情請參閱「為 Postgres 設定主要/待命複製功能」。
營利功能不適用於 All-In-One (AIO) 設定。

安裝總覽

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

使用 apigee-setup 公用程式更新 Apigee 管理伺服器節點，啟用營利服務，例如目錄管理、限制和通知設定、帳單和報表。
如果您有多個管理伺服器節點 (例如 13 節點安裝)，則必須先安裝兩個 Edge 管理伺服器節點，再安裝營利功能。
使用 apigee-setup 公用程式更新 Apigee 訊息處理器，啟用營利服務的執行階段元件，例如交易記錄政策和限制強制執行。如果您有多個訊息處理器，請在所有訊息處理器上安裝營利功能。
為 Edge 組織執行營利新手上路程序。
設定 Apigee Developer Services 入口網站 (或簡稱「入口網站」) 以支援營利功能。詳情請參閱「在開發人員入口網站中設定營利功能」。

建立 Monetization 的自動設定檔

以下是 Monetization 安裝作業的靜默設定檔範例。請視需要編輯這個檔案，以符合您的設定。使用 setup.sh 的 -f 選項加入這個檔案。

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

將營利服務與所有管理伺服器整合

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

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

設定檔必須可供「apigee」使用者存取或讀取。
如果您要在多個管理伺服器節點上安裝營利功能，請在第二個管理伺服器節點上重複步驟 2。

設定成功後，系統會在 PostgreSQL 資料庫中建立營利服務的 RDBMS 結構定義。這樣就完成了營利服務及其相關元件與 Postgres 伺服器的整合。

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

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

在第一個訊息處理器節點的命令提示字元中，執行設定指令碼：
```
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
```
-p mo 選項會指定整合營利功能。

設定檔必須可供「apigee」使用者存取或讀取。
在所有訊息處理器節點上重複執行這項程序。

設定成功後，訊息處理器會更新為營利服務。這樣就完成了營利服務及其相關元件與訊息處理器的整合。

營利功能新手上路

如要建立新組織並啟用營利功能：

按照建立新機構的方式建立機構。詳情請參閱「將組織加入平台」。
按照「為機構啟用營利功能」一文所述，使用營利佈建 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`	指出是否應核發淨額結算對帳單 (預設為「false」)
`MINT_NETTING_STMT_PER_CURRENCY`	指出是否應依貨幣產生淨額對帳單 (預設為「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 呼叫。這項政策會擴充 Raise Fault 政策，您可以自訂傳回的訊息。適用條件衍生自業務變數。

詳情請參閱「對 API Proxy 實施營利限制」。