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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ตารางต่อไปนี้แสดงการแจ้งเตือนตามประเภทเหตุการณ์ในส่วน "แจ้งเตือนผู้ให้บริการ 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) เพื่อแสดงมูลค่าที่แสดงผลในธุรกรรม ออบเจ็กต์

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