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

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

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

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

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

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

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

    หากคุณมีโหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งทั้ง 2 โหนดของเซิร์ฟเวอร์การจัดการ Edge ก่อนติดตั้งการสร้างรายได้

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

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

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

หมายเหตุ

  • ถ้าไฟล์การกำหนดค่า Edge ไม่ได้ระบุข้อมูล SMTP ให้เพิ่มข้อมูลดังกล่าว การสร้างรายได้ต้องใช้เซิร์ฟเวอร์ SMTP
  • ในการติดตั้งศูนย์ข้อมูลเดียว ควรกำหนดค่าโหนด ZooKeeper เป็นจำนวนคี่เป็น voters หากจำนวนโหนด ZooKeeper เป็นจำนวนคู่ ระบบจะกำหนดค่าโหนดบางโหนดเป็น observers เมื่อติดตั้ง Edge ในศูนย์ข้อมูลจํานวนคู่ คุณต้องกําหนดค่าโหนด ZooKeeper บางโหนดเป็น observers เพื่อให้จํานวนโหนดผู้มีสิทธิ์ลงคะแนนเป็นจํานวนคี่ ในระหว่างการเลือกผู้นำ ZooKeeper ระบบจะเลือกโหนดผู้ลงคะแนนเสียง 1 โหนดเป็น leader ตรวจสอบว่าพร็อพเพอร์ตี้ ZK_HOSTS ด้านบนระบุโหนดผู้นำในการติดตั้งศูนย์ข้อมูลหลายแห่ง
  • หากเปิดใช้การตรวจสอบสิทธิ์ Cassandra คุณสามารถส่งชื่อผู้ใช้และรหัสผ่าน Cassandra ได้โดยใช้พร็อพเพอร์ตี้ต่อไปนี้ 
    CASS_USERNAME
CASS_PASSWORD

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

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

  1. หากคุณกำลังติดตั้งการสร้างรายได้ในโทโปโลจี Edge ที่ใช้โหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด โปรดตรวจสอบว่าคุณได้ติดตั้งโหนดเซิร์ฟเวอร์การจัดการทั้ง 2 โหนดก่อนติดตั้งการสร้างรายได้
  2. ในโหนดเซิร์ฟเวอร์การจัดการ ให้เรียกใช้สคริปต์การตั้งค่า
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

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

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

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

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

ผสานรวมบริการสร้างรายได้กับโปรแกรมประมวลผลข้อความทั้งหมด

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

  1. ในโหนด Message Processor โหนดแรก ให้เรียกใช้สคริปต์การตั้งค่าที่พรอมต์คำสั่ง ดังนี้ 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

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

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

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

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

การเตรียมความพร้อมเพื่อรับการสร้างรายได้

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

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

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

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

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

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

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

  1. ติดตั้งเซิร์ฟเวอร์การจัดการใหม่
  2. ติดตั้งการสร้างรายได้ในเซิร์ฟเวอร์การจัดการใหม่
  3. ในเซิร์ฟเวอร์การจัดการเดิม ให้เรียกใช้สิ่งต่อไปนี้ 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. รีสตาร์ทเซิร์ฟเวอร์การจัดการเดิม โดยทำดังนี้ 
    /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. รีสตาร์ทเซิร์ฟเวอร์การจัดการใหม่: 
    /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"
      }
    ]
  }
}

ตารางต่อไปนี้แสดงรายการแอตทริบิวต์ระดับองค์กรที่ใช้กำหนดค่าองค์กรที่สร้างได้

Attributes คำอธิบาย
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 group organization (default is "false")
MINT_HAS_BROKER

ใช้งานไม่ได้ (ค่าเริ่มต้นคือ false)
MINT_TIMEZONE

เขตเวลา (ค่าเริ่มต้นคือ null)
MINT_TAX_ENGINE_EXTERNAL_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

ระบุว่าควรสร้างใบแจ้งหนี้ค่าธรรมเนียมแยกต่างหากหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_ISSUE_NETTING_STMT

ระบุว่าควรออกใบลดหนี้หรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_NETTING_STMT_PER_CURRENCY

ระบุว่าควรสร้างรายการยอดสุทธิต่อสกุลเงินหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_HAS_SELF_BILLING

ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_SELF_BILLING_FOR_ALL_DEV

ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองสำหรับนักพัฒนาแอปทุกรายหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_HAS_SEPARATE_INV_FOR_PROD

ระบุว่าองค์กรมีใบแจ้งหนี้แยกกันสำหรับผลิตภัณฑ์แต่ละรายการหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
MINT_HAS_BILLING_ADJUSTMENT

ระบุว่าองค์กรรองรับการปรับการเรียกเก็บเงินหรือไม่ (ค่าเริ่มต้นคือ "เท็จ")
features.isMonetizationEnabled

UI การจัดการใช้เพื่อแสดงเมนูเฉพาะการสร้างรายได้ (ค่าเริ่มต้นคือ "เท็จ")
ui.config.isOperator

ใช้โดย UI การจัดการเพื่อแสดงผู้ให้บริการเป็นโอเปอเรเตอร์ขององค์กร (ค่าเริ่มต้นคือ "จริง")

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

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

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

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

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

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