คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
จัดการแพ็กเกจราคาโดยใช้ UI และ API ตามที่อธิบายไว้ในส่วนต่อไปนี้
การสำรวจหน้าแพ็กเกจราคา
เข้าถึงหน้าแพ็กเกจราคาตามที่อธิบายไว้ด้านล่าง
Edge
หากต้องการดูแพ็กเกจราคาใน Edge UI ให้ไปที่หน้าแพ็กเกจราคาโดยทำดังนี้
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > ให้คะแนนแพ็กเกจในแถบนำทางด้านซ้าย
หน้าแพ็กเกจราคาจะปรากฏขึ้น
ตามที่ไฮไลต์ในรูป หน้าแพ็กเกจราคาช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของแพ็กเกจราคาทั้งหมด รวมถึงชื่อแพ็กเกจ, แพ็กเกจผลิตภัณฑ์ API, สถานะ (ที่เผยแพร่หรือฉบับร่าง) ค่าใช้จ่ายของแพ็กเกจ และวันที่เริ่มต้นและสิ้นสุด
หมายเหตุ: แพ็กเกจราคาที่หมดอายุจะไม่แสดงใน UI หากต้องการดูแพ็กเกจราคาที่หมดอายุแล้ว ให้ใช้ API โปรดดูที่การดูแพ็กเกจราคาโดยใช้ API - สร้างแพ็กเกจราคา
- แก้ไขแพ็กเกจราคา
- เผยแพร่แพ็กเกจราคา
- ลบแพ็กเกจราคาฉบับร่าง
- เพิ่มแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในการจัดการแพ็กเกจราคาในอนาคต
- ค้นหารายการแพ็กเกจราคาในช่องที่มองเห็นได้ หรือชื่อหรือหมวดหมู่นักพัฒนาแอป (หากมี)
คลาสสิก Edge (Private Cloud)
หากต้องการดูแพ็กเกจราคาโดยใช้ Edge UI แบบคลาสสิก ให้ไปที่หน้าแพ็กเกจ API โดยทำดังนี้
- ลงชื่อเข้าใช้
http://ms-ip:9000
โดยที่ ms-ip คือ ที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ - เลือกเผยแพร่ > แพ็กเกจในแถบนำทางด้านบน
หน้าแพ็กเกจ API จะแสดงแพ็กเกจราคาที่กำหนดไว้สำหรับแต่ละแพ็กเกจ
หน้าแพ็กเกจราคาช่วยให้คุณทำสิ่งต่อไปนี้ได้
- สร้างแพ็กเกจราคา
- แก้ไขแพ็กเกจราคา
- เผยแพร่แพ็กเกจราคา
- ลบแพ็กเกจราคาฉบับร่าง
- เพิ่มแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในการจัดการแพ็กเกจราคาในอนาคต
- ค้นหารายการแพ็กเกจราคาในช่องที่มองเห็นได้ หรือชื่อหรือหมวดหมู่นักพัฒนาแอป (หากมี)
การสร้างแพ็กเกจราคา
วิธีสร้างแพ็กเกจราคา
- เข้าถึงหน้าแพ็กเกจราคา
- คลิก +แพ็กเกจราคา
- กําหนดค่าช่องต่อไปนี้ในแผงด้านบน:
ช่อง คำอธิบาย ค่าเริ่มต้น ต้องระบุ ชื่อแพ็กเกจราคา ชื่อของแพ็กเกจราคา หมายเหตุ: ชื่อต้องไม่ซ้ำกันภายในกลุ่มผลิตภัณฑ์ API แพ็กเกจ 2 รายการในแพ็กเกจผลิตภัณฑ์เดียวกันไม่สามารถมีชื่อเดียวกันได้
ไม่มี ใช่ ประเภทแพ็กเกจราคา ประเภทแพ็กเกจราคา เลือกค่าจากรายการแบบเลื่อนลง ดูรายการประเภทแพ็กเกจราคาที่ถูกต้องได้ที่ประเภทแพ็กเกจราคาที่รองรับ ไม่มี ใช่ ชุดผลิตภัณฑ์ แพ็กเกจผลิตภัณฑ์ API เลือกค่าจากรายการแบบเลื่อนลง โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับกลุ่มผลิตภัณฑ์ API ที่การจัดการกลุ่มผลิตภัณฑ์ API หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ คุณต้องเลือกว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการหรือแพ็กเกจราคาทั่วไปที่จะใช้กับผลิตภัณฑ์ API ทั้งหมด
ไม่มี ใช่ ผู้ชม กลุ่มเป้าหมายที่เข้าถึงแพ็กเกจราคาได้ เลือกค่าใดค่าหนึ่งต่อไปนี้จากรายการแบบเลื่อนลง - ทุกคน - นักพัฒนาซอฟต์แวร์ทั้งหมด
- นักพัฒนาแอป - นักพัฒนาแอปหรือบริษัท ป้อนชื่อหรือบริษัทนักพัฒนาแอป ขณะที่คุณพิมพ์ รายชื่อนักพัฒนาซอฟต์แวร์/บริษัทที่มีสตริงนี้จะแสดงในเมนูแบบเลื่อนลง คลิกชื่อนักพัฒนาซอฟต์แวร์หรือบริษัทจากรายการแบบเลื่อนลง
- หมวดหมู่นักพัฒนาซอฟต์แวร์ - หมวดหมู่นักพัฒนาซอฟต์แวร์ เลือกหมวดหมู่นักพัฒนาซอฟต์แวร์จากรายการแบบเลื่อนลง
กำหนดค่าหมวดหมู่นักพัฒนาซอฟต์แวร์ตามที่จำเป็นตามที่อธิบายไว้ในจัดการหมวดหมู่นักพัฒนาซอฟต์แวร์
ทุกคน ไม่ได้ วันที่เริ่มต้น วันที่ที่แพ็กเกจราคามีผลบังคับใช้ ป้อนวันที่เริ่มต้นหรือเลือกวันที่โดยใช้ปฏิทิน วันนี้ ไม่ได้ วันที่สิ้นสุด วันที่แพ็กเกจราคาสิ้นสุด หากต้องการระบุวันที่สิ้นสุด ให้เปิดใช้สวิตช์มีวันที่สิ้นสุด แล้วป้อนวันที่สิ้นสุดหรือเลือกวันที่โดยใช้ปฏิทิน หมายเหตุ: แพ็กเกจราคาจะมีผลจนถึงสิ้นวันในวันที่ที่ระบุ เช่น หากต้องการให้แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2018 คุณควรตั้งค่า endDate เป็น 2018-11-30 ในกรณีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันที่ 30 พฤศจิกายน 2018 คำขอทั้งหมดในวันที่ 1 ธันวาคม 2018 จะถูกบล็อก
ไม่มี ไม่ได้ ปรากฏแก่พอร์ทัล กำหนดว่าแพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัว ดูแพ็กเกจราคาสาธารณะกับส่วนตัว เปิดใช้อยู่ ไม่ได้ - กำหนดค่าค่าธรรมเนียมสำหรับแพ็กเกจราคา ดูการกำหนดค่าค่าธรรมเนียมสำหรับแพ็กเกจราคา
หมายเหตุ: ใช้ไม่ได้กับแพ็กเกจการแจ้งเตือนแบบปรับได้ - หากคุณเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ ให้ตั้งค่ากำหนดต่อไปนี้ในส่วนแพ็กเกจราคาเฉพาะหรือทั่วไป
หมายเหตุ: ขั้นตอนนี้ใช้กับแพ็กเกจการแจ้งเตือนแบบปรับไม่ได้
ช่อง คำอธิบาย ค่าเริ่มต้น กำหนดค่าผลิตภัณฑ์แต่ละรายการ แฟล็กที่ระบุว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้ กําหนดค่าข้อเสนอฟรีเมียมของแต่ละผลิตภัณฑ์ทีละรายการ แฟล็กที่ระบุว่าจะกำหนดค่าแผน Freemium สำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้ เลือกผลิตภัณฑ์ หากเปิดใช้การทำเครื่องหมายรายการใดรายการหนึ่งหรือทั้ง 2 รายการ คุณต้องเลือกผลิตภัณฑ์แต่ละรายการจากรายการแบบเลื่อนลงและกำหนดค่ารายละเอียดแพ็กเกจราคาของผลิตภัณฑ์นั้นๆ หมายเหตุ: ตรวจสอบว่าได้กำหนดค่าผลิตภัณฑ์ทั้งหมดในแพ็กเกจผลิตภัณฑ์แล้ว
ไม่มี - คุณกำหนดค่ารายละเอียดแพ็กเกจราคาตามประเภทแพ็กเกจราคาที่เลือกได้ดังนี้
- คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
ปุ่ม คำอธิบาย บันทึกเป็นฉบับร่าง บันทึกแพ็กเกจราคาเป็นฉบับร่าง นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขช่องใดก็ได้ในแพ็กเกจราคาฉบับร่าง
เผยแพร่แผนใหม่ เผยแพร่แผน หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ก็ต่อเมื่อยังไม่ได้ตั้งค่าแพ็กเกจ คุณจะลบแพ็กเกจราคาหลังจากเผยแพร่ไปแล้วไม่ได้ แต่สามารถหมดอายุของแพ็กเกจราคาและแทนที่ด้วยแพ็กเกจราคาในอนาคตได้ตามที่อธิบายไว้ในส่วนหมดอายุของแพ็กเกจราคาที่เผยแพร่แล้ว
- แนบนโยบายการตรวจสอบขีดจำกัดการสร้างรายได้กับพร็อกซี API ที่เชื่อมโยงกับผลิตภัณฑ์ API ที่รวมอยู่ในแพ็กเกจราคา นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้บังคับใช้ขีดจำกัดการสร้างรายได้บนพร็อกซี API และดูแลให้มีการบันทึกข้อผิดพลาดอย่างถูกต้องใน Analytics และรายงานการสร้างรายได้ สำหรับข้อมูลเพิ่มเติม โปรดดู บังคับใช้ขีดจำกัดการสร้างรายได้ในพร็อกซี API
การแก้ไขแพ็กเกจราคา
คุณแก้ไขทุกช่องในแพ็กเกจราคาฉบับร่างได้ ยกเว้นแพ็กเกจผลิตภัณฑ์ ประเภท และกลุ่มเป้าหมาย หลังจากเผยแพร่แพ็กเกจราคา คุณสามารถแก้ไขวันที่สิ้นสุดได้อย่างเดียว และเฉพาะในกรณีที่ไม่มีการระบุวันที่สิ้นสุดเท่านั้น
วิธีแก้ไขแพ็กเกจราคา
- เข้าถึงหน้าแพ็กเกจราคา
- คลิกในแถวของแพ็กเกจราคาที่ต้องการแก้ไข
แผงแพ็กเกจราคาจะปรากฏขึ้น - แก้ไขช่องแพ็กเกจราคาตามที่จำเป็น
หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ก็ต่อเมื่อยังไม่ได้ตั้งค่าแพ็กเกจ - คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
ปุ่ม คำอธิบาย อัปเดตฉบับร่าง (แพ็กเกจราคาฉบับร่าง) บันทึกแพ็กเกจราคาเป็นฉบับร่าง
นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขช่องใดก็ได้ในแพ็กเกจราคาฉบับร่างเผยแพร่ฉบับร่าง (แพ็กเกจราคาฉบับร่าง) เผยแพร่แพ็กเกจราคา
หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ก็ต่อเมื่อยังไม่ได้ตั้งค่าแพ็กเกจ คุณจะลบแพ็กเกจราคาหลังจากเผยแพร่ไปแล้วไม่ได้ แต่สามารถหมดอายุของแพ็กเกจราคาและแทนที่ด้วยแพ็กเกจราคาในอนาคตได้ตามที่อธิบายไว้ในส่วนหมดอายุของแพ็กเกจราคาที่เผยแพร่แล้ววันที่สิ้นสุดที่อัปเดตแล้ว (แพ็กเกจราคาที่เผยแพร่) กำหนดวันที่สิ้นสุดของแผนที่เผยแพร่แล้ว
หมายเหตุ: คุณจะแก้ไขวันที่สิ้นสุดสำหรับแพ็กเกจราคาที่เผยแพร่ไม่ได้อีกต่อไป
การลบแพ็กเกจราคาฉบับร่าง
ลบแพ็กเกจราคาฉบับร่างหากไม่ต้องการใช้แล้ว
หมายเหตุ: คุณลบแพ็กเกจราคาที่เผยแพร่แล้วไม่ได้
วิธีลบแพ็กเกจราคาฉบับร่าง
- เข้าถึงหน้าแพ็กเกจราคา
- วางเคอร์เซอร์เหนือ แพ็กเกจราคาที่ต้องการลบเพื่อแสดงเมนูการทำงาน
- คลิก
- คลิกลบเพื่อยืนยันการดำเนินการ
การจัดการแพ็กเกจราคาโดยใช้ API
ส่วนต่อไปนี้จะอธิบายวิธีจัดการแพ็กเกจราคาโดยใช้ API
การสร้างแพ็กเกจราคาโดยใช้ API
หากต้องการสร้างแพ็กเกจราคา ให้ส่งคำขอ POST ไปยัง
/organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
,
โดยที่ {monetizationpackage_id}
คือรหัสของแพ็กเกจผลิตภัณฑ์ API ที่คุณสร้าง
แพ็กเกจราคา (ระบบจะส่งคืนรหัสในการตอบกลับเมื่อคุณสร้างกลุ่มผลิตภัณฑ์ API)
เมื่อสร้างแพ็กเกจราคา คุณต้องระบุข้อมูลต่อไปนี้ในส่วนเนื้อหาของคำขอ
- รหัสองค์กร
- รหัสกลุ่มผลิตภัณฑ์ API
- ชื่อของแพ็กเกจราคา
- คำอธิบายของแพ็กเกจราคา
- ขอบเขตของแพ็กเกจราคา (ไม่ว่าจะใช้ได้กับนักพัฒนาแอปทุกรายหรือเฉพาะกับ นักพัฒนาซอฟต์แวร์ บริษัท หรือหมวดหมู่นักพัฒนาซอฟต์แวร์)
- วันที่แพ็กเกจราคามีผลบังคับใช้
- สกุลเงินสำหรับแพ็กเกจราคา
- จะเผยแพร่แพ็กเกจราคาหรือไม่
- แพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัว
มีการตั้งค่าอื่นๆ ที่สามารถระบุได้ เช่น ระยะเวลาที่ชําระเงิน ครบกำหนด (เช่น 30 วัน) ดูที่พักการกำหนดค่าสำหรับแพ็กเกจราคา
หากคุณสร้างแพ็กเกจราคา (นอกเหนือจากแพ็กเกจค่าธรรมเนียมเท่านั้น) สำหรับแพ็กเกจผลิตภัณฑ์ API ที่ราคา 1 รายการ คุณสามารถใช้แพ็กเกจกับผลิตภัณฑ์ที่เฉพาะเจาะจงในแพ็กเกจผลิตภัณฑ์ได้ คุณดำเนินการนี้โดย ระบุผลิตภัณฑ์ในคำขอ หากคุณไม่ได้ระบุผลิตภัณฑ์ แผนจะเป็น ที่ใช้กับผลิตภัณฑ์ทั้งหมดในแพ็กเกจผลิตภัณฑ์ API
ส่วนต่อไปนี้อธิบายวิธีสร้างแพ็กเกจราคา
- การสร้างแพ็กเกจราคามาตรฐานโดยใช้ API
- การสร้างแผนราคาสำหรับนักพัฒนาซอฟต์แวร์หรือบริษัทโดยใช้ API
- การสร้างแพ็กเกจราคาหมวดหมู่นักพัฒนาแอปโดยใช้ API
- การสร้างแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API โดยใช้ API
- การตั้งค่าแพ็กเกจราคาเป็นสาธารณะหรือส่วนตัวโดยใช้ API
การสร้างแพ็กเกจราคามาตรฐานโดยใช้ API
หากต้องการสร้างแพ็กเกจราคามาตรฐาน ให้ตั้งค่าแอตทริบิวต์ type
เป็น STANDARD
ดังที่ปรากฏในตัวอย่างต่อไปนี้
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
การสร้างแผนราคาของนักพัฒนาซอฟต์แวร์หรือบริษัทโดยใช้ API
หากต้องการใช้แพ็กเกจราคากับนักพัฒนาแอปหรือบริษัทที่เจาะจง ให้ตั้งค่า type
เป็น
Developer
คุณต้องระบุนักพัฒนาซอฟต์แวร์หรือบริษัทในคำขอด้วย
ที่ระบุรหัส ชื่อตามกฎหมาย และชื่อนักพัฒนาซอฟต์แวร์ของบริษัท
ตัวอย่างเช่น ข้อความที่ตัดตอนมาต่อไปนี้สร้างแพ็กเกจราคาสําหรับ Dev Five
นักพัฒนาซอฟต์แวร์:
... "type": "DEVELOPER", "developer" : { "id" : "0mkKu1PALUGfjUph", "legalName" : "DEV FIVE", "name" : "Dev Five" } ...
การสร้างแพ็กเกจราคาหมวดหมู่นักพัฒนาแอปโดยใช้ API
หากต้องการใช้แพ็กเกจราคากับหมวดหมู่นักพัฒนาแอป ให้ตั้งค่า type
เป็น
Developer_Category
คุณจะต้องระบุหมวดหมู่นักพัฒนาซอฟต์แวร์ในคำขอด้วย
เช่น
... "type": "DEVELOPER_CATEGORY", "developerCategory" : { "id" : "5e172299-8232-45f9-ac46-40076139f373", "name" : "Silver", "description" : "Silver category" } ...
การสร้างแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API โดยใช้ API
เมื่อสร้างแพ็กเกจราคาสำหรับกลุ่มผลิตภัณฑ์ API ที่มีผลิตภัณฑ์ API หลายรายการ คุณจะระบุรายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API ทีละรายการได้
ตัวอย่างต่อไปนี้เป็นการสร้างแผนส่วนแบ่งรายได้ที่มีผลิตภัณฑ์ API 2 รายการ
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Multi-product rate plan", "currency": { "id" : "usd" }, "description": "Multi-product rate plan", "displayName" : "Multi-product rate plan", "monetizationPackage": { "id": "mypackage", ... }, "organization": { "id": "{org_name}", ... }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":0, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product1","displayName":"Product1"}, "customPaymentTerm":false }, { "ratePlanRates":[{ "revshare":10, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product2","displayName":"Product2"}, "customPaymentTerm":false } ], "startDate": "2019-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \ -u email:password
หากต้องการเพิ่มผลิตภัณฑ์ API ไปยังแพ็กเกจผลิตภัณฑ์ API my-package
คุณจะต้องเพิ่ม
รายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API ในส่วนเนื้อหาของคำขอ ตามที่อธิบายไว้ในการเพิ่มผลิตภัณฑ์ API ไปยังแพ็กเกจผลิตภัณฑ์ API ด้วยแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "my-package_multi-product-rate-plan", "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":20, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "customPaymentTerm":false }] }] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \ -u email:password
ตั้งค่าแพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัวโดยใช้ API
เมื่อสร้างแพ็กเกจราคา คุณจะระบุได้ว่าแพ็กเกจดังกล่าวเป็นแบบสาธารณะหรือแบบส่วนตัวโดยใช้
isPrivate
ในส่วนเนื้อหาของคำขอ หากตั้งค่าเป็น true
แพ็กเกจราคา
จะเป็นแบบส่วนตัว สำหรับข้อมูลเพิ่มเติม โปรดดูที่สาธารณะ
เทียบกับแพ็กเกจราคาส่วนตัว
ตัวอย่างต่อไปนี้สร้างแพ็กเกจราคาส่วนตัว
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : true, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password