Monetization Services のインストール

Edge for Private Cloud v4.19.01

Monetization Services は Apigee Edge の拡張機能であるため、スタンドアロンでは実行されません。 プロセスですオールインワン（AIO）を除き、既存の Apigee Edge 環境内で動作します。 できます。AIO 構成には Monetization Services をインストールできません。

収益化の要件

  • 複数の Management Server を使用する Edge トポロジに Monetization をインストールする場合 Edge Management Server ノードを両方ともインストールする必要があります。 まず Monetization をインストールする前に、
  • Edge 環境に複数の Postgres ノードがある Edge に Monetization をインストールするには、次の操作を行います。 Postgres ノードをマスター/スタンバイ モードで構成する必要があります。Monetization をインストールできません Postgres マスターノードが複数ある場合は、エッジ上に作成します。詳細については、次をご覧ください。 マスター / スタンバイ レプリケーションを Postgres。
  • オールインワン（AIO）設定では収益化を利用できません。

インストールの概要

次の手順は、既存の Apigee Edge に Monetization Services を追加する方法を示しています。 インストール:

  • apigee-setup ユーティリティを使用して、Apigee Management Server ノードを次のように更新します。 Monetization Services を有効にする（カタログ管理、制限、通知など） 構成、請求、レポート作成など、

    13 ノード構成など、複数の Management Server ノードがある場合は、 Monetization をインストールする前に、両方の Edge Management Server ノードをインストールします。

  • apigee-setup を使用する ユーティリティを使用して Apigee Message Processor を更新し、 収益化サービス（トランザクション記録ポリシー、制限の適用など）もし 複数の Message Processor がある場合は、そのすべてに Monetization をインストールします。
  • Edge 組織に対して Monetization オンボーディング プロセスを実行します。
  • 収益化をサポートするように 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.
# 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

Monetization Services をすべての管理サーバーと統合する

Management Server ノードで Monetization を統合するには、次の操作を行います。

  1. 複数の Management Server を使用する Edge トポロジに Monetization をインストールする場合 Management Server がインストールされていることを確認し、 Monetization をインストールする前に、コンテナ イメージを確認してください。
  2. Management Server ノードで、セットアップ スクリプトを実行します。
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo オプションは、Monetization を統合するよう指定します。

    構成ファイルは、「apigee」からアクセス可能または読み取り可能である必要があります。できます。

  3. 複数の Management Server ノードに Monetization をインストールする場合は、各ノードで手順 2 を繰り返します。 2 番目の Management Server ノードで起動されます。

構成が正常に行われると、Monetization Services の RDBMS スキーマが PostgreSQL データベースです。これで、Monetization Services とそれに関連する Postgres Server を使用する方法を説明します

Monetization Services をすべての Message Processor と統合する

すべての Message Processor で Monetization を統合するには、次の操作を行います。 説明します。

  1. 最初の Message Processor ノードで、コマンド プロンプトで設定スクリプトを実行します。 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo オプションは、Monetization を統合するよう指定します。

    構成ファイルは、「apigee」からアクセス可能または読み取り可能である必要があります。できます。

  2. すべての Message Processor ノードで、この手順を繰り返します。

構成が成功すると、Message Processor が Monetization Services によって更新されます。この Monetization Services とその関連コンポーネントがメッセージと統合されている 決済代行業者。

収益化のオンボーディング

新しい組織を作成して収益化を有効にするには:

  1. 新しい組織と同じように組織を作成します。詳細については、次をご覧ください: 組織をオンボーディングする。
  2. 次の説明に沿って Monetization Provisioning API を使用します。 有効化 組織の収益化にもつながります。この操作を行うには、 できます。

次回 Edge UI にログインすると、最上位レベルのメニューに [Monetization] エントリが表示されます。 組織にもたらされます

収益化をサポートするようにポータルを構成するには、 デベロッパー ポータルをご覧ください。

Monetization インストールへの Management Server ノードの追加

既存の Edge インストールに Management Server を追加する場合は、 新しい Management Server への収益化サービスを作成し、すべての Management Server で、 通信できるようになります。

Management Server を追加するには:

  1. 新しい Management Server をインストールします。
  2. 新しい Management Server に Monetization をインストールします。
  3. 元の Management Server で次のコマンドを実行します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. 元の Management Server を再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. 新しい Management Server で、次の呼び出しを行います。 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. 新しい Management Server を再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

追加構成

請求書を PDF ファイルとして提出する

収益化では、請求書類が HTML 形式でエンドユーザーに表示されます。支払い情報の提供 Monetization を、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」です。（デフォルトは null）
MINT_CURRENCY

ISO 通貨コード（デフォルトは null）
MINT_TAX_NEXUS

税金ネクサス（デフォルトは null）
MINT_DEFAULT_PROD_TAX_CATEGORY

デフォルトの商品税のカテゴリ（デフォルトは null）
MINT_IS_GROUP_ORG

IS グループの組織（デフォルトは「false」）
MINT_HAS_BROKER

破損あり（デフォルトは false）
MINT_TIMEZONE

タイムゾーン（デフォルトは null）
MINT_TAX_ENGINE_EXTERNAL_ID

税務エンジン ID（デフォルトは null）
MINT_COUNTRY

組織の国（デフォルトは null）
MINT_REG_NO

組織の登録番号（英国では納税者番号とは異なる番号） （デフォルトは null）
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

プロバイダをオペレーターと組織として表示するために管理 UI で使用されます（デフォルトは 「true」）

管理 UI を使用してビジネス組織の設定を構成する方法については、以下をご覧ください。 収益化の利用を開始する

収益化の上限

収益化の上限を適用するには、API プロキシに Monetization Limits Check ポリシーを接続します。 具体的には、ポリシーは次の条件でトリガーされます。

  • 収益化対象の API にアクセスするデベロッパーが登録されていないか、このレートに登録していない できます
  • デベロッパーが登録した料金プランのトランザクション量を超えています。
  • デベロッパーの前払いアカウント残高または後払い利用限度額に達しました。

Monetization Limits Check ポリシーを使用すると、次のような場合に障害が発生し、API 呼び出しがブロックされます。 使用できます。このポリシーは Raise Fault ポリシーを拡張します。また、 返されます。該当する条件は、ビジネス変数から導出されます。

詳しくは、適用 API プロキシの収益化の上限をご覧ください。