แผนอัตราการซื้อโดยใช้ API

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

ส่วนนี้จะอธิบายวิธีซื้อแพ็กเกจราคาที่เผยแพร่แล้ว รวมถึงวิธีหมดอายุหรือยกเลิกแพ็กเกจที่ซื้อ โดยใช้ API ได้ หากต้องการ

การซื้อแพ็กเกจราคาที่เผยแพร่โดยใช้ API

หลังจากเผยแพร่แพ็กเกจราคาแล้ว นักพัฒนาแอปหรือบริษัทจะซื้อ (หรือ "ยอมรับ") ได้ภายในวันที่ ที่ออกคำขอ POST ไปยัง /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, โดยที่ {org_name} คือชื่อองค์กรและ {developer_or_company_id} คือรหัสของนักพัฒนาแอปหรือบริษัท

หากต้องการยกเว้นค่าธรรมเนียมการตั้งค่าเมื่อซื้อแพ็กเกจราคา ให้ตั้งค่าพารามิเตอร์การค้นหา waivefees ไปยัง true การตั้งค่าสถานะนี้มีประโยชน์เมื่อคุณย้ายข้อมูลนักพัฒนาแอปไปยังการสร้างรายได้ เนื่องจาก ที่อธิบายไว้ในการย้ายข้อมูลนักพัฒนาซอฟต์แวร์ไปยัง การสร้างรายได้

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

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
startDate

วันที่ที่แพ็กเกจราคาเริ่มต้น เช่น 2017-03-24

ไม่มี ใช่
endDate

วันที่แพ็กเกจราคาสิ้นสุด เช่น 2017-09-24

แพ็กเกจราคาจะมีผลจนถึงสิ้นสุดวันในวันที่ วันที่ที่ระบุ เช่น ในกรณีที่แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2017 คุณควรกำหนดค่า endDate ถึง 30-11-2017 ด้วยวิธีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันในวันที่ 30 พฤศจิกายน 2017 คำขอทั้งหมด ในวันที่ 1 ธันวาคม 2017 จะถูกบล็อก

ไม่มี ไม่ได้
developer

id พร็อพเพอร์ตี้ที่กำหนดรหัสของนักพัฒนาแอปหรือบริษัทที่ ซื้อแพ็กเกจราคา

ไม่มี ใช่
quotaTarget

จำนวนธุรกรรมเป้าหมายที่อนุญาตสำหรับนักพัฒนาแอป คุณสามารถกําหนดค่าในกรณีที่และ เมื่อมีการส่งการแจ้งเตือนตามเปอร์เซ็นต์ของจำนวนเป้าหมายที่ได้รับ ถึง เช่น 90%, 100% หรือ 150% ธุรกรรมเพิ่มเติมจะไม่ถูกบล็อกหลังจาก ถึงจำนวนเป้าหมายแล้ว

ตั้งค่านี้เป็นจำนวนเต็มบวก หรือ 0 เพื่อปิดใช้การแจ้งเตือนสำหรับแอป

0 ไม่ได้
ratePlan

ที่พัก id ที่กำหนดรหัสของแพ็กเกจราคา

รหัสแพ็กเกจราคาแตกต่างจากชื่อที่แสดง วิธีดูรายละเอียดแพ็กเกจราคา รวมถึงรหัส โปรดดู สำรวจหน้าแพ็กเกจราคา

ไม่มี ใช่
suppressWarning

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

  • true - การสร้างรายได้จะสิ้นสุดแพ็กเกจราคาที่ซื้อทั้งหมดที่ นักพัฒนาซอฟต์แวร์ต้องมีแพ็กเกจ API ที่มีผลิตภัณฑ์ API ที่ขัดแย้งกัน แล้ว ซื้อแพ็กเกจ API ใหม่ให้กับนักพัฒนาซอฟต์แวร์
  • false - เกิดข้อผิดพลาดในกรณีที่มีการซ้อนทับ แพ็กเกจราคา
ไม่มี ไม่ได้
waveTerminationCharge

การแจ้งที่ระบุว่าได้รับการยกเว้นค่าธรรมเนียมในการสิ้นสุดเมื่อใช้แพ็กเกจราคาที่ใช้งานอยู่หรือไม่ สิ้นสุดลงโดยเป็นส่วนหนึ่งของการเปิดใช้งานแพ็กเกจราคาใหม่ ค่าอาจเป็นค่าใดค่าหนึ่ง ดังต่อไปนี้:

  • true - ยกเว้นค่าธรรมเนียมการสิ้นสุดเมื่อมีการสิ้นสุดแพ็กเกจราคาที่ใช้งานอยู่ เป็นส่วนหนึ่งของการเปิดใช้งานแพ็กเกจราคาใหม่
  • false - อย่ายกเว้นค่าธรรมเนียมการสิ้นสุดหากแพ็กเกจราคาที่ใช้งานอยู่คือ สิ้นสุดลงโดยเป็นส่วนหนึ่งของการเปิดใช้งานแพ็กเกจราคาใหม่
ไม่มี ไม่ได้

เช่น คำขอต่อไปนี้ซื้อแพ็กเกจราคา location_&_messaging สำหรับนักพัฒนาซอฟต์แวร์ที่ระบุ

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

ในตัวอย่างนี้ พร็อพเพอร์ตี้ suppressWarning ได้รับการตั้งค่าเป็น false ใน ในกรณีนี้ ระบบจะแสดงข้อผิดพลาดหากเกิดข้อขัดแย้ง ตัวอย่างเช่น หากนักพัฒนาซอฟต์แวร์ ระบบจะแสดงข้อผิดพลาด ช่วงเวลานี้ เปิดใช้งานแอปพลิเคชันที่มีอินเทอร์เฟซผู้ใช้ในการสร้างรายได้เพื่อสกัดกั้นข้อผิดพลาดและ แสดงผลิตภัณฑ์ที่ขัดแย้งกันให้นักพัฒนาซอฟต์แวร์ยืนยัน (ตามความเหมาะสม) ถ้า มีการตั้งค่า suppressWarning เป็น true การสร้างรายได้จะยุติการซื้อทั้งหมด แพ็กเกจที่นักพัฒนาแอปต้องใช้แพ็กเกจ API ที่มีผลิตภัณฑ์ที่ขัดแย้งกัน แล้ว ซื้อแพ็กเกจ API ใหม่ให้กับนักพัฒนาซอฟต์แวร์

คำขอต่อไปนี้ซื้อแพ็กเกจอัตราการแจ้งเตือนที่ปรับได้และกำหนดจำนวนเป้าหมาย ธุรกรรมจำนวน 4,000 รายการ

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

จากตัวอย่างข้างต้น หากข้อความแสดงข้อผิดพลาดต่อไปนี้ปรากฏขึ้น

Developer legal name not specified. 

จากนั้นคุณต้องตั้งค่าแอตทริบิวต์การสร้างรายได้ MINT_DEVELOPER_ADDRESS และ MINT_DEVELOPER_LEGAL_NAME แล้วจึงเรียก API ซ้ำ

แพ็กเกจราคาที่นักพัฒนาแอปซื้อโดยใช้ API ใกล้หมดอายุ

หากต้องการหมดอายุ (หรือยกเลิก) แพ็กเกจราคาที่นักพัฒนาแอปซื้อไว้ ให้อัปเดตแพ็กเกจที่ซื้อ รายละเอียดแพ็กเกจราคาและระบุที่พัก endDate ในส่วนเนื้อหาของคำขอใน คำขอ PUT ไปยัง ทรัพยากร /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id}

แพ็กเกจราคาจะมีผลจนถึงสิ้นวันเมื่อสิ้นสุดวัน วันที่ที่ระบุ เช่น ในกรณีที่แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2017 คุณควร กำหนดค่า endDate ถึง 30-11-2017 ในกรณีนี้ ค่า แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันในวันที่ 30 พฤศจิกายน 2017 คำขอทั้งหมดในวันที่ 1 ธันวาคม ระบบจะบล็อกปี 2017

ระบบจะส่งเงินจำนวน {developer_rateplan_id} กลับมาให้เมื่อคุณทำการซื้อ แพ็กเกจราคาที่เผยแพร่แล้ว

เช่น

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

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

คำขอต่อไปนี้อัปเดตวันที่สิ้นสุดเป็นวันที่ 1 ธันวาคม 2017 ซึ่งก็คือแพ็กเกจราคา จะหมดอายุเมื่อสิ้นสุดวันในวันที่ 30 พฤศจิกายน 2017 คำขอทั้งหมดในวันที่ 1 ธันวาคม 2017 จะ ถูกบล็อก

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'