การติดตั้งบริการสร้างรายได้

Edge for Private Cloud v4.19.01

บริการการสร้างรายได้เป็นส่วนขยายของ Apigee Edge จึงไม่ทำงานเป็นกระบวนการแบบสแตนด์อโลน โดยจะทำงานภายในการตั้งค่า Apigee Edge ที่มีอยู่ ยกเว้นการกำหนดค่า All-In-One (AIO) คุณไม่สามารถติดตั้งบริการการสร้างรายได้ในการกำหนดค่า AIO

ข้อกำหนดในการสร้างรายได้

• หากคุณกำลังติดตั้งการสร้างรายได้ในโทโพโลยี Edge ที่ใช้โหนด Management Server หลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้ง 2 โหนดก่อนที่จะติดตั้งการสร้างรายได้
• หากต้องการติดตั้งการสร้างรายได้ใน Edge ที่การติดตั้ง Edge มีโหนด Postgres หลายโหนด คุณต้องกำหนดค่าโหนด Postgres ในโหมดมาสเตอร์/สแตนด์บาย คุณไม่สามารถติดตั้งการสร้างรายได้ใน Edge หากมีโหนดหลัก Postgres หลายโหนด ดูข้อมูลเพิ่มเติมได้ที่หัวข้อตั้งค่าการจำลองแบบ Master-Standby สำหรับ Postgres
• การสร้างรายได้ไม่พร้อมใช้งานกับการกำหนดค่าแบบ All-In-One (AIO)

ภาพรวมการติดตั้ง

ขั้นตอนต่อไปนี้แสดงวิธีเพิ่มบริการการสร้างรายได้ในการติดตั้ง Apigee Edge ที่มีอยู่

• ใช้ยูทิลิตี apigee-setup เพื่ออัปเดตโหนด Apigee Management Server เพื่อเปิดใช้บริการการสร้างรายได้ เช่น การจัดการแคตตาล็อก การกำหนดค่าขีดจำกัดและการแจ้งเตือน การเรียกเก็บเงิน และการรายงาน

  หากคุณมีโหนด Management Server หลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้ง 2 โหนดก่อนติดตั้งการสร้างรายได้

• ใช้ยูทิลิตี apigee-setup เพื่ออัปเดต Apigee Message Processor เพื่อเปิดใช้คอมโพเนนต์รันไทม์ของบริการการสร้างรายได้ เช่น นโยบายการบันทึกธุรกรรมและการบังคับใช้ขีดจำกัด หากคุณมี Message Processor หลายรายการ ให้ติดตั้งการสร้างรายได้ใน Message Processor ทั้งหมด
• ทำตามขั้นตอนการเริ่มต้นใช้งานการสร้างรายได้สำหรับองค์กร Edge
• กำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาแอป Apigee (หรือเรียกสั้นๆ ว่าพอร์ทัล) เพื่อรองรับการสร้างรายได้ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อกำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาซอฟต์แวร์

การสร้างไฟล์การกำหนดค่าแบบไม่มีการโต้ตอบสำหรับการสร้างรายได้

ด้านล่างนี้คือตัวอย่างไฟล์การกำหนดค่าแบบไม่มีการโต้ตอบสำหรับการติดตั้ง Monetization แก้ไขไฟล์นี้ตามที่จำเป็นสำหรับการกำหนดค่าของคุณ ใช้ตัวเลือก -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

ผสานรวมบริการการสร้างรายได้กับเซิร์ฟเวอร์การจัดการทั้งหมด

ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้ในโหนดเซิร์ฟเวอร์การจัดการ

1. หากคุณกำลังติดตั้งการสร้างรายได้ในโทโพโลยี Edge ที่ใช้โหนด Management Server หลายโหนด เช่น การติดตั้ง 13 โหนด ให้ตรวจสอบว่าคุณได้ติดตั้งโหนด Management Server ทั้ง 2 โหนดก่อนที่จะติดตั้งการสร้างรายได้
2. เรียกใช้สคริปต์การตั้งค่าในโหนด Management Server ดังนี้
   

   /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

   ตัวเลือก -p mo จะระบุให้ผสานรวมการสร้างรายได้

   ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้

3. หากคุณติดตั้งการสร้างรายได้ในโหนดเซิร์ฟเวอร์การจัดการหลายโหนด ให้ทำขั้นตอนที่ 2 ซ้ำในโหนดเซิร์ฟเวอร์การจัดการที่ 2

เมื่อกำหนดค่าสำเร็จ ระบบจะสร้างสคีมา RDBMS สำหรับบริการการสร้างรายได้ในฐานข้อมูล PostgreSQL การผสานรวมบริการการสร้างรายได้และคอมโพเนนต์ที่เกี่ยวข้องกับเซิร์ฟเวอร์ Postgres เสร็จสมบูรณ์แล้ว

ผสานรวมบริการการสร้างรายได้กับ Message Processor ทั้งหมด

ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้ในโหนด Message Processor ทั้งหมด

1. ในโหนด Message Processor แรก ให้เรียกใช้สคริปต์การตั้งค่าที่ Command Prompt ดังนี้

   /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

   ตัวเลือก -p mo จะระบุให้ผสานรวมการสร้างรายได้

   ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้

2. ทำขั้นตอนนี้ซ้ำในโหนด Message Processor ทั้งหมด

เมื่อกำหนดค่าสำเร็จ ระบบจะอัปเดต Message Processor ด้วยบริการการสร้างรายได้ การดำเนินการนี้จะทำให้การผสานรวมบริการการสร้างรายได้และคอมโพเนนต์ที่เกี่ยวข้องกับ Message Processor เสร็จสมบูรณ์

การเริ่มต้นใช้งานการสร้างรายได้

วิธีสร้างองค์กรใหม่และเปิดใช้การสร้างรายได้

1. สร้างองค์กรเหมือนกับที่คุณสร้างองค์กรใหม่ ดูข้อมูลเพิ่มเติมได้ที่เริ่มต้นใช้งานองค์กร
2. ใช้ API การจัดสรรการสร้างรายได้ตามที่อธิบายไว้ในเปิดใช้การสร้างรายได้สำหรับองค์กร โดยคุณต้องมีสิทธิ์ของผู้ดูแลระบบจึงจะดำเนินการนี้ได้

เมื่อเข้าสู่ระบบ Edge UI ในครั้งถัดไป คุณจะเห็นรายการการสร้างรายได้ในเมนูระดับบนสุดขององค์กร ดังนี้

หากต้องการกำหนดค่าพอร์ทัลเพื่อรองรับการสร้างรายได้ โปรดดูหัวข้อกำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาซอฟต์แวร์

การเพิ่มโหนดเซิร์ฟเวอร์การจัดการลงในการติดตั้ง Monetization

หากคุณเพิ่มเซิร์ฟเวอร์การจัดการลงในการติดตั้ง Edge ที่มีอยู่ คุณต้องตรวจสอบว่าได้เพิ่มบริการการสร้างรายได้ลงในเซิร์ฟเวอร์การจัดการใหม่และกำหนดค่าเซิร์ฟเวอร์การจัดการทั้งหมดเพื่อให้สื่อสารกันได้

วิธีเพิ่มเซิร์ฟเวอร์การจัดการ

1. ติดตั้ง Management Server ใหม่
2. ติดตั้งการสร้างรายได้ในเซิร์ฟเวอร์การจัดการใหม่
3. ในเซิร์ฟเวอร์การจัดการเดิม ให้เรียกใช้คำสั่งต่อไปนี้

   /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. ในเซิร์ฟเวอร์การจัดการใหม่ ให้เรียกใช้คำสั่งต่อไปนี้

   /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 หากต้องการจัดเตรียมเอกสารการเรียกเก็บเงินเป็นไฟล์ PDF คุณสามารถผสานรวมการสร้างรายได้กับระบบการเรียกเก็บเงินที่รองรับการสร้าง 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 ได้

ดูวิธีกำหนดการตั้งค่าองค์กรธุรกิจโดยใช้ UI การจัดการได้ที่หัวข้อเริ่มต้นใช้งานการสร้างรายได้

ขีดจำกัดการสร้างรายได้

หากต้องการบังคับใช้ขีดจำกัดการสร้างรายได้ ให้แนบนโยบายการตรวจสอบขีดจำกัดการสร้างรายได้กับพร็อกซี API กล่าวอย่างเจาะจงคือ นโยบายจะทำงานภายใต้เงื่อนไขต่อไปนี้

• นักพัฒนาแอปที่เข้าถึง API ที่สร้างรายได้ไม่ได้ลงทะเบียนหรือไม่ได้สมัครใช้บริการแพ็กเกจราคา
• นักพัฒนาแอปมีปริมาณธุรกรรมเกินกว่าแพ็กเกจราคาที่สมัครใช้บริการ
• ยอดคงเหลือในบัญชีแบบชำระล่วงหน้าหรือวงเงินเครดิตแบบชำระเงินภายหลังของนักพัฒนาแอปถึงขีดจำกัดแล้ว

นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้จะแจ้งข้อผิดพลาดและบล็อกการเรียก API ในสถานการณ์ต่างๆ เช่นที่ระบุไว้ข้างต้น นโยบายนี้จะขยายการทำงานของนโยบาย Raise Fault และคุณสามารถปรับแต่งข้อความที่แสดงผลได้ เงื่อนไขที่เกี่ยวข้องได้มาจากตัวแปรทางธุรกิจ

ดูข้อมูลเพิ่มเติมได้ที่บังคับใช้ขีดจำกัดการสร้างรายได้ในพร็อกซี API