จัดการแพ็กเกจราคา

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

จัดการแพ็กเกจราคาโดยใช้ UI และ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การสำรวจหน้าแพ็กเกจราคา

เข้าถึงหน้าแผนราคาตามที่อธิบายไว้ด้านล่าง

การสร้างแพ็กเกจราคา

วิธีสร้างแพ็กเกจราคา

1. เข้าถึงหน้าแผนราคา
2. คลิก +แพ็กเกจราคา
3. กำหนดค่าช่องต่อไปนี้ในแผงด้านบน
   

   ช่อง	คำอธิบาย	ค่าเริ่มต้น	ต้องระบุ
   ชื่อแพ็กเกจราคา	ชื่อแพ็กเกจราคา NOTE: ชื่อต้องไม่ซ้ำกันภายในชุดผลิตภัณฑ์ API แพ็กเกจ 2 รายการในแพ็กเกจผลิตภัณฑ์เดียวกันจะมีชื่อเดียวกันไม่ได้	ไม่มี	ใช่
   ประเภทแพ็กเกจราคา	ประเภทแพ็กเกจราคา เลือกค่าจากรายการแบบเลื่อนลง ดูรายการประเภทแพ็กเกจราคาที่ถูกต้องได้ที่ประเภทแพ็กเกจราคาที่รองรับ	ไม่มี	ใช่
   แพ็กเกจผลิตภัณฑ์	แพ็กเกจผลิตภัณฑ์ API เลือกค่าจากรายการแบบเลื่อนลง ดูข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจผลิตภัณฑ์ API ได้ที่การจัดการแพ็กเกจผลิตภัณฑ์ API หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ คุณต้องเลือกว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการ หรือแพ็กเกจราคาทั่วไปที่จะใช้กับผลิตภัณฑ์ API ทั้งหมด	ไม่มี	ใช่
   กลุ่มเป้าหมาย	กลุ่มเป้าหมายที่เข้าถึงแพ็กเกจราคาได้ เลือกค่าใดค่าหนึ่งต่อไปนี้จากรายการแบบเลื่อนลง ทุกคน - นักพัฒนาแอปทั้งหมด นักพัฒนาแอป - นักพัฒนาแอปหรือบริษัท ป้อนชื่อนักพัฒนาแอปหรือบริษัท ขณะที่คุณพิมพ์ รายชื่อนักพัฒนาแอป/บริษัทที่มีสตริงจะแสดงในเมนูแบบเลื่อนลง คลิกชื่อนักพัฒนาแอปหรือบริษัทจากรายการแบบเลื่อนลง หมวดหมู่นักพัฒนาแอป - หมวดหมู่นักพัฒนาแอป เลือกหมวดหมู่นักพัฒนาแอปจากรายการแบบเลื่อนลง กำหนดค่าหมวดหมู่นักพัฒนาแอปตามที่จำเป็นตามที่อธิบายไว้ในจัดการหมวดหมู่นักพัฒนาแอป	ทุกคน	ไม่
   วันที่เริ่มต้น	วันที่แพ็กเกจราคาจะมีผล ป้อนวันที่เริ่มต้นหรือเลือกวันที่โดยใช้ปฏิทิน	วันนี้	ไม่
   วันที่สิ้นสุด	วันที่แพ็กเกจราคาสิ้นสุด หากต้องการระบุวันที่สิ้นสุด ให้เปิดสวิตช์เปิด/ปิดมีวันที่สิ้นสุด แล้วป้อนวันที่สิ้นสุดหรือเลือกวันที่โดยใช้ปฏิทิน หมายเหตุ: แผนอัตราจะยังคงมีผลจนถึงสิ้นวันในวันที่ที่ระบุ เช่น หากต้องการให้แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2018 คุณควรกำหนดค่า endDate เป็น 2018-11-30 ในกรณีนี้ แผนอัตราจะหมดอายุในวันที่ 30 พฤศจิกายน 2018 และคำขอทั้งหมดในวันที่ 1 ธันวาคม 2018 จะถูกบล็อก	ไม่มี	ไม่
   แสดงต่อพอร์ทัล	ตั้งค่าว่าแพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัว ดูแพ็กเกจอัตราสาธารณะเทียบกับแพ็กเกจอัตราส่วนลดเฉพาะบุคคล	เปิดใช้อยู่	ไม่

4. กำหนดค่าธรรมเนียมสำหรับแพ็กเกจราคา ดูการกำหนดค่าธรรมเนียมสำหรับแพ็กเกจราคา
   NOTE: ใช้ไม่ได้กับแพ็กเกจการแจ้งเตือนที่ปรับได้
5. หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ ให้ตั้งค่ากำหนดต่อไปนี้ในส่วนแผนอัตราเฉพาะหรือทั่วไป
   หมายเหตุ: ขั้นตอนนี้ใช้ไม่ได้กับแผนการแจ้งเตือนที่ปรับได้
   

   ช่อง	คำอธิบาย	ค่าเริ่มต้น
   กำหนดค่าผลิตภัณฑ์แต่ละรายการแยกกัน	Flag ที่ระบุว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่	ปิดใช้
   กำหนดค่าข้อเสนอแบบฟรีเมียมของแต่ละผลิตภัณฑ์แยกกัน	Flag ที่ระบุว่าจะกำหนดค่าแพ็กเกจ Freemium สำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่	ปิดใช้
   เลือกผลิตภัณฑ์	หากเปิดใช้ Flag อย่างใดอย่างหนึ่งหรือทั้ง 2 รายการ คุณต้องเลือกแต่ละผลิตภัณฑ์จากรายการแบบเลื่อนลงและกำหนดค่ารายละเอียดแพ็กเกจราคา NOTE: ตรวจสอบว่าคุณได้กำหนดค่าสินค้าทั้งหมดในแพ็กเกจผลิตภัณฑ์แล้ว	ไม่มี

6. กำหนดค่ารายละเอียดแพ็กเกจราคาตามประเภทแพ็กเกจราคาที่เลือก
   
   • ฟรีเมียม
   • บัตรราคา
   • ส่วนแบ่งรายได้
   • การแจ้งเตือนที่ปรับได้
7. คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
   

   ปุ่ม	คำอธิบาย
   บันทึกเป็นฉบับร่าง	บันทึกแพ็กเกจราคาเป็นฉบับร่าง นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขฟิลด์ใดก็ได้ในแพ็กเกจราคาฉบับร่าง
   เผยแพร่แผนใหม่	เผยแพร่แผน NOTE: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขได้เฉพาะวันที่สิ้นสุดในกรณีที่ยังไม่ได้ตั้งค่า คุณจะลบแพ็กเกจราคาหลังจากที่เผยแพร่แล้วไม่ได้ แต่สามารถทำให้แพ็กเกจราคาหมดอายุและแทนที่ด้วยแพ็กเกจราคาในอนาคตได้ตามที่อธิบายไว้ในทำให้แพ็กเกจราคาที่เผยแพร่แล้วหมดอายุ

8. แนบนโยบายการตรวจสอบขีดจำกัดการสร้างรายได้กับพร็อกซี API ที่เชื่อมโยงกับผลิตภัณฑ์ API ที่รวมอยู่ในแพ็กเกจอัตรา นโยบายการตรวจสอบขีดจํากัดการสร้างรายได้จะบังคับใช้ขีดจํากัดการสร้างรายได้กับพร็อกซี API และตรวจสอบว่าข้อผิดพลาดใดๆ จะได้รับการบันทึกอย่างถูกต้องใน รายงานข้อมูลวิเคราะห์และการสร้างรายได้ ดูข้อมูลเพิ่มเติมได้ที่ บังคับใช้ขีดจำกัดการสร้างรายได้กับพร็อกซี API

การแก้ไขแพ็กเกจราคา

คุณแก้ไขช่องทั้งหมดในแพ็กเกจราคาฉบับร่างได้ ยกเว้นแพ็กเกจผลิตภัณฑ์ ประเภท และกลุ่มเป้าหมาย หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขได้เฉพาะวันที่สิ้นสุดและเฉพาะในกรณีที่ไม่ได้ระบุวันที่สิ้นสุดไว้

วิธีแก้ไขแพ็กเกจราคา

1. เข้าถึงหน้าแผนราคา
2. คลิกในแถวของแพ็กเกจราคาที่ต้องการแก้ไข
   แผงแพ็กเกจราคาจะปรากฏขึ้น
3. แก้ไขฟิลด์แพ็กเกจราคาตามที่จำเป็น
   NOTE: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขได้เฉพาะวันที่สิ้นสุดในกรณีที่ยังไม่ได้ตั้งค่า
4. คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

   ปุ่ม	คำอธิบาย
   อัปเดตฉบับร่าง (แพ็กเกจราคาฉบับร่าง)	บันทึกแพ็กเกจราคาเป็นฉบับร่าง นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขฟิลด์ใดก็ได้ในแพ็กเกจราคาฉบับร่าง
   เผยแพร่ฉบับร่าง (แพ็กเกจราคาฉบับร่าง)	เผยแพร่แพ็กเกจราคา NOTE: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขได้เฉพาะวันที่สิ้นสุดในกรณีที่ยังไม่ได้ตั้งค่า คุณจะลบแพ็กเกจราคาหลังจากที่เผยแพร่แล้วไม่ได้ แต่สามารถทำให้แพ็กเกจราคาหมดอายุและแทนที่ด้วยแพ็กเกจราคาในอนาคตได้ตามที่อธิบายไว้ในทำให้แพ็กเกจราคาที่เผยแพร่แล้วหมดอายุ
   วันที่สิ้นสุดที่อัปเดตแล้ว (แพ็กเกจราคาที่เผยแพร่)	กำหนดวันที่สิ้นสุดสำหรับแผนที่เผยแพร่แล้ว NOTE: หลังจากตั้งวันที่สิ้นสุดสำหรับแพ็กเกจราคาที่เผยแพร่แล้ว คุณจะแก้ไขแพ็กเกจราคาดังกล่าวไม่ได้อีก

การลบแพ็กเกจราคาฉบับร่าง

ลบแพ็กเกจราคาฉบับร่างหากไม่ต้องการใช้แล้ว

หมายเหตุ: คุณลบแพ็กเกจราคาที่เผยแพร่แล้วไม่ได้

วิธีลบแพ็กเกจราคาฉบับร่าง

1. เข้าถึงหน้าแผนราคา
2. วางเคอร์เซอร์เหนือ แพ็กเกจราคาที่ต้องการลบเพื่อแสดงเมนูการดำเนินการ
3. คลิก
4. คลิกลบเพื่อยืนยันการดำเนินการ

การจัดการแพ็กเกจราคาโดยใช้ 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 ลงในmy-packageแพ็กเกจผลิตภัณฑ์ API คุณจะต้องเพิ่มรายละเอียดแพ็กเกจอัตราสำหรับผลิตภัณฑ์ 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

การเผยแพร่แพ็กเกจราคาโดยใช้ API

หากต้องการเผยแพร่แพ็กเกจราคา ให้ตั้งค่าพร็อพเพอร์ตี้ published เป็น true เมื่อสร้าง แพ็กเกจราคา นักพัฒนาแอปจะดูแพ็กเกจราคาได้ตั้งแต่วันที่ที่ระบุในพร็อพเพอร์ตี้ startDate ของแพ็กเกจ

ตัวอย่างเช่น คำสั่งต่อไปนี้จะสร้างแพ็กเกจเรตการ์ดและเผยแพร่ (แสดงเฉพาะส่วนหนึ่งของคำขอ)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

การบันทึกฉบับร่างของแพ็กเกจราคาโดยใช้ API

หากต้องการบันทึกแพ็กเกจราคาโดยไม่เผยแพร่ ให้ตั้งค่าพร็อพเพอร์ตี้ published เป็น false เมื่อสร้างแพ็กเกจราคา

ตัวอย่างเช่น คำสั่งต่อไปนี้จะสร้างแพ็กเกจเรตการ์ดและบันทึกเป็นฉบับร่าง (แสดงเฉพาะส่วนหนึ่งของคำขอ)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

การแก้ไขฉบับร่างของแพ็กเกจราคาโดยใช้ API

หากต้องการอัปเดตฉบับร่างของแพ็กเกจราคา ให้ส่งคำขอ PUT ไปยัง /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} โดยที่{package_id}คือการระบุแพ็กเกจ API และ {plan_Id}คือการระบุแพ็กเกจราคา เมื่อทำการอัปเดต คุณต้อง ระบุการตั้งค่าที่อัปเดตแล้วและรหัสของแพ็กเกจราคาในเนื้อหาคำขอ หากอัปเดต ราคาของแพ็กเกจราคา คุณจะต้องระบุรหัสของราคาแพ็กเกจราคาด้วย ตัวอย่างเช่น คำขอต่อไปนี้ จะอัปเดตราคาแพ็กเกจราคาในแพ็กเกจราคาที่มีรหัสเป็น location_flat_rate_card_plan (การอัปเดตจะไฮไลต์ไว้)

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

การตอบกลับมีราคาของแพ็กเกจราคาที่อัปเดตแล้ว (แสดงเฉพาะส่วนหนึ่งของการตอบกลับ):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

การดูแพ็กเกจราคาโดยใช้ API

คุณดูแพ็กเกจราคาได้โดยใช้ Monetization API ตามที่อธิบายไว้ในส่วนต่อไปนี้

• การดูแพ็กเกจอัตราทั้งหมดขององค์กรโดยใช้ API
• ดูแพ็กเกจผลิตภัณฑ์ API ทั้งหมดโดยใช้ API
• การดูแพ็กเกจผลิตภัณฑ์ API ที่มีอัตราโดยใช้ API
• การดูแผนอัตราทั้งหมดที่ใช้งานอยู่สำหรับนักพัฒนาแอปที่ใช้ API
• การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้ API
• การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API โดยใช้ API
• ดูแพ็กเกจอัตราทั้งหมดที่นักพัฒนาแอปยอมรับโดยใช้ API

การดูแพ็กเกจอัตราทั้งหมด สำหรับองค์กรที่ใช้ API

หากต้องการดูแพ็กเกจอัตราทั้งหมดสำหรับองค์กร ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/rate-plans, โดยที่ {org_name} คือชื่อองค์กรของคุณ

คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

การดูแพ็กเกจอัตราทั้งหมด สำหรับแพ็กเกจผลิตภัณฑ์ API โดยใช้ API

หากต้องการดูแพ็กเกจอัตราทั้งหมดสำหรับแพ็กเกจ API ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, โดยที่ {package_id} คือรหัสของแพ็กเกจ API (ระบบจะแสดงรหัสแพ็กเกจ เมื่อคุณสร้างแพ็กเกจการสร้างรายได้)

โดยค่าเริ่มต้น ระบบจะแสดงเฉพาะแพ็กเกจราคาที่ใช้งานอยู่ สาธารณะ และมาตรฐานในผลการค้นหา วิธีรวม

• สำหรับแพ็กเกจราคาฉบับร่างหรือที่หมดอายุแล้ว ให้ตั้งค่าพารามิเตอร์การค้นหา current เป็น false (เช่น ?current=false)
• แพ็กเกจราคาแบบส่วนตัว ให้ตั้งค่าพารามิเตอร์การค้นหา showPrivate เป็น true (เช่น ?showPrivate=true)
• แพ็กเกจอัตรามาตรฐานทั้งหมด ให้ตั้งค่าพารามิเตอร์การค้นหา standard เป็น true (เช่น ?standard=true)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

การดูแพ็กเกจ API ที่มีอัตรา โดยใช้ API

หากต้องการดูแพ็กเกจอัตราสำหรับแพ็กเกจ API ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} โดยที่ {package_id} คือรหัสของแพ็กเกจ API และ {plan_id} คือ รหัสของแพ็กเกจอัตรา (ระบบจะแสดงรหัสแพ็กเกจเมื่อคุณสร้างแพ็กเกจการสร้างรายได้ และ รหัสแพ็กเกจอัตราจะแสดงเมื่อคุณสร้างแพ็กเกจอัตรา)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

ดู แผนอัตราทั้งหมดที่ใช้งานอยู่สำหรับนักพัฒนาแอปที่ใช้ API

หากต้องการดูแพ็กเกจราคาที่ใช้งานอยู่ทั้งหมดสำหรับนักพัฒนาแอป ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans โดยที่ {developer_id} คืออีเมลของนักพัฒนาแอป

คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

การดูแพ็กเกจราคาที่ ยอมรับสำหรับนักพัฒนาแอปที่ใช้ API

หากต้องการดูแพ็กเกจราคาที่ใช้งานอยู่สำหรับนักพัฒนาแอป ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} โดยที่ {developer_id} คืออีเมลของนักพัฒนาแอป และ {developer_rateplan_id} คือ รหัสของแพ็กเกจราคาที่ยอมรับซึ่งแสดงในคำตอบเมื่อคุณยอมรับแพ็กเกจราคาที่เผยแพร่

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API โดยใช้ API

หากต้องการดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาแอปที่มีผลิตภัณฑ์ API ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product โดยที่ {developer_id} คือรหัสของ นักพัฒนาแอป และ /{product_id} คือรหัสของผลิตภัณฑ์

โดยค่าเริ่มต้น ระบบจะแสดงเฉพาะแพ็กเกจราคาแบบสาธารณะในผลลัพธ์ หากต้องการแสดงแพ็กเกจอัตราส่วนลดเฉพาะบุคคล ให้ตั้งค่าพารามิเตอร์การค้นหา showPrivate เป็น true (เช่น ?showPrivate=true)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

การดูแพ็กเกจอัตราทั้งหมดที่นักพัฒนาแอปยอมรับ โดยใช้ API

หากต้องการดูแพ็กเกจราคาที่นักพัฒนาแอปยอมรับแล้ว ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans โดยที่ {developer_id} คือรหัสของนักพัฒนาแอป

คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

การลบแพ็กเกจราคาฉบับร่างโดยใช้ API

หากต้องการลบแพ็กเกจราคาฉบับร่าง ให้ส่งคำขอ DELETE ไปยัง /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} โดยที่ {plan_Id} คือการระบุแพ็กเกจราคาที่จะลบ และ {package_id} คือการระบุแพ็กเกจ API สำหรับแพ็กเกจราคา เช่น

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

พร็อพเพอร์ตี้การกำหนดค่า สำหรับแพ็กเกจค่าบริการ

เมื่อสร้างแพ็กเกจราคาโดยใช้ API คุณจะระบุการตั้งค่าการกำหนดค่าต่อไปนี้ได้

พร็อพเพอร์ตี้การกำหนดค่าสำหรับรายละเอียดแพ็กเกจราคา

คุณระบุพร็อพเพอร์ตี้การกำหนดค่าต่อไปนี้เป็นส่วนหนึ่งของอาร์เรย์ ratePlanDetails ได้เมื่อสร้างแพ็กเกจราคา