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

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

รวมผลิตภัณฑ์ 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 มาพิจารณาในแพ็กเกจราคาต่างๆ ได้ For example, if you set up a rate card plan, where you charge the developer for each transaction, you can set the rate for the plan based on a custom attribute such as the number of bytes transmitted in a transaction.

การจัดการผลิตภัณฑ์ 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 ให้ส่งคำขอ 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 ที่เฉพาะเจาะจงหรือชุดผลิตภัณฑ์ 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