此页面由 Cloud Translation API 翻译。

安装创收服务

适用于私有云的 Edge v4.18.05

Monetization Services 是对 Apigee Edge 的扩展，因此它并非独立运行过程。它可在任何现有的 Apigee Edge 设置中运行，但一体式广告 (AIO) 除外配置。

创收要求

如果您要在使用多个管理服务器的边缘拓扑上安装创收功能节点（例如 13 节点安装），则必须同时安装两个边缘管理服务器节点然后再安装创收功能
如需在 Edge 安装有多个 Postgres 节点的 Edge 上安装创收功能，请执行以下操作： Postgres 节点必须在主/待机模式下配置。你无法安装创收功能（如果您有多个 Postgres 主节点）。有关详情，请参阅为以下服务设置主备用复制： Postgres。
创收功能不适用于一体机 (AIO) 配置。

安装概览

以下步骤说明了如何在现有 Apigee Edge 上添加创收服务安装：

使用 apigee-setup 实用程序将 Apigee 管理服务器节点更新为启用创收服务，例如目录管理、限制和通知配置、结算和报告。
如果您有多个 Management Server 节点（例如 13 个节点的安装），则必须请先安装两个边缘管理服务器节点，然后再安装 Monetization 功能。
使用 apigee-setup 实用程序更新 Apigee 消息处理器，以启用变现服务，例如交易记录政策和限制违规处置。如果您如果有多个消息处理器，请为它们都安装创收功能。
为 Edge 组织执行创收新手入门流程。
配置 Apigee Developer Services 门户（简称门户）以支持创收。如需了解详情，请参阅在开发者门户中配置创收功能。

创建用于创收的静默配置文件

下面显示了一个变现安装的静默配置文件示例。修改此内容文件。使用 -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.
# 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 节点安装），则请确保同时安装了管理服务器和然后才能安装创收功能
在管理服务器节点上，运行设置脚本：
```
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
```
-p mo 选项指定集成创收功能。

配置文件必须可供“apigee”访问或读取用户。
如果您要在多个管理服务器节点上安装创收功能，请在以下位置重复第 2 步：第二个管理服务器节点。

配置成功后，系统会在 PostgreSQL 数据库。至此，变现服务及其相关联的组件与 Postgres Server 结合使用。

将变现服务与所有消息处理器集成

按照以下步骤将创收功能集成到所有消息处理器中节点。

在第一个消息处理器节点上的命令提示符下，运行设置脚本：
```
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
```
-p mo 选项指定集成创收功能。

配置文件必须可供“apigee”访问或读取用户。
在所有消息处理器节点上重复此过程。

配置成功后，消息处理器会更新为使用变现服务。这个完成变现服务及其相关组件与消息的集成处理器。

启用创收功能

如需创建新组织并启用创收功能，请执行以下操作：

您可以像创建任何新组织一样创建组织。如需了解详情，请参阅对组织进行初始配置。
按照相关说明使用 Monetization Provisioning API 启用组织创收。要执行此操作，您必须拥有系统管理员权限。

下次登录 Edge 界面时，您会在以下平台的顶级菜单中看到“创收”条目：组织：

如需配置门户以支持创收功能，请参阅在以下位置配置创收功能开发者门户。

向 Monetization 安装添加管理服务器节点

如果您在现有 Edge 安装中添加管理服务器，则必须确保将管理服务器添加到创收服务到新的管理服务器，并配置所有管理服务器，进行通信

要添加管理服务器，请执行以下操作：

安装新的管理服务器。
在新管理服务器上安装 Monetization。

在原始管理服务器上，调用以下内容：

/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 库。

配置组织设置

如需添加/更新组织属性，您可以使用 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`	"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`	供管理界面用来显示创收专用菜单（默认为 “false”）
`ui.config.isOperator`	供管理界面用来将提供商显示为运营商而不是组织（默认值为 “true”）

如需了解如何使用管理界面配置商家组织设置，请参阅开始使用创收功能。

创收限制

如需强制执行创收限制，请将“创收限制检查”政策附加到 API 代理。具体而言，系统会在以下情况下触发该政策：

使用创收 API 的开发者未注册或未订阅该费率。
开发者已超出订阅费率方案的交易量。
已达到开发者预付款账号余额或后付费信用额度。

“创收限额检查”政策会引发错误，并在如下情况下阻止 API 调用：以上所列。该政策会扩展“引发错误”政策，并且您可以自定义消息返回。适用的条件来自业务变量。

有关详情，请参阅执行 API 代理的创收限制。