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

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

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

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

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

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

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

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

Edge

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

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

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

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

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

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

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

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

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

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

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

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

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

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

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

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

การแก้ไขการแจ้งเตือนเป็น "แจ้งเตือนนักพัฒนาแอปทั้งหมด"

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

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

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

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

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

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

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

การแก้ไขการแจ้งเตือนเพื่อแจ้งให้นักพัฒนาแอปที่ได้รับผลกระทบทราบ

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

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

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

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

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

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

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

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

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

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

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

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

การแก้ไขการแจ้งเตือนเพื่อแจ้งผู้ให้บริการ 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

ลบเงื่อนไขการแจ้งเตือนโดยส่งคําขอ DELETE ไปยัง 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 รายการเพื่อปรับแต่งเงื่อนไขการแจ้งเตือนได้

ค่าอาจเป็นค่าใดค่าหนึ่งต่อไปนี้

  • 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 ระบบจะส่งข้อมูลผู้รับการแจ้งเตือนไปยังเครื่องจัดการ Callback ของเว็บฮุค โปรดดูหัวข้อตั้งค่าการแจ้งเตือนโดยใช้ Webhook
 ไม่มี ใช่
value

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

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

หากตั้งค่า actionAttribute เป็น WEBHOOK ให้ตั้งค่านี้เป็นรหัสของ 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 เพื่อกำหนดค่าชื่อและที่อยู่สำหรับการตอบกลับที่กำหนดเองสำหรับองค์กรของคุณ