บริการสร้างรายได้เป็นส่วนเสริมของ Apigee Edge จึงไม่ได้ทำงานเป็นกระบวนการแบบสแตนด์อโลน โดยจะทำงานภายในการตั้งค่า Apigee Edge ใดก็ได้ที่มีอยู่ ยกเว้นการกำหนดค่า All-In-One (AIO) คุณติดตั้งบริการการสร้างรายได้บนการกำหนดค่า AIO ไม่ได้
ข้อกำหนดการสร้างรายได้
- หากจะติดตั้งการสร้างรายได้บนโทโพโลยี Edge ที่ใช้โหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้งสองโหนดก่อนติดตั้งการสร้างรายได้
- หากต้องการติดตั้งการสร้างรายได้บน Edge ซึ่งการติดตั้ง Edge มีโหนด Postgres หลายโหนด คุณต้องกำหนดค่าโหนด Postgres ในโหมดหลัก/สแตนด์บาย คุณจะติดตั้งการสร้างรายได้บน Edge ไม่ได้หากมีโหนดหลักของ Postgres หลายโหนด ดูข้อมูลเพิ่มเติมได้ที่ตั้งค่าการจำลองในโหมด Master-Standby สำหรับ Postgres
- การสร้างรายได้ไม่พร้อมใช้งานกับการกำหนดค่า All-In-One (AIO)
ภาพรวมการติดตั้ง
ขั้นตอนต่อไปนี้จะแสดงวิธีเพิ่มบริการสร้างรายได้ในการติดตั้ง Apigee Edge ที่มีอยู่
- ใช้ยูทิลิตี
apigee-setup
เพื่ออัปเดตโหนด Apigee Management Server เพื่อเปิดใช้บริการสร้างรายได้ เช่น การจัดการแคตตาล็อก ขีดจำกัดและการกำหนดค่าการแจ้งเตือน การเรียกเก็บเงินและการรายงานหากคุณมีโหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้งสองโหนดก่อนติดตั้งการสร้างรายได้
- ใช้ยูทิลิตี
apigee-setup
เพื่ออัปเดตเครื่องมือประมวลผลข้อความ Apigee เพื่อเปิดใช้คอมโพเนนต์รันไทม์ของบริการสร้างรายได้ เช่น นโยบายการบันทึกธุรกรรมและการบังคับใช้ขีดจำกัด หากคุณมีเครื่องมือประมวลผลข้อความหลายเครื่อง ให้ติดตั้งการสร้างรายได้ในอุปกรณ์ทั้งหมด - ทําตามขั้นตอนการเริ่มต้นใช้งานการสร้างรายได้สําหรับองค์กร Edge
- กำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee (หรือเรียกง่ายๆ ว่าพอร์ทัล) เพื่อรองรับการสร้างรายได้ ดูข้อมูลเพิ่มเติมได้ที่กำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาแอป
การสร้างไฟล์การกำหนดค่าแบบไม่มีเสียงสำหรับการสร้างรายได้
ด้านล่างนี้เป็นตัวอย่างไฟล์การกำหนดค่าแบบไม่มีเสียงสำหรับการติดตั้งการสร้างรายได้ แก้ไขไฟล์นี้ตามที่จำเป็นสำหรับการกำหนดค่า ใช้ตัวเลือก -f เพื่อตั้งค่า.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 ทั้งหมดในฐานะผู้นำโดยค่าเริ่มต้น เมื่อติดตั้ง Edge ในศูนย์ข้อมูลหลายแห่ง ระบบจะกำหนดค่าโหนด ZooKeeper บางรายการเป็นผู้สังเกตการณ์ ตรวจสอบว่าพร็อพเพอร์ตี้ ZK_HOSTS ข้างต้นระบุโหนดผู้นำในการติดตั้งศูนย์ข้อมูลหลายแห่ง
- หากเปิดใช้การตรวจสอบสิทธิ์ Cassandra คุณจะส่งชื่อผู้ใช้และรหัสผ่าน Cassandra ได้โดยใช้พร็อพเพอร์ตี้ต่อไปนี้
CASS_USERNAME CASS_PASSWORD
ผสานรวมบริการสร้างรายได้กับเซิร์ฟเวอร์การจัดการทั้งหมด
ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้บนโหนดเซิร์ฟเวอร์การจัดการ
- หากคุณติดตั้งการสร้างรายได้บนโทโพโลยี Edge ที่ใช้โหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด ให้ตรวจสอบว่าคุณได้ติดตั้งโหนดเซิร์ฟเวอร์การจัดการทั้ง 2 โหนดก่อนติดตั้งการสร้างรายได้
- ในโหนดของเซิร์ฟเวอร์การจัดการ ให้เรียกใช้สคริปต์การตั้งค่าดังนี้
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
ตัวเลือก
-p mo
ระบุให้รวมการสร้างรายได้ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านได้
- หากคุณกำลังติดตั้งการสร้างรายได้บนโหนดเซิร์ฟเวอร์การจัดการหลายโหนด ให้ทำตามขั้นตอนที่ 2 ซ้ำในโหนดที่ 2 ของเซิร์ฟเวอร์การจัดการ
เมื่อมีการกำหนดค่าที่ประสบความสำเร็จ ระบบจะสร้างสคีมา RDBMS สำหรับบริการสร้างรายได้ในฐานข้อมูล PostgreSQL การดำเนินการนี้เป็นการผสานรวมบริการสร้างรายได้และองค์ประกอบที่เชื่อมโยงกับเซิร์ฟเวอร์ Postgres อย่างสมบูรณ์
ผสานรวมบริการสร้างรายได้กับผู้ประมวลผลข้อมูลข้อความทั้งหมด
ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้บนโหนดของผู้ประมวลผลข้อมูลข้อความทั้งหมด
- ในโหนดตัวประมวลผลข้อความแรก ให้เรียกใช้สคริปต์การตั้งค่าที่พรอมต์คำสั่งดังนี้
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
ตัวเลือก
-p mo
ระบุให้รวมการสร้างรายได้ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านได้
- ทำขั้นตอนนี้ซ้ำในโหนด Message Processor ทั้งหมด
เมื่อกำหนดค่าสำเร็จ ผู้ประมวลผลข้อความจะได้รับการอัปเดตด้วยบริการสร้างรายได้ การดำเนินการนี้มีการผสานรวมบริการสร้างรายได้และองค์ประกอบที่เชื่อมโยงกับผู้ประมวลผลข้อความจนเสร็จสมบูรณ์
การเริ่มต้นใช้งานการสร้างรายได้
วิธีสร้างองค์กรใหม่และเปิดใช้การสร้างรายได้
- สร้างองค์กรในลักษณะเดียวกับที่สร้างองค์กรใหม่ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเริ่มร่วมงานกับองค์กร
- ใช้ API การจัดสรรการสร้างรายได้ตามที่อธิบายไว้ในเปิดใช้การสร้างรายได้สำหรับองค์กร หากต้องการดำเนินการนี้ คุณต้องมีสิทธิ์ของผู้ดูแลระบบ
เมื่อคุณเข้าสู่ระบบ Edge UI ในครั้งถัดไป คุณจะเห็นรายการการสร้างรายได้ในเมนูระดับบนสุดขององค์กร
หากต้องการกำหนดค่าพอร์ทัลเพื่อรองรับการสร้างรายได้ โปรดดูกำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาซอฟต์แวร์
การเพิ่มโหนดเซิร์ฟเวอร์การจัดการลงในการติดตั้งการสร้างรายได้
หากเพิ่มเซิร์ฟเวอร์การจัดการลงในการติดตั้ง Edge ที่มีอยู่ คุณต้องเพิ่มบริการสร้างรายได้ไปยังเซิร์ฟเวอร์การจัดการใหม่และกำหนดค่าเซิร์ฟเวอร์การจัดการทั้งหมดเพื่อให้สื่อสารกันได้
วิธีเพิ่มเซิร์ฟเวอร์การจัดการ
- ติดตั้งเซิร์ฟเวอร์การจัดการใหม่
- ติดตั้งการสร้างรายได้ในเซิร์ฟเวอร์การจัดการใหม่
- ในเซิร์ฟเวอร์การจัดการเดิม ให้เรียกข้อความต่อไปนี้
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- รีสตาร์ทเซิร์ฟเวอร์การจัดการเดิม โดยทำดังนี้
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- ในเซิร์ฟเวอร์การจัดการใหม่ ให้เรียกโดยใช้คำสั่งต่อไปนี้
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- รีสตาร์ทเซิร์ฟเวอร์การจัดการใหม่ โดยทำดังนี้
/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)
Attributes | คำอธิบาย |
---|---|
MINT_TAX_MODEL
|
ค่าที่ยอมรับ ได้แก่ "DISCLOSED", "UNDISCLOSED", "HYBRID" (ค่าเริ่มต้นคือ null) |
MINT_CURRENCY
|
รหัสสกุลเงิน ISO (ค่าเริ่มต้นคือ Null) |
MINT_TAX_NEXUS
|
หลักความสัมพันธ์ในการเสียภาษี (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
หมวดหมู่ภาษีผลิตภัณฑ์เริ่มต้น (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_IS_GROUP_ORG
|
การจัดระเบียบกลุ่ม IS (ค่าเริ่มต้นคือ "เท็จ") |
MINT_HAS_BROKER
|
มีความเสียหาย (ค่าเริ่มต้นคือ false) |
MINT_TIMEZONE
|
เขตเวลา (ค่าเริ่มต้นคือ Null) |
MINT_TAX_ENGINE_EXTERNAL_ID
|
รหัสเครื่องมือภาษี (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_COUNTRY
|
ประเทศขององค์กร (ค่าเริ่มต้นคือ Null) |
MINT_REG_NO
|
หมายเลขจดทะเบียนขององค์กรและสหราชอาณาจักรให้หมายเลขที่แตกต่างจากหมายเลขประจำตัวผู้เสียภาษี (ค่าเริ่มต้นคือ null) |
MINT_BILLING_CYCLE_TYPE
|
"PRORATED", "CALENDAR_MONTH" (ค่าเริ่มต้นคือ "CALENDAR_MONTH") |
MINT_SUPPORTED_BILLING_TYPE
|
"ชำระเงินล่วงหน้า"/"ชำระภายหลัง"/"ทั้งคู่" (ค่าเริ่มต้นคือ "ชำระเงินล่วงหน้า") |
MINT_IS_SEPARATE_INV_FOR_FEES
|
ระบุว่าควรสร้างใบแจ้งหนี้ค่าธรรมเนียมแยกต่างหากหรือไม่ (ค่าเริ่มต้นคือ "เท็จ") |
MINT_ISSUE_NETTING_STMT
|
ระบุว่าควรออกคำสั่งสุทธิหรือไม่ (ค่าเริ่มต้นคือ "เท็จ") |
MINT_NETTING_STMT_PER_CURRENCY
|
ระบุว่าควรสร้างใบแจ้งยอดสุทธิต่อสกุลเงินหรือไม่ (ค่าเริ่มต้นคือ "false") |
MINT_HAS_SELF_BILLING
|
ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองหรือไม่ (ค่าเริ่มต้นคือ "เท็จ") |
MINT_SELF_BILLING_FOR_ALL_DEV
|
ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองสำหรับนักพัฒนาแอปทุกรายหรือไม่ (ค่าเริ่มต้นคือ "false") |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
ระบุว่าองค์กรมีใบแจ้งหนี้สำหรับแต่ละผลิตภัณฑ์แยกกันหรือไม่ (ค่าเริ่มต้นคือ "false") |
MINT_HAS_BILLING_ADJUSTMENT
|
ระบุว่าองค์กรรองรับการแก้ไขการเรียกเก็บเงินหรือไม่ (ค่าเริ่มต้นคือ "เท็จ") |
features.isMonetizationEnabled
|
ใช้โดย UI การจัดการเพื่อแสดงเมนูการสร้างรายได้โดยเฉพาะ (ค่าเริ่มต้นคือ "เท็จ") |
ui.config.isOperator
|
ใช้โดย UI การจัดการเพื่อแสดงผู้ให้บริการเป็นโอเปอเรเตอร์กับองค์กร (ค่าเริ่มต้นคือ "จริง") |
สำหรับการกำหนดค่าองค์กรธุรกิจโดยใช้ UI การจัดการ โปรดดูเริ่มต้นใช้งานการสร้างรายได้
ขีดจำกัดการสร้างรายได้
หากต้องการบังคับใช้ขีดจำกัดการสร้างรายได้ โปรดแนบนโยบายการตรวจสอบขีดจำกัดการสร้างรายได้กับพร็อกซี API กล่าวโดยละเอียดคือ จะมีการบังคับใช้นโยบายภายใต้เงื่อนไขต่อไปนี้
- นักพัฒนาแอปที่เข้าถึง API ที่สร้างรายได้ไม่ได้ลงทะเบียนหรือไม่ได้สมัครใช้บริการแพ็กเกจราคา
- นักพัฒนาแอปมีปริมาณธุรกรรมเกินจากแพ็กเกจราคาที่มีการสมัครใช้บริการ
- เงินคงเหลือในบัญชีแบบชำระเงินล่วงหน้าหรือวงเงินเครดิตแบบชำระเงินภายหลังของนักพัฒนาแอปถึงขีดจำกัดแล้ว
นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้จะเพิ่มข้อผิดพลาดและบล็อกการเรียก API ในสถานการณ์ที่ระบุไว้ข้างต้น นโยบายนี้จะขยายขอบเขตของนโยบาย Raise Fault และคุณจะปรับแต่งข้อความที่แสดงผลได้ โดยเงื่อนไขที่เกี่ยวข้องจะมาจากตัวแปรธุรกิจ
สำหรับข้อมูลเพิ่มเติม โปรดดูบังคับใช้ขีดจำกัดการสร้างรายได้บนพร็อกซี API