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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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