คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
บทนำ
คุณสามารถตั้งค่าขีดจำกัดที่เกี่ยวข้องกับการสร้างรายได้ตามที่อธิบายไว้ในหัวข้อการบังคับใช้ขีดจำกัดการสร้างรายได้โดยใช้นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้ นอกจากนี้ คุณยังตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อแจ้งเตือนนักพัฒนาแอป และ/หรือผู้ใช้ในองค์กรเมื่อใกล้ถึงหรือถึงขีดจำกัดแล้วได้ด้วย
คุณสามารถตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดที่กำหนดเองและขีดจำกัดโดยนัยได้ ตัวอย่างเช่น ระบบจะตั้งค่าขีดจำกัดโดยนัยสำหรับนักพัฒนาแอปแบบชำระล่วงหน้า ซึ่งก็คือยอดคงเหลือแบบชำระล่วงหน้า คุณสามารถตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อให้ระบบแจ้งเตือนนักพัฒนาแอปหากยอดเติมเงินใกล้ถึงหรือถึงขีดจำกัดแล้ว
กล่องเครื่องมือ
คุณสามารถตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดได้โดยใช้ UI การจัดการหรือ API การสร้างรายได้ หากใช้ UI คุณจะตั้งค่าการแจ้งเตือนอัตโนมัติในหน้าการแจ้งเตือน
หากใช้ API คุณจะตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดได้โดยการแก้ไขเทมเพลตการแจ้งเตือน ที่การสร้างรายได้มีให้ จากนั้นระบุเงื่อนไขที่จะส่งผลให้มีการส่งการแจ้งเตือนที่เทมเพลตที่แก้ไขแล้วมีให้
การตั้งค่าการแจ้งเตือนขีดจำกัดโดยใช้ UI
- คลิกเพิ่มในส่วนการแจ้งเตือนของหน้าเพิ่มขีดจำกัด ซึ่งจะเปิดส่วนการแจ้งเตือน
- เลือกระดับสำหรับการแจ้งเตือน ซึ่งเป็นเกณฑ์ตามจำนวนสัมบูรณ์หรือ
เปอร์เซ็นต์ของฐานขีดจำกัด เลือกตัวเลือกต่อไปนี้
- เครื่องหมายมากกว่าหรือเท่ากับ (?) หรือเครื่องหมายน้อยกว่าหรือเท่ากับ (?) จาก เมนูแบบเลื่อนลง
- จำนวนเต็ม (ไม่มีทศนิยม) สัมบูรณ์ (เพื่อระบุค่าตัวเลข) หรือ เปอร์เซ็นต์เพื่อระบุค่าเปอร์เซ็นต์ สำหรับขีดจำกัดเปอร์เซ็นต์ ให้ตรวจสอบว่าคุณตั้งค่า ขีดจำกัดเป็น > เสมอ ซึ่งหมายความว่าจะมีการส่งการแจ้งเตือนเมื่อนักพัฒนาแอปถึงหรือ เกินระดับเปอร์เซ็นต์นั้น
ตัวอย่างเช่น หากคุณตั้งค่าขีดจำกัดการใช้จ่ายไว้ที่ $100 และตั้งค่าการแจ้งเตือนไว้ที่มากกว่า หรือเท่ากับ 90% ระบบจะส่งการแจ้งเตือนเมื่อใช้จ่ายถึงหรือเกิน 90% ของขีดจำกัด ($90)
- ในช่องส่งอีเมล ให้เลือกนักพัฒนาแอปอย่างน้อย 1 คน หรือเลือกผู้ใช้ในองค์กรอย่างน้อย 1 คนใน
องค์กรของคุณ ระบบจะส่งการแจ้งเตือนไปยังนักพัฒนาแอปหรือผู้ใช้ที่ได้รับผลกระทบ
ผู้รับอีเมล: คุณจะส่งการแจ้งเตือนไปยังนักพัฒนาแอปได้ก็ต่อเมื่อคุณตั้งค่า เงื่อนไขขีดจำกัดของนักพัฒนาแอปเป็น "ทั้งหมด" หรือตั้งค่าเงื่อนไขขีดจำกัดของนักพัฒนาแอปกับนักพัฒนาแอปที่เฉพาะเจาะจง หากเลือก "ทั้งหมด" คุณจะเห็น "นักพัฒนาแอปที่เลือก (ทั้งหมด)" ในรายการอีเมล ซึ่งหมายความว่าการสร้างรายได้จะส่งการแจ้งเตือนไปยังนักพัฒนาแอปที่ได้รับผลกระทบ หากเลือกนักพัฒนาแอปที่เฉพาะเจาะจง คุณจะเห็น "นักพัฒนาแอปที่เลือก (
{developer_id})" ในรายการอีเมล (โดยที่{developer_id}คือรหัสของนักพัฒนาแอปที่เลือก) การสร้างรายได้ จะส่งการแจ้งเตือนไปยังนักพัฒนาแอปที่เฉพาะเจาะจงรายนั้นเท่านั้นหากคุณไม่ได้เลือกเงื่อนไขขีดจำกัดของนักพัฒนาแอปเป็น "ทั้งหมด" หรือนักพัฒนาแอปที่เฉพาะเจาะจง คุณ จะไม่เห็น "นักพัฒนาแอปที่เลือก (ทั้งหมด)" ในช่องส่งอีเมล อย่างไรก็ตาม คุณสามารถเลือก ผู้ใช้ในองค์กรที่ต้องการแจ้งเตือนได้
คุณเพิ่มอีเมลของผู้ใช้ในองค์กรได้โดยเลือกผู้ใช้ในองค์กร ในแท็บผู้ดูแลระบบ
เทมเพลตอีเมล: คุณจะเห็นเทมเพลตอีเมลหลังจากเลือก "นักพัฒนาแอปที่เลือก (ทั้งหมด)" หรืออีเมลของผู้ใช้ในองค์กร (หรือทั้ง 2 อย่าง) ในช่องส่งอีเมล สิ่งที่จะปรากฏในเทมเพลตขึ้นอยู่กับปัจจัยต่อไปนี้
- ระดับของการแจ้งเตือน
- ขีดจำกัดเป็นขีดจำกัดการหยุดการดำเนินการหรือไม่
- อีเมลมีไว้สำหรับผู้ใช้ในองค์กร นักพัฒนาแอป หรือทั้ง 2 อย่าง
ตัวอย่างเช่น หากเงื่อนไขทั้งหมดต่อไปนี้เป็นจริง
- เลือกช่องทำเครื่องหมายหยุดการดำเนินการ
- ระดับการแจ้งเตือนคือ 100% หรือจำนวนเท่ากับขีดจำกัด
- อีเมลมีไว้สำหรับผู้ใช้ในองค์กรเท่านั้น
เทมเพลตจะมีลักษณะดังนี้
สมมติว่าชื่อบริษัทของนักพัฒนาแอปคือ "บริษัท XYZ" ระบบตั้งค่าขีดจำกัดปริมาณธุรกรรม ไว้ที่ 50 สำหรับแพ็กเกจ API ที่ชื่อ "แพ็กเกจ X" และผลิตภัณฑ์ API ที่ชื่อ "ผลิตภัณฑ์ Y" และตั้งค่าวันที่หมดอายุไว้ที่ 30 กันยายน 2013 ข้อความอีเมลที่จะส่งจะมีลักษณะดังนี้
Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30
หากอีเมลส่งถึง "นักพัฒนาแอปที่เลือก (ทั้งหมด)" เทมเพลตจะปรากฏดังนี้
เทมเพลตทั้ง 2 จะแก้ตัวแปรที่เกี่ยวข้อง เช่น ชื่อนักพัฒนาแอป (หากมี) ชื่อแพ็กเกจ (หากมี) และชื่อผลิตภัณฑ์ (หากมี) คุณสามารถแก้ไขข้อความให้ตรงกับความต้องการได้โดยคลิกแก้ไขทางด้านซ้ายของเทมเพลต
หากขีดจำกัดมีไว้สำหรับแอปพลิเคชัน "ทั้งหมด" หรือแอปพลิเคชันที่เฉพาะเจาะจง และผู้ใช้ "ทั้งหมด" หรือผู้ใช้ที่เฉพาะเจาะจง คุณต้องเพิ่มตัวแปรสำหรับแอปพลิเคชันและผู้ใช้ลงในเทมเพลตด้วย โดยทำดังนี้
- คลิกแก้ไขทางด้านซ้ายของเทมเพลต
- เพิ่ม
${user.name}user, depending on whether the limit is for application and/or user.
เทมเพลตที่แก้ไขสำหรับแอปพลิเคชัน "ทั้งหมด" หรือแอปพลิเคชันที่เฉพาะเจาะจงจะแสดงอยู่ด้านล่าง
หากไม่ได้เลือกหยุดการดำเนินการหรือระดับการแจ้งเตือนมากกว่าหรือเท่ากับ 100% เทมเพลตสำหรับนักพัฒนาแอปที่เลือกจะมีลักษณะดังนี้
อีกครั้ง หากขีดจำกัดมีไว้สำหรับแอปพลิเคชัน "ทั้งหมด" (หรือแอปพลิเคชันที่เฉพาะเจาะจง) หรือผู้ใช้ "ทั้งหมด" (หรือผู้ใช้ที่เฉพาะเจาะจง) คุณต้องแก้ไขเทมเพลต แล้วเพิ่มแอปพลิเคชัน
${application.name}และ/หรือผู้ใช้${user.name}โดยขึ้นอยู่กับว่าขีดจำกัดมีไว้สำหรับแอปพลิเคชัน ผู้ใช้ หรือทั้ง 2 อย่างตัวแปรเทมเพลต: เมื่อแก้ไขข้อความในเทมเพลตอีเมล คุณสามารถใส่ตัวแปรใดก็ได้ต่อไปนี้
ตัวแปร คำอธิบาย ${developer.name}ชื่อนักพัฒนาแอป
${developer.legalName}ชื่อบริษัทของนักพัฒนาแอป
${ratePlan.monetizationPackage.displayName}ชื่อแพ็กเกจ API
${application.name}ชื่อแอปพลิเคชัน
${USER}ชื่อผู้ใช้
${USAGE}การใช้งานปัจจุบัน (รายได้หรือค่าใช้จ่ายทั้งหมด หรือปริมาณ)
${PERCENT}เปอร์เซ็นต์ของขีดจำกัดที่การใช้งานปัจจุบันถึง
${QUOTA_TYPE}ประเภทของขีดจำกัด (ปริมาณธุรกรรม ขีดจำกัดการใช้จ่าย หรือค่าธรรมเนียม)
${QUOTA_UNIT}หน่วยพื้นฐานสำหรับขีดจำกัด ได้แก่ สกุลเงิน (สำหรับวงเงินใช้จ่าย) หรือการเรียก (สำหรับขีดจำกัดการทำธุรกรรม)
${QUOTA_LIMIT}จำนวนขีดจำกัด
${EXPIRY_DATE}วันที่หรือเวลาที่ขีดจำกัดหมดอายุหรือเมื่อขีดจำกัดรีเซ็ต
ตัวอย่างเช่น หากต้องการรับการแจ้งเตือนเมื่อนักพัฒนาแอปถึงเปอร์เซ็นต์ที่กำหนดของปริมาณธุรกรรมสำหรับแพ็กเกจใดก็ตามในแอปพลิเคชันใดก็ตาม คุณสามารถแก้ไขเทมเพลตให้มีลักษณะดังนี้
${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
- เพิ่มการแจ้งเตือนตามที่ต้องการสำหรับระดับเพิ่มเติม โดยคลิกเพิ่มสำหรับแต่ละระดับเพิ่มเติม ซึ่งจะเพิ่มส่วนระดับ ส่งอีเมล และเทมเพลตอีเมลลงในส่วนการแจ้งเตือนของหน้า คุณสามารถเพิ่มระดับสำหรับการแจ้งเตือนได้สูงสุด 6 ระดับ ตัวอย่างเช่น หากคุณตั้งค่าการ แจ้งเตือนเป็น > 70%, 80%, 90%, 100% ระบบจะส่งการแจ้งเตือนเมื่อถึงแต่ละ ระดับเหล่านี้
- หลังจากเพิ่มการแจ้งเตือนทั้งหมดแล้ว ให้คลิกบันทึก (เพื่อบันทึกและเผยแพร่การแจ้งเตือนใน ภายหลัง) บันทึกและเผยแพร่ (เพื่อเผยแพร่เลย) หรือยกเลิก (เพื่อยกเลิก)
การตั้งค่าการแจ้งเตือนขีดจำกัดโดยใช้ API
การสร้างรายได้มีชุดเทมเพลตที่มีข้อความสำหรับการแจ้งเตือนประเภทต่างๆ รวมถึงการแจ้งเตือนขีดจำกัดและการแจ้งเตือนเฉพาะกิจ เช่น การแจ้งเตือนนักพัฒนาแอปเกี่ยวกับผลิตภัณฑ์ใหม่ที่พร้อมให้บริการ คุณสามารถปรับแต่งเทมเพลตเหล่านี้ให้ตรงกับ ความต้องการได้ หากต้องการตั้งค่าการแจ้งเตือนขีดจำกัดอัตโนมัติ ให้แก้ไขเทมเพลตที่เหมาะสมก่อน จากนั้น ระบุเงื่อนไขที่จะส่งผลให้มีการส่งการแจ้งเตือนที่เทมเพลตที่แก้ไขแล้วมีให้ ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อตั้งค่าการแจ้งเตือนโดยใช้ เทมเพลตการแจ้งเตือน
ขั้นตอนถัดไป
ดูวิธีตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อให้คุณแจ้งเตือนนักพัฒนาแอปเกี่ยวกับเหตุการณ์ต่างๆ เช่น ผลิตภัณฑ์ใหม่ ข้อกำหนดและเงื่อนไขเวอร์ชันใหม่ หรือแพ็กเกจราคาใหม่ได้ที่หัวข้อตั้งค่าการแจ้งเตือนโดยใช้เทมเพลตการแจ้งเตือน