คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
รวมผลิตภัณฑ์ API อย่างน้อย 1 รายการลงในคอนเทนเนอร์ที่สร้างรายได้รายการเดียว ซึ่งเรียกว่าแพ็กเกจผลิตภัณฑ์ API ดังที่อธิบายไว้ในส่วนต่อไปนี้
แพ็กเกจผลิตภัณฑ์ API คืออะไร
แพ็กเกจผลิตภัณฑ์ API คือคอลเล็กชันของผลิตภัณฑ์ API ที่นำเสนอให้กับนักพัฒนาซอฟต์แวร์เป็นกลุ่ม และโดยทั่วไปจะเชื่อมโยงกับแพ็กเกจราคาอย่างน้อย 1 แพ็กเกจสำหรับการสร้างรายได้ คุณสร้างแพ็กเกจผลิตภัณฑ์ API ได้หลายกลุ่มและรวมผลิตภัณฑ์ API อย่างน้อย 1 รายการไว้ในแต่ละกลุ่ม คุณรวมผลิตภัณฑ์หรือไอเทม API เดียวกันไว้ในแพ็กเกจที่ต่างกันและเชื่อมโยงไอเทมเหล่านั้นกับแพ็กเกจราคาที่แตกต่างกัน (หรือเดียวกัน) ได้
นักพัฒนาแอปสามารถลงทะเบียนแอปเพื่อใช้แพ็กเกจผลิตภัณฑ์ API ได้โดยการซื้อแพ็กเกจราคาใดแพ็กเกจหนึ่งที่มีผลอยู่ในขณะนี้เท่านั้น นักพัฒนาแอปจะไม่เห็นแพ็กเกจผลิตภัณฑ์ API จนกว่าคุณจะเพิ่มและเผยแพร่ (เป็นสาธารณะ) แพ็กเกจราคาสำหรับแพ็กเกจผลิตภัณฑ์ (โดยมีวันที่เริ่มต้นเป็นวันที่ปัจจุบันหรือวันที่ในอนาคต) ตามที่อธิบายไว้ในการจัดการแพ็กเกจราคา หลังจากที่คุณเพิ่มและเผยแพร่แพ็กเกจราคาแล้ว นักพัฒนาแอปที่เข้าสู่ระบบพอร์ทัลนักพัฒนาแอปของคุณจะเลือกแพ็กเกจผลิตภัณฑ์ API และเลือกแพ็กเกจราคาได้ หรือคุณจะยอมรับแพ็กเกจราคาสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้ Management API ก็ได้ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อซื้อแพ็กเกจราคาที่เผยแพร่โดยใช้ API
หลังจากที่เพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API แล้ว คุณอาจต้องกำหนดจุดราคาสำหรับผลิตภัณฑ์ API คุณต้องดำเนินการนี้ก็ต่อเมื่อเงื่อนไขทั้งหมดต่อไปนี้เป็นจริง
- คุณตั้งค่าแผนอัตราส่วนแบ่งรายได้สำหรับผลิตภัณฑ์ API
- นักพัฒนาซอฟต์แวร์จะเรียกเก็บเงินบุคคลที่สามสำหรับการใช้ทรัพยากรในผลิตภัณฑ์ API
- มีการจำกัดจำนวนเงินที่นักพัฒนาแอปเรียกเก็บเงินได้ขั้นต่ำหรือสูงสุด และคุณต้องการแจ้งให้นักพัฒนาแอปทราบเกี่ยวกับข้อจำกัดนี้
ราคาต่ำสุดและสูงสุดจะแสดงในรายละเอียดของแพ็กเกจผลิตภัณฑ์ API
การสำรวจหน้าชุดผลิตภัณฑ์
เข้าถึงหน้าชุดผลิตภัณฑ์ตามที่อธิบายไว้ด้านล่าง
Edge
หากต้องการเข้าถึงหน้ากลุ่มผลิตภัณฑ์ API โดยใช้ Edge UI ให้เลือกเผยแพร่ > การสร้างรายได้ > กลุ่มผลิตภัณฑ์ในแถบนำทางด้านซ้าย
ตามที่ไฮไลต์ในภาพก่อนหน้า หน้ากลุ่มผลิตภัณฑ์จะช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปสำหรับแพ็กเกจผลิตภัณฑ์ทั้งหมด รวมถึงชื่อชุดรายการและผลิตภัณฑ์ API ที่มี
- เพิ่มแพ็กเกจผลิตภัณฑ์
- แก้ไขแพ็กเกจผลิตภัณฑ์
- ค้นหารายการชุดผลิตภัณฑ์ในช่องที่ปรากฏ
คุณสามารถจัดการผลิตภัณฑ์ API ในแพ็กเกจผลิตภัณฑ์หรือลบแพ็กเกจผลิตภัณฑ์ (หากไม่ได้กำหนดแพ็กเกจราคาไว้) โดยใช้ API เท่านั้นได้
Classic Edge (Private Cloud)
หากต้องการเข้าถึงหน้าแพ็กเกจ API โดยใช้ UI ของ Classic Edge ให้เลือกเผยแพร่ > แพ็กเกจในแถบนำทางด้านบน
หน้าแพ็กเกจ API ช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปสำหรับแพ็กเกจ API ทั้งหมด รวมถึงผลิตภัณฑ์ API ที่มีและแผนอัตราค่าบริการที่เกี่ยวข้อง
- เพิ่มแพ็กเกจ API
- แก้ไขแพ็กเกจ API
- เพิ่มและจัดการแพ็กเกจราคา
- สลับการตั้งค่าการเข้าถึงแพ็กเกจราคา (สาธารณะ/ส่วนตัว)
- กรองรายการแพ็กเกจ
คุณจัดการผลิตภัณฑ์ API ในแพ็กเกจ API หรือลบแพ็กเกจ API (หากไม่ได้กำหนดแพ็กเกจราคาไว้) ได้โดยใช้ API เท่านั้น
การเพิ่มแพ็กเกจผลิตภัณฑ์
วิธีเพิ่มแพ็กเกจผลิตภัณฑ์ API
- คลิก + ชุดผลิตภัณฑ์ API ในหน้าชุดผลิตภัณฑ์
- ป้อนชื่อกลุ่มผลิตภัณฑ์ API
ป้อนชื่อของผลิตภัณฑ์ API ในฟิลด์เพิ่มผลิตภัณฑ์
เมื่อพิมพ์ชื่อผลิตภัณฑ์ API รายการผลิตภัณฑ์ API ที่มีสตริงจะแสดงในเมนูแบบเลื่อนลง คลิกชื่อผลิตภัณฑ์ API เพื่อเพิ่มลงในแพ็กเกจ ทำซ้ำเพื่อเพิ่มผลิตภัณฑ์ API อื่นๆ
- ทำซ้ำขั้นตอนที่ 3 เพื่อเพิ่มชื่อผลิตภัณฑ์ API อื่น
- สำหรับผลิตภัณฑ์ API แต่ละรายการที่คุณเพิ่ม ให้กำหนดค่านโยบายการบันทึกธุรกรรม
- คลิกบันทึกกลุ่มผลิตภัณฑ์
การแก้ไขแพ็กเกจผลิตภัณฑ์
วิธีแก้ไขแพ็กเกจผลิตภัณฑ์
ในหน้าชุดผลิตภัณฑ์ ให้คลิกภายในแถวของชุดผลิตภัณฑ์ที่ต้องการแก้ไข
แผงแพ็กเกจผลิตภัณฑ์จะปรากฏขึ้น
แก้ไขช่องแพ็กเกจผลิตภัณฑ์ตามที่จำเป็น
โปรดดูข้อมูลเพิ่มเติมที่กำหนดค่านโยบายการบันทึกธุรกรรม
- คลิกอัปเดตกลุ่มผลิตภัณฑ์
การจัดการชุดผลิตภัณฑ์ API โดยใช้ API
ส่วนต่อไปนี้จะอธิบายวิธีจัดการชุดผลิตภัณฑ์ API โดยใช้ API
การสร้างกลุ่มผลิตภัณฑ์ API โดยใช้ API
หากต้องการสร้างกลุ่มผลิตภัณฑ์ API ให้ส่งคำขอ POST ไปที่ /organizations/{org_name}/monetization-packages
เมื่อส่งคําขอ คุณต้องดำเนินการดังนี้
- ระบุผลิตภัณฑ์ API ที่จะรวมไว้ในแพ็กเกจผลิตภัณฑ์ API
- ระบุชื่อและคำอธิบายสำหรับแพ็กเกจผลิตภัณฑ์ API
- ตั้งค่าตัวบ่งชี้สถานะสำหรับแพ็กเกจผลิตภัณฑ์ API สัญญาณบอกสถานะอาจมีค่าใดค่าหนึ่งต่อไปนี้ CREATED, ACTIVE, INACTIVE ปัจจุบันค่าตัวบ่งชี้สถานะที่คุณระบุจะยังคงอยู่ในกลุ่มผลิตภัณฑ์ API แต่จะไม่นำไปใช้เพื่อวัตถุประสงค์ใดๆ
หรือคุณจะระบุองค์กรก็ได้
ดูพร็อพเพอร์ตี้การกำหนดค่าชุดผลิตภัณฑ์ API สำหรับรายการตัวเลือกที่เปิดเผยต่อ API ดังกล่าว
เช่น
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "description": "payment messaging package", "displayName": "Payment Messaging Package", "name": "Payment Messaging Package", "organization": { "id": "{org_name}" }, "product": [ { "id": "messaging" }, { "id": "payment" } ], "status": "CREATED" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "description" : "payment messaging package", "displayName" : "Payment Messaging Package", "id" : "payment_messaging_package", "name" : "Payment Messaging Package", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "status" : "CREATED" }], "status" : "CREATED" }
โปรดทราบว่าการตอบกลับจะมีข้อมูลเพิ่มเติมเกี่ยวกับผลิตภัณฑ์ API และแอตทริบิวต์ที่กำหนดเองที่ระบุสำหรับผลิตภัณฑ์ API เหล่านั้น (ระบบจะระบุแอตทริบิวต์ที่กำหนดเองเมื่อคุณสร้างผลิตภัณฑ์ API) คุณอาจนำแอตทริบิวต์ที่กำหนดเองของผลิตภัณฑ์ API ไปพิจารณาในแพ็กเกจราคาต่างๆ ได้ เช่น หากคุณสร้างแพ็กเกจเรตการ์ดที่คุณเรียกเก็บค่าใช้จ่ายจากนักพัฒนาซอฟต์แวร์สำหรับธุรกรรมแต่ละรายการ คุณจะกำหนดอัตราของแพ็กเกจตามแอตทริบิวต์ที่กำหนดเองได้ เช่น จำนวนไบต์ที่ส่งในธุรกรรม
การจัดการผลิตภัณฑ์ API ในกลุ่มผลิตภัณฑ์ API โดยใช้ API
คุณเพิ่มหรือลบผลิตภัณฑ์ API จากแพ็กเกจผลิตภัณฑ์ API ได้โดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้
การเพิ่มผลิตภัณฑ์ API ลงในชุดผลิตภัณฑ์ API
หากต้องการเพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API ให้ส่งคำขอ POST ไปยัง organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}
โดยที่ {org_name}
ระบุชื่อองค์กร {package_id}
ระบุชื่อกลุ่มผลิตภัณฑ์ API และ {product_id}
ระบุรหัสของผลิตภัณฑ์ API
เช่น
$ curl -H "Accept:application/json" -X POST -d \ '{}'\ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \ -u email:password
การเพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API ด้วยแพ็กเกจอัตราเฉพาะผลิตภัณฑ์ API
หากต้องการเพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API ที่มีการกำหนดแพ็กเกจอัตราเฉพาะผลิตภัณฑ์ API ไว้อย่างน้อย 1 รายการ (เรตการ์ดหรือส่วนแบ่งรายได้) ให้ส่งคำขอ POST ไปยัง organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}
โดยที่ {org_name}
ระบุชื่อองค์กร {package_id}
จะระบุชื่อกลุ่มผลิตภัณฑ์ API และ {product_id}
ระบุรหัสของผลิตภัณฑ์ API
คุณต้องส่งรายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API ใหม่ในส่วนเนื้อหาของคำขอ ค่าแพ็กเกจราคาต้องตรงกับที่ระบุสำหรับผลิตภัณฑ์ API อื่นๆ ทั้งหมด ยกเว้นอาร์เรย์ ratePlanRates
ดูข้อมูลเพิ่มเติมเกี่ยวกับแอตทริบิวต์แพ็กเกจราคาที่กำหนดได้ที่พร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคา
เช่น
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "mypackage_rateplan1", "ratePlanDetails": [ { "currency": { "id": "usd" }, "duration": 1, "durationType": "MONTH", "meteringType": "UNIT", "organization" : { "id": "{org_name}", "paymentDueDays": "30", "ratePlanRates": [ { "rate": "1.99", "startUnit": "0", "type": "RATECARD" } ], "ratingParameter": "VOLUME", "type": "RATECARD" } ] } ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \ -u email:password
การลบผลิตภัณฑ์ API ออกจากชุดผลิตภัณฑ์ API
หากต้องการลบผลิตภัณฑ์ API ออกจากแพ็กเกจผลิตภัณฑ์ API ให้ส่งคำขอ "ลบ" ไปยัง organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}
โดย {org_name}
ระบุชื่อองค์กรของคุณ, {package_id}
ระบุชื่อกลุ่มผลิตภัณฑ์ API และ {product_id}
ระบุรหัสของผลิตภัณฑ์ API
เช่น
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \ -u email:password
การดูกลุ่มผลิตภัณฑ์ API โดยใช้ API
คุณสามารถดึงข้อมูลชุดผลิตภัณฑ์ API ที่เจาะจงหรือชุดผลิตภัณฑ์ API ทั้งหมดในองค์กรได้ คุณยังเรียกข้อมูลแพ็กเกจผลิตภัณฑ์ API ที่มีธุรกรรมในช่วงวันที่ที่ระบุได้ด้วย กล่าวคือ ต้องเป็นแพ็กเกจที่ผู้ใช้เรียกใช้แอปที่เข้าถึง API ในแพ็กเกจเหล่านั้นภายในวันที่เริ่มต้นและสิ้นสุดที่ระบุไว้เท่านั้น
การดูแพ็กเกจผลิตภัณฑ์ API ที่เจาะจง: หากต้องการเรียกข้อมูลกลุ่มผลิตภัณฑ์ API ที่เจาะจง ให้ส่งคำขอ GET ไปยัง /organizations/{org_name}/monetization-packages/{package_id}
โดยที่ {package_id} คือรหัสของแพ็กเกจผลิตภัณฑ์ API (ระบบจะส่งรหัสมาในคำตอบเมื่อคุณสร้างแพ็กเกจผลิตภัณฑ์ API) เช่น
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment_messaging_package" \ -u email:password
การดูแพ็กเกจผลิตภัณฑ์ API ทั้งหมด: หากต้องการเรียกข้อมูลแพ็กเกจผลิตภัณฑ์ API ทั้งหมดขององค์กร ให้ส่งคำขอ GET ไปยัง /organizations/{org_name}/monetization-packages
เช่น
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \ -u email:password
คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้
พารามิเตอร์การค้นหา | คำอธิบาย |
---|---|
all |
แฟล็กที่ระบุว่าจะส่งคืนแพ็กเกจผลิตภัณฑ์ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจผลิตภัณฑ์ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false |
size |
จำนวนกลุ่มผลิตภัณฑ์ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ |
page |
จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้ |
การตอบกลับสำหรับการดูแพ็กเกจผลิตภัณฑ์ API ทั้งหมดในองค์กรควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคำตอบ)
{ "monetizationPackage" : [ { "description" : "payment messaging package", "displayName" : "Payment Messaging Package", "id" : "payment_messaging_package", "name" : "Payment Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, { "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" }, { "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "Payment", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" } ], "totalRecords" : 3 }
การดูกลุ่มผลิตภัณฑ์ API ที่มีธุรกรรม: หากต้องการเรียกข้อมูลกลุ่มผลิตภัณฑ์ API ที่มีธุรกรรมในช่วงวันที่ที่ระบุ ให้ส่งคำขอ GET ไปที่ /organizations/{org_name}/packages-with-transactions
เมื่อส่งคำขอ คุณต้องระบุวันที่เริ่มต้นและวันที่สิ้นสุดของช่วงวันที่นั้นเป็นพารามิเตอร์การค้นหา ตัวอย่างเช่น คำขอต่อไปนี้ดึงข้อมูลชุดผลิตภัณฑ์ API ที่มีธุรกรรมในช่วงเดือนสิงหาคม 2013
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \ -u email:password
คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)
{ "monetizationPackage" : [ { "description" : "Payment Package", "displayName" : "Payment Package", "id" : "payment_package", "name" : "Payment Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "payment api product", "displayName" : "payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, { "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" }, ... } ] }
การดูชุดผลิตภัณฑ์ API ที่นักพัฒนาซอฟต์แวร์หรือบริษัทยอมรับโดยใช้ API
ดูแพ็กเกจผลิตภัณฑ์ API ที่นักพัฒนาซอฟต์แวร์หรือบริษัทหนึ่งๆ ยอมรับด้วยการส่งคำขอ GET ไปยัง API ต่อไปนี้ตามลำดับ
/organizations/{org_name}/developers/{developer_id}/monetization-packages
โดยที่ {developer_id} คือรหัส (อีเมล) ของนักพัฒนาแอป/organizations/{org_name}/companies/{company_id}/monetization-packages
โดย {company_id} คือรหัสของบริษัท
เมื่อคุณส่งคำขอ คุณจะเลือกระบุพารามิเตอร์การค้นหาต่อไปนี้ได้
พารามิเตอร์การค้นหา | คำอธิบาย | ค่าเริ่มต้น |
---|---|---|
current |
แฟล็กที่ระบุว่าจะเรียกข้อมูลเฉพาะแพ็กเกจผลิตภัณฑ์ API ที่ใช้งานอยู่ (current=true ) หรือแพ็กเกจทั้งหมด (current=false ) แพ็กเกจราคาทั้งหมดในแพ็กเกจที่ใช้งานอยู่จะถือว่าพร้อมให้บริการ |
current=false |
allAvailable |
แฟล็กที่ระบุว่าจะเรียกข้อมูลชุดผลิตภัณฑ์ API ที่มีอยู่ทั้งหมด (allAvailable=true ) หรือเฉพาะแพ็กเกจผลิตภัณฑ์ API ที่พร้อมใช้งานสำหรับนักพัฒนาแอปหรือบริษัท (allAvailable=false ) เท่านั้น
ทั้งหมดที่มีหมายถึงชุดผลิตภัณฑ์ API ที่มีให้กับนักพัฒนาซอฟต์แวร์หรือบริษัทที่ระบุนอกเหนือจากนักพัฒนาซอฟต์แวร์หรือบริษัทอื่นๆ แพ็กเกจผลิตภัณฑ์ API ที่มีไว้สำหรับบริษัทหรือนักพัฒนาซอฟต์แวร์โดยเฉพาะจะมีเฉพาะแพ็กเกจราคาที่พร้อมให้บริการแก่บริษัทหรือนักพัฒนาซอฟต์แวร์ดังกล่าวเท่านั้น |
allAvailable=true |
เช่น คำขอต่อไปนี้จะเรียกชุดผลิตภัณฑ์ API ทั้งหมดที่นักพัฒนาซอฟต์แวร์หนึ่งๆ ยอมรับ
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \ -u email:password
คำขอต่อไปนี้จะเรียกเฉพาะแพ็กเกจ API ที่ใช้งานอยู่ที่บริษัทหนึ่งๆ ยอมรับเท่านั้น
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \ -u email:password
การลบกลุ่มผลิตภัณฑ์ API โดยใช้ API
คุณจะลบแพ็กเกจผลิตภัณฑ์ API ได้ก็ต่อเมื่อไม่ได้กำหนดแพ็กเกจราคาไว้
หากต้องการลบกลุ่มผลิตภัณฑ์ API ที่ไม่ได้กำหนดแพ็กเกจราคาไว้ ให้ส่งคำขอลบไปยัง organizations/{org_name}/monetization-packages/{package_id}
โดย {org_name}
ระบุชื่อองค์กรของคุณและ {package_id}
ระบุชื่อแพ็กเกจผลิตภัณฑ์ API
เช่น
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \ -u email:password
พร็อพเพอร์ตี้การกำหนดค่าชุดผลิตภัณฑ์ API สำหรับ API
ตัวเลือกการกำหนดค่ากลุ่มผลิตภัณฑ์ API ต่อไปนี้จะแสดงใน API ดังกล่าว
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
description |
คำอธิบายชุดผลิตภัณฑ์ API |
ไม่มีข้อมูล | ใช่ |
displayName |
ชื่อที่จะแสดงสำหรับแพ็กเกจผลิตภัณฑ์ API (เช่น ในแคตตาล็อกของแพ็กเกจ API) |
ไม่มีข้อมูล | ใช่ |
name |
ชื่อของแพ็กเกจผลิตภัณฑ์ API |
ไม่มีข้อมูล | ใช่ |
organization |
องค์กรที่มีแพ็กเกจผลิตภัณฑ์ API |
ไม่มีข้อมูล | ไม่ได้ |
product |
อาร์เรย์ของผลิตภัณฑ์อย่างน้อย 1 รายการในแพ็กเกจผลิตภัณฑ์ API |
ไม่มีข้อมูล | ไม่ได้ |
status |
ตัวบ่งชี้สถานะสำหรับแพ็กเกจผลิตภัณฑ์ API สัญญาณบอกสถานะอาจมีค่าใดค่าหนึ่งต่อไปนี้ CREATED, ACTIVE, INACTIVE |
ไม่มีข้อมูล | ใช่ |