安裝營利服務

營利服務是 Apigee Edge 的延伸功能,因此不會單獨執行 上傳資料集之後,您可以運用 AutoML 自動完成部分資料準備工作可在任何現有的 Apigee Edge 設定中執行,但萬用 (AIO) 除外 此外還會從 0 自動調整資源配置 您完全不必調整資源調度設定您無法在 AIO 設定上安裝營利服務。

營利相關規定

  • 如果要在使用多個管理伺服器的 Edge 拓撲中安裝營利服務 因此,如要安裝 13 個節點等節點,您必須同時安裝這兩個 Edge Management Server 節點 再安裝營利功能
  • 如要在 Edge 上安裝 Edge 包含多個 Postgres 節點的 Monetization 功能, 必須在主要/待命模式下設定 Postgres 節點。無法安裝營利服務 如果您有多個 Postgres 主要節點,則位於 Edge 上。詳情請參閱 設定以下執行個體的主待命複製功能: Postgres
  • 營利設定不適用於全方位 (AIO) 設定。

安裝總覽

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

  • 使用 apigee-setup 公用程式將 Apigee Management Server 節點更新為 啟用營利服務,例如目錄管理、限制和通知 設定、帳單和報表

    如果您有多個管理伺服器節點 (例如安裝 13 個節點),您必須 請先安裝 Edge Management Server 節點,再安裝營利服務。

  • 使用「apigee-setup」 公用程式來更新 Apigee 訊息處理器,以便啟用 營利服務,例如交易記錄政策和限制強制執行。如果發生以下情況: 有多個訊息處理器,請在所有元件上安裝「營利」功能。
  • 為您的 Edge 機構執行營利新手上路流程。
  • 設定 Apigee Developer Services 入口網站 (或簡稱入口網站),支援營利。若需更多資訊,請參閲 在開發人員入口網站設定營利功能

建立靜音模式的營利設定檔

以下為營利安裝項目的靜音設定檔範例。編輯 檔案。如要加入這個檔案,請使用 -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

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

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

  1. 如果要在使用多個管理伺服器的 Edge 拓撲中安裝營利服務 節點 (例如安裝 13 個節點) 再安裝「營利」
  2. 在 Management Server 節點上執行設定指令碼:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo 選項會指定整合營利服務。

    設定檔必須可由「apigee」存取或讀取內容。

  3. 如果要在多個管理伺服器節點中安裝營利服務,請在以下項目中重複執行步驟 2: 建立第二個管理伺服器節點

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

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

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

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

    -p mo 選項會指定整合營利服務。

    設定檔必須可由「apigee」存取或讀取內容。

  2. 對所有訊息處理器節點重複此程序。

成功設定後,「訊息處理者」會更新為「營利服務」。這個 完成整合營利服務及其相關元件 處理器:

營利新手上路

如何建立新機構組織並啟用營利功能:

  1. 請按照新機構建立機構的方式建立機構。若需更多資訊,請參閲 加入機構
  2. 按照 啟用 藉此營利只有系統管理員才能執行這項操作 權限。

下次登入 Edge UI 時,您會看到 機構:

如要設定入口網站來支援營利功能,請參閱這篇文章: 開發人員入口網站

在營利安裝作業中新增管理伺服器節點

如要在現有 Edge 安裝項目中新增管理伺服器,請務必 使用新版管理伺服器的營利服務,並設定所有管理伺服器, 能夠溝通無礙

如要新增管理伺服器,請按照下列步驟操作:

  1. 安裝新的管理伺服器。
  2. 新版管理伺服器上安裝營利服務。
  3. 在「原始」管理伺服器上,呼叫以下內容:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. 重新啟動原始管理伺服器:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. 新的管理伺服器上,呼叫以下內容:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. 重新啟動新版管理伺服器:
    /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_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

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot;(預設值為「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

管理平台會使用用來將供應商顯示為操作者反向機構 (預設為 「true」)

如要瞭解如何透過管理 UI 調整企業機構設定,請參閱 開始使用營利功能

營利限制

如要強制執行營利限制,請將「營利限制檢查」政策附加至 API Proxy。 具體來說,這個政策會在下列情況下觸發:

  • 開發人員存取營利 API 尚未註冊或未訂閱費率 計畫。
  • 開發人員已超出訂閱費率方案的交易量。
  • 開發人員預付帳戶餘額或後付抵免額數量已達上限。

「營利限制檢查」政策會在以下情況提出錯誤,並封鎖 API 呼叫: 以上列出的各種信號這項政策擴充「提報錯誤」政策,而您可以自訂訊息 。適用條件衍生自業務變數。

詳情請參閱「強制執行 API Proxy 營利限制