ตั้งค่าการแจ้งเตือนโดยใช้เทมเพลตการแจ้งเตือน

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

เทมเพลตการแจ้งเตือนคืออะไร

การสร้างรายได้มีชุดเทมเพลตที่ระบุข้อความตัวอย่างสำหรับการแจ้งเตือนเหตุการณ์ประเภทต่างๆ คุณปรับแต่งเทมเพลตต่อไปนี้ได้

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

หรือจะสร้างเว็บฮุคที่กำหนดเครื่องจัดการการเรียกกลับของ HTTP แล้วกำหนดค่าเงื่อนไขที่ทริกเกอร์เว็บฮุคตามที่อธิบายไว้ในหัวข้อตั้งค่าการแจ้งเตือนโดยใช้เว็บฮุคก็ได้

การสำรวจหน้าการแจ้งเตือน

เข้าถึงหน้าการแจ้งเตือนตามที่อธิบายไว้ด้านล่าง

Edge

วิธีเข้าถึงหน้าการแจ้งเตือนโดยใช้ Edge UI

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกเผยแพร่ > การสร้างรายได้ > การแจ้งเตือนในแถบนำทางด้านซ้าย

หน้าการแจ้งเตือนจะปรากฏขึ้น

ตามที่ไฮไลต์ในรูป หน้าการแจ้งเตือนช่วยให้คุณทำสิ่งต่อไปนี้ได้

Classic Edge (Private Cloud)

วิธีเข้าถึงหน้าการแจ้งเตือนโดยใช้ UI แบบคลาสสิกของ Edge

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ

  2. เลือกผู้ดูแลระบบ > การแจ้งเตือนในแถบนำทางด้านบน

หน้าการแจ้งเตือนช่วยให้คุณทำสิ่งต่อไปนี้ได้

การแก้ไขการแจ้งเตือน

วิธีแก้ไขการแจ้งเตือนโดยใช้ UI

  1. ไปที่หน้าการแจ้งเตือน
  2. คลิก ที่อยู่ติดกับการแจ้งเตือนที่ต้องการแก้ไขเพื่อขยายรายละเอียด
  3. แก้ไขช่องเรื่อง เนื้อหา และผู้รับ (หากมี) ตามต้องการ

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

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

  4. เปิดใช้การแจ้งเตือนโดยเลือกช่องทำเครื่องหมายที่อยู่ติดกับการแจ้งเตือนนั้น
  5. ทำซ้ำขั้นตอนที่ 2 ถึง 4 เพื่อแก้ไขการแจ้งเตือนเพิ่มเติม
  6. คลิกบันทึกเพื่อบันทึกการเปลี่ยนแปลงทั้งหมด

ข้อความจะปรากฏขึ้นเพื่อยืนยันว่าบันทึกการแจ้งเตือนแล้ว การบันทึกอาจใช้เวลาสักครู่

การแก้ไขการแจ้งเตือนเพื่อแจ้งเตือนนักพัฒนาซอฟต์แวร์ทั้งหมด

ระบบจะส่งการแจ้งเตือนสำหรับประเภทเหตุการณ์ที่คุณเลือกในส่วนแจ้งเตือนนักพัฒนาซอฟต์แวร์ทั้งหมดไปยังนักพัฒนาซอฟต์แวร์ทุกราย

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

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

ประเภทเหตุการณ์ ทริกเกอร์ Notes
แพ็กเกจใหม่ แพ็กเกจ API ใหม่พร้อมใช้งานแล้ว

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

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

เพิ่มชื่อของแต่ละตลาดและผลิตภัณฑ์ที่เกี่ยวข้องในส่วนเนื้อหาของเทมเพลตอีเมลเป็นส่วนหนึ่งของการอัปเดต และยังเพิ่มลิงก์ไปยังพอร์ทัลนักพัฒนาซอฟต์แวร์หรือเว็บไซต์อื่นๆ ที่ให้ข้อมูลเพิ่มเติมเกี่ยวกับการแจ้งเตือนได้ด้วย

การแก้ไขการแจ้งเตือนเพื่อแจ้งเตือนนักพัฒนาซอฟต์แวร์ที่ได้รับผลกระทบ

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

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

ประเภทเหตุการณ์ ทริกเกอร์ Notes
ไม่ยอมรับข้อกำหนดในการให้บริการหรือหมดอายุแล้ว เผยแพร่ข้อกำหนดและเงื่อนไขชุดใหม่แล้ว และนักพัฒนาแอปยังไม่ได้ยอมรับข้อกำหนดดังกล่าว

โดยระบบจะส่งการแจ้งเตือน 30 วัน, 7 วัน และ 1 วันก่อนที่ข้อกำหนดและเงื่อนไขใหม่จะมีผลบังคับใช้
แพ็กเกจราคาใหม่ เผยแพร่แพ็กเกจราคาใหม่แล้ว

หากแพ็กเกจราคาเป็น

  • แพ็กเกจ Standard นักพัฒนาแอปทุกรายจะได้รับแจ้ง
  • แพ็กเกจราคาสําหรับหมวดหมู่นักพัฒนาซอฟต์แวร์ ระบบจะแจ้งเตือนนักพัฒนาแอปในหมวดหมู่นั้นเท่านั้น
  • แพ็กเกจราคาสําหรับนักพัฒนาแอป ระบบจะแจ้งเตือนนักพัฒนาแอปที่เฉพาะเจาะจงเท่านั้น
แพ็กเกจอัตราที่แก้ไข มีแพ็กเกจราคาเวอร์ชันใหม่กว่าแล้ว

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

ระบบจะส่งการแจ้งเตือนนี้เมื่อคุณเริ่มกำหนดให้แพ็กเกจราคาหมดอายุ โดยส่งการแจ้งเตือนเพิ่มเติม 30, 7 และ 1 วันก่อนวันที่หมดอายุ เฉพาะนักพัฒนาแอปที่ซื้อแพ็กเกจราคาจะหมดอายุเท่านั้นที่จะได้รับการแจ้งเตือน
แพ็กเกจราคาต่ออายุ ต่ออายุการสมัครใช้แพ็กเกจราคาแล้ว

แจ้งให้นักพัฒนาแอปทราบว่าจะมีการเรียกเก็บค่าธรรมเนียมที่เกี่ยวข้อง
เกินขีดจำกัดของอัตรา คุณใช้แพ็กเกจราคาเกินขีดจำกัดแล้ว

แจ้งให้นักพัฒนาแอปทราบว่าจะมีการเรียกเก็บค่าธรรมเนียมที่เกี่ยวข้อง
แพ็กเกจอัตรา Freemium ที่หมดแล้ว ช่วงใช้งานฟรีซึ่งวัดจากจำนวนธุรกรรมหรือจำนวนวันหมดแล้ว

ระยะเวลาการใช้งานฟรีจะกำหนดตามแพ็กเกจราคาฟรีเมียมของคุณ
เผยแพร่เอกสารการเรียกเก็บเงินแล้ว

มีเอกสารการเรียกเก็บเงิน (เช่น ใบแจ้งหนี้) สำหรับนักพัฒนาแอป
นักพัฒนาแอปลงชื่อสมัครใช้แพ็กเกจราคาใหม่ นักพัฒนาแอปลงชื่อสมัครใช้แพ็กเกจราคาใหม่

การแก้ไขการแจ้งเตือนเป็นแจ้งผู้ให้บริการ API

ระบบจะส่งการแจ้งเตือนสำหรับประเภทเหตุการณ์ที่คุณเลือกในส่วนแจ้งเตือนผู้ให้บริการ API ไปยังผู้ให้บริการ API ที่คุณระบุ

ตารางต่อไปนี้จะแสดงการแจ้งเตือนตามประเภทเหตุการณ์ในส่วนแจ้งเตือนผู้ให้บริการ API ดูข้อมูลเพิ่มเติมได้ที่การแก้ไขการแจ้งเตือนโดยใช้ UI

ประเภทเหตุการณ์ ทริกเกอร์
การลงชื่อสมัครใช้สำหรับนักพัฒนาซอฟต์แวร์ใหม่

นักพัฒนาซอฟต์แวร์ได้ลงทะเบียนบัญชีแล้ว
นักพัฒนาแอปเพิ่มแอป

นักพัฒนาซอฟต์แวร์สร้างแอปพลิเคชันใหม่แล้ว
ลงชื่อสมัครใช้แพ็กเกจราคาใหม่สำหรับนักพัฒนาซอฟต์แวร์

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

นักพัฒนาแอปได้เปลี่ยนรายละเอียดทางการเงิน เช่น ชื่อบริษัทหรือที่อยู่บริษัท

การเปิดใช้หรือปิดใช้การแจ้งเตือน

หากต้องการเปิดหรือปิดใช้การแจ้งเตือนโดยใช้ UI ให้ทำดังนี้

  1. ไปที่หน้าการแจ้งเตือน
  2. เปิดหรือปิดการแจ้งเตือนโดยการเลือกหรือยกเลิกการเลือกช่องทำเครื่องหมายที่อยู่ติดกัน ตามลำดับ
  3. คลิกบันทึกเพื่อบันทึกการเปลี่ยนแปลงทั้งหมด

การบันทึกอาจใช้เวลาสักครู่ ข้อความจะปรากฏขึ้นเพื่อยืนยันว่าบันทึกการแจ้งเตือนแล้ว

การตั้งค่าการแจ้งเตือนโดยใช้เทมเพลตโดยใช้ API

ตั้งค่าการแจ้งเตือนโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การจัดการเทมเพลตการแจ้งเตือนโดยใช้ API

จัดการเทมเพลตการแจ้งเตือนโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การดูเทมเพลตการแจ้งเตือนทั้งหมดที่ใช้ API

คุณระบุเทมเพลตการแจ้งเตือนทั้งหมดที่การสร้างรายได้มีให้โดยการส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/notification-email-templates เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

ตัวอย่างเช่น ต่อไปนี้เป็นเทมเพลตเหตุการณ์ที่แจ้งนักพัฒนาแอปเกี่ยวกับความพร้อมใช้งานของผลิตภัณฑ์ API ใหม่

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

การดูเทมเพลตการแจ้งเตือนโดยใช้ API

ดูเทมเพลตการแจ้งเตือนโดยการส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/notification-email-templates/{template_id} โดยที่ {template_id} คือรหัสของเทมเพลต เช่น

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

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

  • ${developer.legalName}.XYZ company
  • ${developer.name}.DEV1
  • ${QUOTA_TYPE}.Transactions
  • ${PERCENT}.90%
  • ${QUOTA_UNIT}.Calls
  • ${QUOTA_LIMIT}.100
  • ${ratePlan.monetizationPackage.products.name}.X
  • ${EXPIRY_DATE}.2016-09-30

ข้อความแจ้งเตือนจากเทมเพลตจะเป็นดังนี้

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

การแก้ไขเทมเพลตการแจ้งเตือนโดยใช้ API

แก้ไขเทมเพลตการแจ้งเตือนโดยการส่งคำขอ PUT ไปยัง /nint/organizations/{org_name}/notification-email-templates/{template_id} ระบุเนื้อหาที่เปลี่ยนแปลงของเทมเพลตในส่วนเนื้อหาของคำขอ

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

ตัวอย่างเช่น คำขอต่อไปนี้แก้ไขเนื้อหาการแจ้งเตือนของผลิตภัณฑ์ API ใหม่

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

การจัดการเงื่อนไขและการดำเนินการการแจ้งเตือนโดยใช้ API

จัดการเงื่อนไขและการดำเนินการการแจ้งเตือนโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การสร้างเงื่อนไขการแจ้งเตือนและการดำเนินการโดยใช้ API

สร้างเงื่อนไขการแจ้งเตือนและการดำเนินการที่ส่งผลให้เกิดการแจ้งเตือนอัตโนมัติด้วยการส่งคำขอ POST ไปยัง /mint/organizations/{org_name}/notification-conditions

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

คุณระบุรายละเอียดของเงื่อนไขการแจ้งเตือนได้โดยการระบุค่าแอตทริบิวต์อย่างน้อย 1 รายการ โปรดดูรายการแอตทริบิวต์ในพร็อพเพอร์ตี้การกำหนดค่าสำหรับเงื่อนไขการแจ้งเตือน สำหรับการแจ้งเตือนเหตุการณ์ ระบบอาจทริกเกอร์เงื่อนไขเมื่อเผยแพร่ผลิตภัณฑ์ใหม่

เมื่อกำหนด actions ให้อ้างอิงเทมเพลตการแจ้งเตือนที่เกี่ยวข้อง ดูรายการการดําเนินการได้ที่พร็อพเพอร์ตี้การกําหนดค่าสําหรับการดําเนินการการแจ้งเตือน

ตัวอย่างเช่น คำขอต่อไปนี้ระบุว่าเมื่อแอตทริบิวต์คือ NEW_PRODUCT และค่าของแอตทริบิวต์ PUBLISHED คือ true ให้ส่งการแจ้งเตือนในเทมเพลตพร้อมรหัส 01191bf9-5fdd-45bf-8130-3f024694e63 (หรือ DEFAULT_NEW_PRODUCT_TEMPLATE)

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

การดูเงื่อนไขการแจ้งเตือนและการดำเนินการโดยใช้ API

ดูเงื่อนไขการแจ้งเตือนและการดำเนินการโดยการส่งคำขอ GET ไปยัง organizations/{org_name}/notification-conditions/{condition_Id} โดยที่ {condition_Id} คือรหัสของเงื่อนไข ระบบจะส่งรหัสกลับมาเมื่อคุณสร้างเงื่อนไขการแจ้งเตือน เช่น

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

ตัวอย่างการตอบกลับมีดังนี้

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

การแก้ไขเงื่อนไขการแจ้งเตือนและการดำเนินการโดยใช้ API

แก้ไขเงื่อนไขการแจ้งเตือนและการดำเนินการโดยการส่งคำขอ POST ไปยัง organizations/{org_name}/notification-conditions/{condition_Id} โดยที่ {condition_Id} คือรหัสของเงื่อนไข ระบบจะส่งรหัสกลับมาเมื่อคุณสร้างเงื่อนไขการแจ้งเตือน เมื่อส่งคําขอ ให้ระบุการเปลี่ยนแปลงที่ต้องการทํากับเงื่อนไขหรือการดําเนินการการแจ้งเตือนในส่วนเนื้อหาของคําขอ

เช่น

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

การลบเงื่อนไขการแจ้งเตือนและการดำเนินการโดยใช้ API

ลบเงื่อนไขการแจ้งเตือนโดยการส่งคำขอลบไปยัง organizations/{org_name}notification-conditions/{condition_Id} เช่น

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

พร็อพเพอร์ตี้การกำหนดค่าสำหรับเงื่อนไขการแจ้งเตือน

พร็อพเพอร์ตี้การกำหนดค่าสำหรับเงื่อนไขการแจ้งเตือนต่อไปนี้จะพร้อมใช้งานเมื่อใช้ API

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

รายละเอียดของเงื่อนไขการแจ้งเตือน คุณระบุแอตทริบิวต์อย่างน้อย 1 รายการเพื่อปรับแต่งเงื่อนไขการแจ้งเตือนได้

ค่าอาจเป็นค่าต่อไปนี้อย่างน้อย 1 ค่า

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (ใช้ได้กับการกำหนดค่าเว็บฮุคเท่านั้น)
 ไม่มีข้อมูล มี
value

ค่าของแอตทริบิวต์

 ไม่มีข้อมูล ไม่ได้
associatedCondition

การอ้างอิงเงื่อนไขที่เกี่ยวข้อง

 ไม่มีข้อมูล ไม่ได้

พร็อพเพอร์ตี้การกำหนดค่าสำหรับการดำเนินการกับการแจ้งเตือน

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

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

วิธีที่ใช้ระบุผู้รับการแจ้งเตือน ค่าอาจเป็นค่าต่อไปนี้อย่างน้อย 1 ค่า

  • ORG_EMAIL ระบุผู้รับการแจ้งเตือนได้จากอีเมล
  • DEV_ID ผู้รับการแจ้งเตือนจะระบุด้วยรหัสนักพัฒนาซอฟต์แวร์ (อีเมล)
  • COMPANY_ADMINS ระบบจะส่งการแจ้งเตือนไปยังผู้ดูแลระบบของบริษัททุกคนโดยไม่คำนึงถึงค่าที่ตั้งไว้ โปรดทราบว่าผู้ดูแลระบบของบริษัทแตกต่างจากผู้ดูแลระบบองค์กร
  • WEBHOOK ระบบจะส่งข้อมูลผู้รับการแจ้งเตือนไปยังเครื่องจัดการการเรียกกลับของเว็บฮุค ดูตั้งค่าการแจ้งเตือนโดยใช้เว็บฮุค
 ไม่มีข้อมูล มี
value

ค่าของแอตทริบิวต์การดำเนินการ

หากตั้งค่า actionAttribute เป็น ORG_EMAIL หรือ DEV_ID ค่า ANY จะส่งการแจ้งเตือนไปยังผู้รับที่เกี่ยวข้อง เช่น ที่อยู่ ORG_EMAIL หรือ DEV_ID

หากตั้งค่า actionAttribute เป็น WEBHOOK ให้กำหนดค่านี้เป็นรหัสของเว็บฮุค

หากตั้งค่า actionAttribute เป็น COMPANY_ADMINS ระบบจะไม่สนใจค่านี้ และจะส่งการแจ้งเตือนไปยังผู้ดูแลระบบของบริษัททุกคน

 ไม่มีข้อมูล มี
templateID

รหัสของเทมเพลตการแจ้งเตือน

หมายเหตุ: ตัวเลือกนี้จะใช้ไม่ได้หากตั้งค่า actionAttribute เป็น WEBHOOK

 ไม่มีข้อมูล มี
postURL

เครื่องจัดการโค้ดเรียกกลับสำหรับเว็บฮุค

หมายเหตุ: ต้องระบุตัวเลือกนี้หากตั้งค่า actionAttribute เป็น WEBHOOK ตัวเลือกนี้ใช้ไม่ได้หากตั้งค่าเป็น ORG_EMAIL, DEV_ID หรือ COMPANY_ADMINS

 ไม่มีข้อมูล มี

การใช้ตัวแปรในเทมเพลตการแจ้งเตือน

เมื่อแก้ไขข้อความในเทมเพลตการแจ้งเตือน คุณจะรวมตัวแปรได้มากกว่า 1 รายการโดยใช้ Spring Expression Language (SpEL) เพื่อแสดงค่าที่แสดงผลในออบเจ็กต์ Transaction

ตารางต่อไปนี้จะสรุปตัวแปรของเทมเพลตการแจ้งเตือนที่ใช้บ่อยที่สุด

ตัวแปร คำอธิบาย
${application.name}

ชื่อของแอปพลิเคชัน
${application.products.name} ชื่อผลิตภัณฑ์ที่อยู่ในแอปพลิเคชัน
${BALANCE} ยอดคงเหลือสำหรับโควต้าที่ระบุ
${developer.legalName}

ชื่อบริษัทของนักพัฒนาแอป
${developer.name}

ชื่อนักพัฒนาแอป
${EXPIRY_DATE}

วันที่หรือเวลาที่ขีดจำกัดหมดอายุหรือถูกรีเซ็ต
${LONG_PERCENT} เปอร์เซ็นต์ของขีดจำกัดที่ถึงขีดจำกัดจากการใช้งานปัจจุบัน โดยไม่มีสัญลักษณ์ % เช่น 50
${PERCENT}

เปอร์เซ็นต์ของขีดจำกัดที่ถึงขีดจำกัดตามการใช้งานปัจจุบัน โดยมีสัญลักษณ์ % เช่น 50%
${products.displayName} ชื่อที่แสดงที่กำหนดสำหรับผลิตภัณฑ์
${QUOTA_TYPE}

ประเภทวงเงิน (ปริมาณธุรกรรม วงเงินใช้จ่าย หรือการเปิดเผยค่าธรรมเนียม)
${QUOTA_UNIT}

หน่วยพื้นฐานสำหรับขีดจำกัด ได้แก่ สกุลเงิน (สำหรับขีดจำกัดการใช้จ่าย) หรือการโทร (สำหรับขีดจำกัดธุรกรรม)
${QUOTA_LIMIT}

จำนวนที่จำกัด
${ratePlan.displayName} ชื่อที่แสดงที่กำหนดไว้สำหรับแพ็กเกจราคา
${ratePlan.endDate} วันที่ผู้ให้บริการ API สิ้นสุดแพ็กเกจราคา
${ratePlan.monetizationPackage.displayName}

ชื่อแพ็กเกจ API
${ratePlan.monetizationPackage.name} ชื่อแพ็กเกจการสร้างรายได้
${ratePlan.monetizationPackage.products.displayName}

ชื่อที่แสดงที่กำหนดสำหรับผลิตภัณฑ์ API
${ratePlan.monetizationPackage.products.name} ชื่อผลิตภัณฑ์ที่รวมอยู่ในแพ็กเกจการสร้างรายได้
${ratePlan.startDate} วันที่สร้างแพ็กเกจราคา
${USAGE} การใช้งานปัจจุบัน (รายได้หรือค่าบริการทั้งหมด หรือปริมาณการขาย)
${USER}

ชื่อของผู้ใช้

การปรับแต่งที่อยู่อีเมลสำหรับตอบกลับ

สำหรับการสร้างรายได้ ที่อยู่ noreply@apigee.com เริ่มต้นจะได้รับการกำหนดค่าเพื่อใช้กับการแจ้งเตือนทางอีเมลที่ส่งไปยังบริษัทและนักพัฒนาซอฟต์แวร์ โปรดติดต่อฝ่ายสนับสนุนของ Apigee เพื่อกำหนดค่าชื่อและที่อยู่ตอบกลับที่กำหนดเองสำหรับองค์กร