คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เกริ่นนำ
คุณสามารถกำหนดขีดจำกัดที่เกี่ยวข้องกับการสร้างรายได้ ตามที่อธิบายไว้ในการบังคับใช้ขีดจำกัดการสร้างรายได้โดยใช้นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้ นอกจากนี้ คุณยังตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อแจ้งเตือนนักพัฒนาแอปและ/หรือผู้ใช้ในองค์กร เมื่อมีการใช้งานใกล้ถึงขีดจำกัดหรือถึงขีดจำกัดได้ด้วย
คุณตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดที่กำหนดเองและขีดจำกัดโดยนัยได้ ตัวอย่างเช่น ระบบกำหนดขีดจำกัดโดยนัยสำหรับนักพัฒนาแอปแบบชำระล่วงหน้าของคุณ ซึ่งก็คือยอดคงเหลือการชำระเงินล่วงหน้าของพวกเขา คุณตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อให้นักพัฒนาแอปได้รับการแจ้งเตือนหาก เงินในบัญชีใกล้ถึงหรือถึงยอดเติมเงินแล้ว
กล่องเครื่องมือ
คุณตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดได้โดยใช้ UI การจัดการหรือ API การสร้างรายได้ หากใช้ UI คุณจะตั้งค่าการแจ้งเตือนอัตโนมัติในหน้าการแจ้งเตือนได้
หากใช้ API คุณจะตั้งค่าการแจ้งเตือนอัตโนมัติสำหรับขีดจำกัดโดยการแก้ไขเทมเพลตการแจ้งเตือนที่ได้จากการสร้างรายได้ จากนั้นคุณจะระบุเงื่อนไขที่ส่งผลให้เกิดการส่งการแจ้งเตือนจากเทมเพลตที่แก้ไขได้
การตั้งค่าการแจ้งเตือนขีดจำกัดโดยใช้ UI
- คลิก เพิ่ม ในส่วน การแจ้งเตือน ของหน้าเพิ่มขีดจำกัด ซึ่งจะเปิดส่วนการแจ้งเตือน
- เลือกระดับของการแจ้งเตือน นี่คือเกณฑ์ที่อิงตามจำนวนสัมบูรณ์หรือเปอร์เซ็นต์ของพื้นฐานขีดจำกัด เลือกดังนี้
- เครื่องหมายมากกว่าหรือเท่ากับเครื่องหมาย (?) หรือน้อยกว่าหรือเท่ากับเครื่องหมาย (?) จากเมนูแบบเลื่อนลง
- จำนวนเต็ม (ไม่มีทศนิยม) สัมบูรณ์ (เพื่อระบุค่าตัวเลข) หรือเปอร์เซ็นต์เพื่อระบุค่าเปอร์เซ็นต์ สำหรับขีดจำกัดของเปอร์เซ็นต์ ให้กำหนดขีดจำกัดเป็น > เสมอ ซึ่งหมายความว่าระบบจะส่งการแจ้งเตือนเมื่อนักพัฒนาแอปดำเนินการถึงหรือข้ามระดับเปอร์เซ็นต์ดังกล่าว
เช่น หากคุณกำหนดวงเงินใช้จ่ายไว้ที่ 3, 000 บาท และตั้งค่าการแจ้งเตือนไว้มากกว่า หรือเท่ากับ 90% ระบบจะส่งการแจ้งเตือนเมื่อมีการใช้จ่ายถึงหรือเกิน 90% ของขีดจำกัด (2,800 บาท)
- ในช่องส่งอีเมล ให้เลือกนักพัฒนาซอฟต์แวร์อย่างน้อย 1 รายหรือเลือกผู้ใช้ในองค์กรอย่างน้อย 1 ราย และจะส่งการแจ้งเตือนไปยังนักพัฒนาแอปหรือผู้ใช้ที่ได้รับผลกระทบ
ผู้รับอีเมล: คุณจะส่งการแจ้งเตือนให้นักพัฒนาซอฟต์แวร์ได้ก็ต่อเมื่อตั้งเงื่อนไขขีดจำกัดสำหรับนักพัฒนาแอปเป็น "ทั้งหมด" หรือตั้งเงื่อนไขขีดจำกัดสำหรับนักพัฒนาแอปไว้กับนักพัฒนาแอปบางราย หากเลือก "ใดๆ" คุณจะเห็น "นักพัฒนาแอปที่เลือก (รายใดก็ได้)" ในรายการอีเมล ซึ่งหมายความว่าการสร้างรายได้จะส่งการแจ้งเตือนไปยังนักพัฒนาแอปที่ได้รับผลกระทบ หากคุณเลือกนักพัฒนาแอปที่เฉพาะเจาะจง คุณจะเห็น "นักพัฒนาแอปที่เลือก (
{developer_id})" ในรายการอีเมล (โดยที่{developer_id}คือตัวระบุนักพัฒนาแอปที่เลือก) การสร้างรายได้จะส่งการแจ้งเตือนไปยังนักพัฒนาแอปรายดังกล่าวเท่านั้นหากคุณไม่ได้เลือกเงื่อนไขขีดจำกัดสำหรับนักพัฒนาแอปเป็น "รายการใดก็ได้" หรือนักพัฒนาแอปที่เฉพาะเจาะจง คุณจะไม่เห็น "นักพัฒนาแอปที่เลือก (ใดๆ)" ในช่อง "ส่งอีเมล" อย่างไรก็ตาม คุณจะเลือกผู้ใช้ขององค์กรที่ต้องการแจ้งเตือนได้
คุณจะเพิ่มอีเมลสำหรับผู้ใช้ในองค์กรได้โดยเลือกผู้ใช้ขององค์กรในแท็บผู้ดูแลระบบ
เทมเพลตอีเมล: คุณจะเห็นเทมเพลตอีเมลหลังจากเลือกช่องส่งอีเมล "นักพัฒนาซอฟต์แวร์ที่เลือก (รายการใดก็ได้)" หรือที่อยู่อีเมลของผู้ใช้ในองค์กร (หรือทั้ง 2 อย่าง) สิ่งที่ปรากฏในเทมเพลตจะขึ้นอยู่กับสิ่งต่อไปนี้
- ระดับการแจ้งเตือน
- ขีดจำกัดเป็นขีดจำกัดในการหยุดการดำเนินการหรือไม่
- อีเมลมีไว้สำหรับผู้ใช้ในองค์กร นักพัฒนาซอฟต์แวร์ หรือทั้ง 2 อย่าง
ตัวอย่างเช่น หากเงื่อนไขทั้งหมดต่อไปนี้เป็นจริง
- เลือกช่องทำเครื่องหมาย "หยุดการดำเนินการ" แล้ว
- ระดับการแจ้งเตือนคือ 100% หรือจำนวนเท่ากับขีดจำกัด
- อีเมลนี้มีไว้สำหรับผู้ใช้ในองค์กรเท่านั้น
เทมเพลตจะมีลักษณะดังนี้
สมมติว่าชื่อบริษัทของนักพัฒนาแอปคือ "บริษัท XYZ" และตั้งขีดจำกัดปริมาณธุรกรรมไว้ที่ 50 สำหรับแพ็กเกจ API ชื่อ "X Package" และผลิตภัณฑ์ API ชื่อ "Y Product" และกำหนดวันที่หมดอายุเป็น 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
การสร้างรายได้มีชุดเทมเพลตที่มีข้อความสำหรับการแจ้งเตือนประเภทต่างๆ รวมถึงการแจ้งเตือนขีดจำกัดและการแจ้งเตือนเฉพาะกิจ เช่น การแจ้งเตือนนักพัฒนาซอฟต์แวร์เกี่ยวกับความพร้อมจำหน่ายของผลิตภัณฑ์ใหม่ คุณปรับแต่งเทมเพลตเหล่านี้ได้ตามต้องการ หากต้องการตั้งค่าการแจ้งเตือนขีดจำกัดอัตโนมัติ ให้แก้ไขเทมเพลตที่เหมาะสมก่อน จากนั้นระบุเงื่อนไขที่ส่งผลให้เกิดการส่งการแจ้งเตือนจากเทมเพลตที่แก้ไข ดูรายละเอียดเพิ่มเติมได้ที่ตั้งค่าการแจ้งเตือนโดยใช้เทมเพลตการแจ้งเตือน
ขั้นตอนถัดไป
ดูวิธีตั้งค่าการแจ้งเตือนอัตโนมัติเพื่อเตือนนักพัฒนาแอปเกี่ยวกับเหตุการณ์ต่างๆ เช่น ผลิตภัณฑ์ใหม่ ข้อกำหนดและเงื่อนไขเวอร์ชันใหม่ หรือแพ็กเกจราคาใหม่ ดูตั้งค่าการแจ้งเตือนโดยใช้เทมเพลตการแจ้งเตือน