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

Edge for Private Cloud phiên bản 4.19.01

Dịch vụ kiếm tiền là một phần mở rộng của Apigee Edge, nên dịch vụ này không hoạt động như một chương trình độc lập của chúng tôi. Dịch vụ này hoạt động trong mọi chế độ thiết lập Apigee Edge hiện có, ngoại trừ dịch vụ Đ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 bạn đang cài đặt tính năng Kiếm tiền trên một cấu trúc liên kết Edge có sử dụng nhiều Máy chủ quản lý các nút, 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ý cạnh trước khi cài đặt tính năng Kiếm tiền.
  • Cách cài đặt tính năng Kiếm tiền trên Edge mà tại đó cài đặt Edge có nhiều nút Postgres, các nút Postgres phải được định cấu hình ở chế độ Chính/Chế độ chờ. Bạn không thể cài đặt tính năng Kiếm tiền trên Edge nếu bạn có nhiều nút chính Postgres. Để biết thêm thông tin, hãy xem Thiết lập tính năng Sao chép chính-dự phòng cho Postgres.
  • Bạn không thể sử dụng tính năng kiếm tiền với cấu hình Đa năng (AIO).

Tổng quan về việc cài đặt

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

  • Dùng tiện ích apigee-setup để cập nhật nút Máy chủ quản lý Apigee thành bật Dịch vụ kiếm tiền, chẳng hạn như quản lý danh mục, giới hạn và thông báo cấu hình, 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ư lượt cài đặt 13 nút, thì bạn phải cài đặt cả hai nút Máy chủ quản lý cạnh trước khi cài đặt tính năng Kiếm tiền.

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

Dưới đây là ví dụ về tệp cấu hình im lặng để cài đặt tính năng Kiếm tiền. Chỉnh sửa nội dung này khi 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 vào.

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

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 tệp đó. Để kiếm tiền, bạn cần có máy chủ SMTP.
  • Trong một lần cài đặt trung tâm dữ liệu, tất cả các nút ZooKeeper đều được định cấu hình là các nhà lãnh đạo. Khi bạn cài đặt Edge trên nhiều trung tâm dữ liệu, một số nút trong ZooKeeper sẽ được định cấu hình làm trình quan sát. Đảm bảo rằng thuộc tính ZK_HOSTS ở trên chỉ định nút lãnh đạo trong việc 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ể chuyể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 trúc liên kết Edge có sử dụng nhiều Máy chủ quản lý các nút, chẳng hạn như cài đặt 13 nút, thì hãy đảm bảo rằng bạn đã cài đặt cả hai 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.

    Tệp cấu hình phải có thể truy cập hoặc có thể đọc được bởi "api" người dùng.

  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, giản đồ R DBMS cho Dịch vụ kiếm tiền được tạo trong Cơ sở dữ liệu PostgreSQL. Đến đây, bạn sẽ hoàn tất quá trình tích hợp Dịch vụ kiếm tiền và các dịch vụ đi kèm với Máy chủ Postgres.

Tích hợp Dịch vụ kiếm tiền với tất cả Công cụ xử lý tin nhắn

Sử dụng quy trình sau để tích hợp tính năng kiếm tiền trên tất cả Trình xử lý thư nút.

  1. Trên nút Trình xử lý thư đầu tiên, tại dấu 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.

    Tệp cấu hình phải có thể truy cập hoặc có thể đọc được bởi "api" người dùng.

  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 định cấu hình thành công, Trình xử lý tin nhắn được cập nhật thành Dịch vụ kiếm tiền. Chiến dịch 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 kết với Dịch vụ kiếm tiền với Thông báo Bộ xử lý.

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

Lần tới khi đă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 cho tổ chức:

Để định cấu hình cổng thông tin hỗ trợ việc 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 quy trình cài đặt tính năng 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 sang Máy chủ quản lý mới và định cấu hình tất 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 lệ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 chứng từ thanh toán dưới dạng tệp PDF

Trang Kiếm tiền hiển thị chứng từ thanh toán cho người dùng cuối ở định dạng HTML. Để cung cấp thông tin thanh toán tài liệu 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 hệ thống thanh toán cung cấp định dạng PDF để tạo hoặc cấp phép một thư viện PDF được hỗ trợ của bên thứ ba.

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

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

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 đáp ứng các 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 cho tổ chức đúc tiền.

Thuộc tính Mô tả
MINT_TAX_MODEL

Giá trị được chấp nhận là "ĐÃ ĐÓNG", "ĐÃ HUỶ", "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 hệ về 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ị lỗi (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 cung 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

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (mặc định là "PREPAID")
MINT_IS_SEPARATE_INV_FOR_FEES

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

Cho biết có nên phát hành câu lệnh thuần hay không (mặc định là "false")
MINT_NETTING_STMT_PER_CURRENCY

Cho biết liệu có nên tạo báo cáo ròng theo đơn vị tiền tệ hay không (mặc định là "sai")
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ả các nhà phát triển hay không (mặc định là "sai")
MINT_HAS_SEPARATE_INV_FOR_PROD

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

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

Được giao diện người dùng quản lý sử dụng để hiển thị trình đơn dành riêng cho tính năng kiếm tiền (mặc định là "sai")
ui.config.isOperator

Được giao diện người dùng quản lý sử dụng để hiển thị nhà cung cấp dưới dạng Toán tử và Tổ chức (mặc định là "đúng")

Để định cấu hình các chế độ cài đặt của tổ chức doanh nghiệp bằng giao diện người dùng quản lý, hãy xem Bắt đầu sử dụng tính năng kiếm tiền.

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

Để thực thi 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 sẽ đượ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 được đăng ký hoặc chưa đăng ký mức giá này .
  • Nhà phát triển đã vượt quá số lượng giao dịch đối với gói giá đã đăng ký.
  • Đã đạt đến số dư tài khoản trả trước hoặc hạn mức tín dụng trả sau của nhà phát triển.

Chính sách Kiểm tra giới hạn kiếm tiền nêu ra các lỗi và chặn lệnh gọi API trong những tình huống như những loại được liệt kê ở trên. Chính sách này mở rộng chính sách Tăng lỗi và bạn có thể tuỳ chỉnh thông báo bị trả lại. Các điều kiện hiện hành được lấy từ các biến số của doanh nghiệp.

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