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

Edge for Private Cloud phiên bản 4.17.01

Dịch vụ kiếm tiền là một tiện ích cho Apigee Edge, do đó không hoạt động như 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ó.

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 trúc liên kết cạnh sử dụng 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ý biên trước khi cài đặt chế độ Kiếm tiền.
  • Để cài đặt Monetization trên Edge khi 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/Dự phòng. 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 Cài đặt tiện ích thiết lập apigee của Edge.

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 khi ứng dụng đang cài đặt Apigee Edge:

  • Sử dụng tiện ích apigee-setup để cập nhật nút Máy chủ quản lý Apigee để bật các Dịch vụ kiếm tiền, chẳng hạn như quản lý danh mục, giới hạn, 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, 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.
  • Hãy 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à giới hạn việc thực thi). Nếu bạn có nhiều Bộ xử lý thư, hãy cài đặt tính năng Kiếm tiền trên tất cả các Bộ xử lý đó.
  • 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 của bạn trong Edge.
  • Định cấu hình cổng Dịch vụ dành cho nhà phát triển để hỗ trợ hoạt động kiếm tiền. Để biết thêm thông tin, hãy xem http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

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 im lặng để 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 bao gồm tệp này.

Lưu ý: Thông thường, bạn nên thêm các thuộc tính này vào chính tệp cấu hình mà bạn đã dùng để cài đặt Edge, như minh hoạ trong phần Cài đặt các thành phần Edge trên một nút.

# 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
Lưu ý:
  • Nếu tệp cấu hình Edge của bạn chưa chỉ định thông tin SMTP, hãy thêm tệp đó. Tính năng kiếm tiền cần có máy chủ SMTP.
  • Trong một lần cài đặt trung tâm dữ liệu, theo mặc định, tất cả các nút ZooKeeper đều được định cấu hình là nút dẫn đầu. Khi bạn cài đặt Edge trên nhiều trung tâm dữ liệu, một số nút 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 một nút dẫn đầu trong một 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ể chuyển tên người dùng và mật khẩu của Cassandra bằng cách sử dụng các thuộc tính sau:
    CASS_USERNAME
    CASS_passwords

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

Hãy sử dụng quy trình sau đây để 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 cấu trúc liên kết Edge sử dụng nhiều nút Máy chủ quản lý, chẳng hạn như lượt 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 để tích hợp tính năng Kiếm tiền.

    Người dùng "apigee" phải truy cập được hoặc đọ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 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. Đến đây, bạn đã 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ụ này với Máy chủ Postgres.

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

Hãy sử dụng 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 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 chế độ Kiếm tiền.

    Người dùng "apigee" phải truy cập được hoặc đọ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 Bộ xử lý thông báo.

Sau khi định cấu hình thành công, Trình xử lý thông báo sẽ được cập nhật cùng với Dịch vụ kiếm tiền. Đến đây, bạn đã 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ụ xử lý thông báo.

Giới thiệu về tính năng kiếm tiền

Để tạo một tổ chức mới có bật tính năng kiếm tiền, trước tiên, bạn cần tạo tổ chức như cách bạn tạo cho bất kỳ tổ chức mới nào. Để biết thêm thông tin, hãy xem phần Giới thiệu một tổ chức.

Giới thiệu thêm để bật tính năng Kiếm tiền cho tổ chức

Để hoàn tất quy trình giới thiệu tính năng kiếm tiền trong tổ chức, bạn phải:

  1. Tạo nhóm kiếm tiền: mxgroup.
  2. Thêm Qpid vào nhóm.
  3. Bật tính năng kiếm tiền cho tổ chức.
  4. Bật các tùy chọn cài đặt thông báo cho tổ chức.
  5. Lặp lại quy trình này cho tất cả các tổ chức mà bạn muốn bật tính năng Kiếm tiền.

Hãy sử dụng lệnh bật tính năng kiếm tiền để thực hiện tất cả các thao tác này. Tập lệnh này sẽ lấy một tệp cấu hình chứa các thuộc tính sau:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

Lưu ý:

  • Đặt CASS_HOSTSKHU VỰC về chính các giá trị bạn đã dùng khi cài đặt tính năng Kiếm tiền.
  • Nếu bạn đang bật tính năng Kiếm tiền trong cấu hình nhiều trung tâm dữ liệu:
    • Bạn phải lặp lại quy trình làm quen với Máy chủ quản lý trong từng trung tâm dữ liệu.
    • Tệp cấu hình chỉ được liệt kê các nút Qpid trong trung tâm dữ liệu đang được định cấu hình.

Cách chạy tập lệnh:

  1. Gọi tập lệnh:
    > /opt/apigee/apigee-service/bin/apigee-service apigee- Vault enabled-monetization -f configFile

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

    Nếu có nhiều Máy chủ quản lý, bạn chỉ phải chạy tập lệnh này trên một trong số đó.

    Tập lệnh này sao chép tổ chức, sản phẩm, nhà phát triển và ứng dụng từ cơ sở dữ liệu Cassandra sang cơ sở dữ liệu Monetize PostgreSQL. Sau khi cài đặt thành công Dịch vụ kiếm tiền, dữ liệu sẽ tự động đồng bộ hoá.
  2. Lặp lại quy trình này cho mọi tổ chức mà bạn muốn bật tính năng Kiếm tiền.
  3. Nếu bạn đang sử dụng nhiều trung tâm dữ liệu, hãy lặp lại quy trình này trên Máy chủ quản lý trong trung tâm dữ liệu khác. Đảm bảo rằng danh sách tệp cấu hình chỉ có các nút Qpid trong trung tâm dữ liệu đang được định cấu hình.

Vào 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 cho tổ chức:

Định cấu hình cổng Dịch vụ dành cho nhà phát triển

Để định cấu hình cổng Dịch vụ dành cho nhà phát triển nhằm hỗ trợ hoạt động kiếm tiền, hãy xem http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

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

Nếu thêm Máy chủ quản lý vào một bản cài đặt Edge hiện có, bạn phải đảm bảo thêm 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ả Máy chủ quản lý để chúng có thể liên lạc với nhau.

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-serviceedge-mint-management-server mint-configure-hẳng-cluster
  4. Khởi động lại Máy chủ quản lý phiên bản cũ:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-management-server khởi động lại
  5. Trên Máy chủ quản lý mới, hãy gọi như sau:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-hẳng-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 khởi động lại

Cấu hình bổ sung

Cung cấp chứng từ thanh toán dưới dạng tệp PDF

Tính năng 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 chứng từ 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 có hỗ trợ tính năng tạo tệp PDF hoặc cấp phép cho một 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

Chế độ cài đặt phụ trợ: Bảng sau đây liệt kê những thuộc tính cấp tổ chức có sẵn để định cấu hình một tổ chức đúc. Bạn có thể sử dụng lệnh gọi PUT để thêm/cập nhật các thuộc tính này như minh hoạ dưới đây:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

Ví dụ: kết quả của lệnh CURL ở trên sẽ có dạng như sau:

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

Thuộc tính

Mô tả

MINT_TAX_MODEL

Các giá trị được chấp nhận là BỊ ĐÓNG,

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 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à sai)

MINT_HAS_BROKER

Đã bị lỗi (mặc định là sai)

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

Mã số đăng ký của tổ chức, Vương quốc Anh cung cấp mã 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Ả SAU/CẢ HAI (mặc định là TRẢ TRƯỚC)

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à sai)

MINT_ISSUE_NETTING_STMT

Cho biết có nên phát hành câu lệnh ròng hay không (mặc định là sai)

MINT_NETTING_STMT_PER_CURRENCY

Cho biết có nên tạo câu lệnh tính phí ròng cho mỗi loại đơn vị tiền tệ hay không (mặc định là sai)

MINT_HAS_SELF_BILLING

Cho biết tổ chức có tính năng tự thanh toán hay không (mặc định là sai)

MINT_SELF_BILLING_FOR_ALL_DEV

Cho biết liệu tổ chức có bật chế độ tự thanh toán cho tất 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ợ việc đ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 cụ thể về hoạt động kiếm tiền (mặc định là sai)

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 tổ chức của Nhà điều hành

(mặc định là đúng)

Để định cấu hình chế độ cài đặt tổ chức kinh doanh bằng giao diện người dùng quản lý, hãy xem http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Lưu ý: Nếu bạn đang sử dụng các tính năng Thông báo và giới hạn của Dịch vụ kiếm tiền, vui lòng hướng dẫn nhà phát triển đính kèm Chính sách giới hạn vào quy trình proxy sau khi có chính sách xác thực mã truy cập.

Chính sách về giới hạn là một chính sách rõ ràng được thiết kế để chặn lệnh gọi API nếu đã đạt đến một số giới hạn nhất định. Chính sách này kiểm tra hạn mức kinh doanh và phát sinh lỗi nếu có bất kỳ giới hạn nào vượt quá giá trị đã định cấu hình. Đây là phần mở rộng của chính sách tăng lỗi, nhưng các điều kiện bắt nguồn từ các biến kinh doanh.

Mẫu giao diện người dùng có sẵn trong giao diện người dùng quản lý dành cho nhà phát triển proxy. Nhà phát triển proxy nên đính kèm chính sách đúc trong luồng thông báo. Khi thực thi chính sách này, lỗi sẽ được nêu ra cùng với phản hồi lỗi theo chính sách. Nếu bạn đặt ContinueOnError thành true thì lỗi sẽ không tăng lên và các biến luồng "mint.limitsViolated", "mint.isDeveloperSuspended" và "mint.limitsPolicyError" sẽ được đặt thành các biến có thể dùng để xử lý ngoại lệ tiếp theo nếu cần.