Cài đặt Dịch vụ Kiếm tiền

Dịch vụ kiếm tiền là một tiện ích mở rộng cho Apigee Edge, do đó, dịch vụ này không chạy dưới dạng một quy trình độc lập. API này chạy trong mọi chế độ thiết lập Apigee Edge hiện có, ngoại trừ cấu hình Đa năng (AIO). Bạn không thể cài đặt Dịch vụ kiếm tiền trên cấu hình AIO.

Yêu cầu về việc kiếm tiền

  • Nếu đang cài đặt tính năng Kiếm tiền trên một cấu hình Edge sử dụng nhiều nút Máy chủ quản lý, chẳng hạn như cài đặt 13 nút, thì bạn phải cài đặt cả hai nút Máy chủ quản lý Edge trước khi cài đặt tính năng Kiếm tiền.
  • Để cài đặt tính năng Kiếm tiền trên Edge, trong đó quá trình cài đặt Edge có nhiều nút Postgres, bạn phải định cấu hình các nút Postgres ở chế độ Chính/Chờ. Bạn không thể cài đặt tính năng Kiếm tiền trên Edge nếu có nhiều nút chính Postgres. Để biết thêm thông tin, hãy xem phần Thiết lập tính năng sao chép chính-chờ cho Postgres.
  • Bạn không thể kiếm tiền bằng cấu hình Tất cả trong một (AIO).

Tổng quan về quá trình cài đặt

Các bước sau đây minh hoạ cách thêm Dịch vụ kiếm tiền trên một bản cài đặt Apigee Edge hiện có:

  • Sử dụng tiện ích apigee-setup để cập nhật nút Máy chủ quản lý Apigee nhằm bật Dịch vụ kiếm tiền, ví dụ: quản lý danh mục, giới hạn và cấu hình thông báo, thanh toán và báo cáo.

    Nếu có nhiều nút Máy chủ quản lý, chẳng hạn như cài đặt 13 nút, thì bạn phải cài đặt cả hai nút Máy chủ quản lý Edge trước khi cài đặt tính năng Kiếm tiền.

  • Sử dụng tiện ích apigee-setup để cập nhật Trình xử lý thông báo Apigee nhằm bật các thành phần thời gian chạy của Dịch vụ kiếm tiền, ví dụ: chính sách ghi lại giao dịch và thực thi giới hạn. Nếu bạn có nhiều Trình xử lý tin nhắn, hãy cài đặt tính năng Kiếm tiền trên tất cả các Trình xử lý tin nhắn đó.
  • Thực hiện quy trình làm quen với tính năng Kiếm tiền cho các tổ chức Edge.
  • Định cấu hình cổng thông tin Dịch vụ dành cho nhà phát triển Apigee (hoặc đơn giản là cổng thông tin) để hỗ trợ kiếm tiền. Để biết thêm thông tin, hãy xem phần Định cấu hình tính năng kiếm tiền trong Cổng thông tin dành cho nhà phát triển.

Tạo tệp cấu hình im lặng cho tính năng Kiếm tiền

Dưới đây là ví dụ về tệp cấu hình cài đặt thầm cho một lượt cài đặt tính năng Kiếm tiền. Chỉnh sửa tệp này nếu cần cho cấu hình của bạn. Sử dụng tuỳ chọn -f để setup.sh thêm tệp này.

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

Lưu ý:

  • Nếu tệp cấu hình Edge của bạn không chỉ định thông tin SMTP, hãy thêm thông tin đó. Bạn cần có máy chủ SMTP để kiếm tiền.
  • Trong một lần cài đặt trung tâm dữ liệu, bạn phải định cấu hình số lẻ của các nút ZooKeeper là voters. Nếu số lượng nút ZooKeeper là bằng nhau, thì một số nút sẽ được định cấu hình là observers. Khi bạn cài đặt Edge trên một số lượng trung tâm dữ liệu bằng nhau, một số nút ZooKeeper phải được định cấu hình là observers để số lượng nút bầu chọn là số lẻ. Trong quá trình bầu cử máy chủ điều phối ZooKeeper, một nút bỏ phiếu sẽ được bầu làm leader. Đảm bảo rằng thuộc tính ZK_HOSTS ở trên chỉ định một nút trưởng trong quá trình cài đặt nhiều trung tâm dữ liệu.
  • Nếu bật tính năng xác thực Cassandra, bạn có thể truyền tên người dùng và mật khẩu Cassandra bằng cách sử dụng các thuộc tính sau: 
    CASS_USERNAME
CASS_PASSWORD

Tích hợp Dịch vụ kiếm tiền với tất cả Máy chủ quản lý

Sử dụng quy trình sau để tích hợp tính năng kiếm tiền trên các nút Máy chủ quản lý.

  1. Nếu bạn đang cài đặt tính năng Kiếm tiền trên một cấu hình Edge sử dụng nhiều nút Máy chủ quản lý, chẳng hạn như cài đặt 13 nút, hãy đảm bảo rằng bạn đã cài đặt cả hai nút Máy chủ quản lý trước khi cài đặt tính năng Kiếm tiền.
  2. Trên nút Máy chủ quản lý, hãy chạy tập lệnh thiết lập:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Tuỳ chọn -p mo chỉ định việc tích hợp tính năng Kiếm tiền.

    Người dùng "apigee" phải có thể truy cập hoặc đọc tệp cấu hình.

  3. Nếu bạn đang cài đặt tính năng Kiếm tiền trên nhiều nút Máy chủ quản lý, hãy lặp lại bước 2 trên nút Máy chủ quản lý thứ hai.

Khi định cấu hình thành công, một giản đồ RDBMS cho Dịch vụ kiếm tiền sẽ được tạo trong cơ sở dữ liệu PostgreSQL. Thao tác này hoàn tất quá trình tích hợp Dịch vụ kiếm tiền và các thành phần liên quan với Máy chủ Postgres.

Tích hợp Dịch vụ kiếm tiền với tất cả Trình xử lý thông báo

Hãy làm theo quy trình sau để tích hợp tính năng kiếm tiền trên tất cả các nút Trình xử lý thông báo.

  1. Trên nút Trình xử lý thông báo đầu tiên, tại lời nhắc lệnh, hãy chạy tập lệnh thiết lập: 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    Tuỳ chọn -p mo chỉ định việc tích hợp tính năng Kiếm tiền.

    Người dùng "apigee" phải có thể truy cập hoặc đọc tệp cấu hình.

  2. Lặp lại quy trình này trên tất cả các nút Trình xử lý thư.

Khi cấu hình thành công, Trình xử lý thông báo sẽ được cập nhật bằng Dịch vụ kiếm tiền. Thao tác này hoàn tất việc tích hợp Dịch vụ kiếm tiền và các thành phần liên quan với Trình xử lý thông báo.

Giới thiệu về việc kiếm tiền

Cách tạo một tổ chức mới và bật tính năng kiếm tiền:

  1. Tạo tổ chức như cách bạn tạo bất kỳ tổ chức mới nào. Để biết thêm thông tin, hãy xem bài viết Giới thiệu về tổ chức.
  2. Sử dụng API cấp phép kiếm tiền theo mô tả trong bài viết Bật tính năng kiếm tiền cho tổ chức. Để làm việc này, bạn phải có đặc quyền quản trị hệ thống.

Trong lần tiếp theo đăng nhập vào giao diện người dùng Edge, bạn sẽ thấy mục Kiếm tiền trong trình đơn cấp cao nhất của tổ chức:

Để định cấu hình cổng thông tin nhằm hỗ trợ tính năng kiếm tiền, hãy xem phần Định cấu hình tính năng Kiếm tiền trong cổng thông tin dành cho nhà phát triển.

Thêm nút Máy chủ quản lý vào một lượt cài đặt Kiếm tiền

Nếu thêm Máy chủ quản lý vào một lượt cài đặt Edge hiện có, bạn phải đảm bảo rằng bạn thêm các dịch vụ Kiếm tiền vào Máy chủ quản lý mới và định cấu hình tất cả các Máy chủ quản lý để chúng có thể giao tiếp.

Cách thêm Máy chủ quản lý:

  1. Cài đặt Máy chủ quản lý mới.
  2. Cài đặt tính năng Kiếm tiền trên Máy chủ quản lý mới.
  3. Trên Máy chủ quản lý gốc, hãy gọi như sau: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Khởi động lại Máy chủ quản lý gốc: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Trên Máy chủ quản lý mới, hãy gọi lệnh sau: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Khởi động lại Máy chủ quản lý mới: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Cấu hình bổ sung

Cung cấp tài liệu thanh toán dưới dạng tệp PDF

Tính năng kiếm tiền hiển thị tài liệu thanh toán cho người dùng cuối ở định dạng HTML. Để cung cấp tài liệu thanh toán dưới dạng tệp PDF, bạn có thể tích hợp tính năng Kiếm tiền với một hệ thống thanh toán cung cấp tính năng tạo PDF hoặc cấp phép cho thư viện PDF của bên thứ ba được hỗ trợ.

Định cấu hình chế độ cài đặt tổ chức

Để thêm/cập nhật các thuộc tính tổ chức, bạn có thể sử dụng yêu cầu PUT, như trong ví dụ sau:

curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \
  -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT

Tính năng kiếm tiền sẽ phản hồi theo chế độ cài đặt của tổ chức. Ví dụ:

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

Bảng sau đây liệt kê các thuộc tính cấp tổ chức có sẵn để định cấu hình tổ chức đúc tiền.

Thuộc tính Mô tả
MINT_TAX_MODEL

Các giá trị được chấp nhận là "DISCLOSED", "UNDISCLOSED", "HYBRID" (mặc định là rỗng)
MINT_CURRENCY

Mã đơn vị tiền tệ ISO (mặc định là rỗng)
MINT_TAX_NEXUS

Mối liên kết thuế (mặc định là rỗng)
MINT_DEFAULT_PROD_TAX_CATEGORY

Danh mục thuế sản phẩm mặc định (mặc định là rỗng)
MINT_IS_GROUP_ORG

Tổ chức nhóm IS (mặc định là "false")
MINT_HAS_BROKER

Đã bị hỏng (mặc định là false)
MINT_TIMEZONE

Múi giờ (mặc định là rỗng)
MINT_TAX_ENGINE_EXTERNAL_ID

Mã công cụ thuế (mặc định là rỗng)
MINT_COUNTRY

Quốc gia của tổ chức (mặc định là rỗng)
MINT_REG_NO

Số đăng ký của tổ chức, Vương quốc Anh cấp số khác với mã số thuế (mặc định là rỗng)
MINT_BILLING_CYCLE_TYPE

"PRORATED", "CALENDAR_MONTH" (mặc định là "CALENDAR_MONTH")
MINT_SUPPORTED_BILLING_TYPE

"TRẢ TRƯỚC"/"TRẢ TRƯỚC"/"CẢ HAI" (mặc định là "ĐÃ TRẢ TRƯỚC")
MINT_IS_SEPARATE_INV_FOR_FEES

Cho biết liệu có tạo hoá đơn phí riêng hay không (mặc định là "false")
MINT_ISSUE_NETTING_STMT

Cho biết liệu có phát hành báo cáo bù trừ hay không (mặc định là "false")
MINT_NETTING_STMT_PER_CURRENCY

Cho biết liệu có nên tạo câu lệnh ròng theo đơn vị tiền tệ hay không (mặc định là "false")
MINT_HAS_SELF_BILLING

Cho biết liệu tổ chức có tự thanh toán hay không (mặc định là "false")
MINT_SELF_BILLING_FOR_ALL_DEV

Cho biết liệu tổ chức có tự thanh toán cho tất cả nhà phát triển hay không (mặc định là "false")
MINT_HAS_SEPARATE_INV_FOR_PROD

Cho biết liệu tổ chức có hoá đơn riêng cho từng sản phẩm hay không (mặc định là "false")
MINT_HAS_BILLING_ADJUSTMENT

Cho biết liệu tổ chức có hỗ trợ việc điều chỉnh thông tin thanh toán hay không (mặc định là "false")
features.isMonetizationEnabled

Giao diện người dùng quản lý sử dụng để hiển thị trình đơn cụ thể về việc kiếm tiền (mặc định là "false")
ui.config.isOperator

Giao diện người dùng quản lý sử dụng để hiển thị nhà cung cấp dưới dạng Nhà điều hành so với Tổ chức (mặc định là "true")

Để định cấu hình chế độ cài đặt tổ chức doanh nghiệp bằng giao diện người dùng quản lý, hãy xem bài viết Truy cập vào tính năng kiếm tiền trong Edge.

Giới hạn kiếm tiền

Để thực thi các giới hạn kiếm tiền, hãy đính kèm chính sách Kiểm tra giới hạn kiếm tiền vào proxy API. Cụ thể, chính sách này được kích hoạt trong các điều kiện sau:

  • Nhà phát triển truy cập vào API kiếm tiền chưa đăng ký hoặc chưa đăng ký gói giá.
  • Nhà phát triển đã vượt quá số lượng giao dịch đối với gói giá đã đăng ký.
  • Đã đạt đến hạn mức tín dụng trả sau hoặc số dư tài khoản trả trước của nhà phát triển.

Chính sách Kiểm tra giới hạn kiếm tiền sẽ phát sinh lỗi và chặn các lệnh gọi API trong những trường hợp như nêu trên. Chính sách này mở rộng chính sách Raise Fault (Gửi lỗi) và bạn có thể tuỳ chỉnh thông báo được trả về. Các điều kiện áp dụng được lấy từ các biến kinh doanh.

Để biết thêm thông tin, hãy xem bài viết Thực thi hạn mức kiếm tiền trên proxy API.