การจัดการชุดผลิตภัณฑ์ API

คุณกำลังดูเอกสารประกอบ 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

การสำรวจหน้าชุดผลิตภัณฑ์

เข้าถึงหน้าชุดผลิตภัณฑ์ตามที่อธิบายไว้ด้านล่าง

การเพิ่มกลุ่มผลิตภัณฑ์

วิธีเพิ่มแพ็กเกจผลิตภัณฑ์ API

1. คลิก + แพ็กเกจผลิตภัณฑ์ API ในหน้าแพ็กเกจผลิตภัณฑ์
2. ป้อนชื่อสำหรับแพ็กเกจผลิตภัณฑ์ API

3. ป้อนชื่อผลิตภัณฑ์ API ในฟิลด์เพิ่มผลิตภัณฑ์

   เมื่อคุณพิมพ์ชื่อผลิตภัณฑ์ API รายการผลิตภัณฑ์ API ที่มีสตริงจะปรากฏในเมนูแบบเลื่อนลง คลิกชื่อผลิตภัณฑ์ API เพื่อเพิ่มลงในแพ็กเกจ ทำซ้ำเพื่อเพิ่มผลิตภัณฑ์ API เพิ่มเติม

4. ทำขั้นตอนที่ 3 ซ้ำเพื่อเพิ่มชื่อผลิตภัณฑ์ API เพิ่มเติม
5. สำหรับผลิตภัณฑ์ API แต่ละรายการที่คุณเพิ่ม ให้กำหนดค่านโยบายการบันทึกธุรกรรม
6. คลิกบันทึกชุดผลิตภัณฑ์

การแก้ไขกลุ่มผลิตภัณฑ์

วิธีแก้ไขแพ็กเกจผลิตภัณฑ์

1. ในหน้าชุดผลิตภัณฑ์ ให้คลิกภายในแถวของกลุ่มผลิตภัณฑ์ที่ต้องการแก้ไข

   แผงกลุ่มผลิตภัณฑ์จะปรากฏขึ้น

2. แก้ไขช่องกลุ่มผลิตภัณฑ์ตามที่จำเป็น

   โปรดดูข้อมูลเพิ่มเติมที่กำหนดค่านโยบายการบันทึกธุรกรรม

3. คลิกอัปเดตแพ็กเกจผลิตภัณฑ์

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

เช่น

$ 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 ให้ส่งคำขอ DELETE ไปยัง 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 ที่เฉพาะเจาะจงหรือ Bundle ผลิตภัณฑ์ 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

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

การตอบกลับสำหรับการดูแพ็กเกจผลิตภัณฑ์ 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} คือรหัสของบริษัท

เมื่อคุณส่งคำขอ คุณสามารถระบุพารามิเตอร์การค้นหาต่อไปนี้หรือไม่ก็ได้

ตัวอย่างเช่น คำขอต่อไปนี้เรียกแพ็กเกจผลิตภัณฑ์ 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 ที่ไม่ได้กำหนดแพ็กเกจราคาไว้ ให้ส่งคำขอ DELETE ถึง 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