הגדרת התראות באמצעות תבניות של התראות

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

מהן תבניות של התראות?

המונטיזציה מספקת קבוצה של תבניות שמגדירות טקסט לדוגמה לסוגים שונים של אירועים התראות. אתם יכולים להתאים אישית כל אחת מהתבניות האלה כדי:

• שליחת הודעה לכל המפתחים לגבי אירועים, כמו מוצרים חדשים, גרסאות חדשות של התנאים וההגבלות או חדשים תוכניות תמחור ותשלומים.
• חשוב להודיע למפתחים שיושפעו מהשינוי לגבי אירועים, כמו תוכנית תמחור ותשלומים מתוקנת.
• שליחת הודעה לספק API לגבי אירועים שקשורים למפתחים, כמו הרשמה של מפתח לחשבון או כשמפתח נרשם לתוכנית תמחור ותשלומים.
• עדכון של כל האדמינים של החברה לגבי אירוע ספציפי.

לחלופין, אפשר ליצור תגובה לפעולה מאתר אחר (webhook) שמגדירה handler של קריאה חוזרת ב-HTTP, ואז להגדיר התנאי שמפעיל את ה-webhook, כמו שמתואר במאמר הגדרת התראות באמצעות webhooks.

עיון בדף ההתראות

נכנסים לדף 'התראות' כמו שמתואר בהמשך.

עריכת התראות

כדי לערוך התראה באמצעות ממשק המשתמש:

1. נכנסים לדף ההתראות.
2. לוחצים על הסמל לצד ההתראה שרוצים לערוך כדי להרחיב את הפרטים שלה.
3. עורכים את השדות 'נושא', 'גוף' ו'נמען' (אם זמינים) לפי הצורך.

   למידע נוסף על משתנים שאפשר לציין בתבנית התראות, אפשר לעיין במאמר שימוש במשתנים בתבניות של התראות.

   בקטעים הבאים תוכלו למצוא מידע נוסף על עריכת התראות בכל קטגוריה:

   • עריכת התראות לשליחת התראה לכל המפתחים
   • עריכת התראות כדי להודיע למפתחים שהושפעו
   • עריכת ההתראות כדי לשלוח הודעה לספקי ה-API
4. כדי להפעיל התראה, מסמנים את התיבה שלצידה.
5. חוזרים על שלבים 2 עד 4 כדי לערוך התראות נוספות.
6. לוחצים על Save כדי לשמור את כל השינויים.

תוצג הודעה שמאשרת שההתראות נשמרו. פעולת השמירה עשויה להימשך כמה דקות.

עריכת התראות להתראה לכל המפתחים

התראות לגבי סוגי האירועים שבחרתם באפשרות שליחת הודעה לכל המפתחים יישלחו לכל המפתחים.

ההתראות מתוזמנות להופיע בסוף היום. אחרי שההתראות נשלח, תיבות הסימון של האירועים נמחקות באופן אוטומטי. צריך לבחור אותן שוב כדי לקבוע התראות עבור סוגי האירועים המשויכים.

הטבלה הבאה מפרטת את ההתראות לפי סוגי אירועים בקטע 'הודעה לכל המפתחים'. למידע נוסף, ראו עריכת התראות באמצעות ממשק המשתמש.

עריכת התראות כדי לשלוח הודעה למפתחים שהושפעו

התראות לגבי סוגי האירועים שבחרת בקטע התראות על אירועים מושפעים הקטע 'מפתחים' נשלח רק למפתחים שמושפעים מסוגי האירועים האלה. לדוגמה, אם בוחרים באירוע של תוכנית התמחור והתשלומים המתוקנת, נשלחת התראה רק אל המפתחים שאישרו את תוכנית התעריפים.

הטבלה הבאה מפרטת את ההתראות לפי סוגי אירועים בקטע 'שליחת הודעה למפתחים המושפעים'. למידע נוסף, ראו עריכת התראות באמצעות ממשק המשתמש.

עריכת התראות כדי לשלוח הודעה לספקי API

התראות לגבי סוגי האירועים שנבחרים ב-Notify API Provider נשלחים לספק ה-API שציינתם.

בטבלה הבאה מפורטות ההתראות, לפי סוגי האירועים, בקטע Notify API Provider. למידע נוסף, ראו עריכת התראות באמצעות ממשק המשתמש.

הפעלה או השבתה של התראה

כדי להפעיל או להשבית התראה באמצעות ממשק המשתמש:

1. נכנסים לדף ההתראות.
2. הפעלה או השבתה של התראה על ידי בחירה או ביטול הבחירה בתיבת הסימון שלידה, בהתאמה.
3. לוחצים על Save כדי לשמור את כל השינויים.

פעולת השמירה עשויה להימשך כמה דקות. תוצג הודעה שמאשרת שההתראות נשמרו.

הגדרת התראות באמצעות תבניות באמצעות ה-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} מזינים את התוכן שהשתנה של התבנית בגוף הבקשה.

כשמתאימים אישית הודעה בתבנית של התראות, אפשר לכלול הודעה אחת או יותר. משתנים. למידע נוסף אפשר לעיין במאמר שימוש במשתנה בהתראה תבניות.

לדוגמה, הבקשה הבאה עורך את התוכן של התראה על מוצר 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.

כאשר אתם שולחים את הבקשה, עליכם לציין בגוף הבקשה את התנאי שמוביל התראה, והפעולות שיש לבצע כשהתנאי מתקיים (למשל, שליחת התראה באימייל).

כדי להגדיר את הפרטים של תנאי ההתראה צריך לציין מאפיין אחד או יותר ערכים. אפשר לעיין ברשימה בקטע מאפייני הגדרה של תנאים להתראות של מאפיינים. כשמדובר בהתראה על אירוע, יכול להיות שהתנאי יופעל כשמוצר חדש פורסם.

כשמגדירים את 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.

שימוש במשתנים בתבניות של התראות

כשעורכים הודעה בתבנית של התראות, אפשר לכלול משתנה אחד או יותר: באמצעות Spring Expression Language (SpEL), כדי לייצג ערכים שהוחזרו בעסקה לאובייקט.

הטבלה הבאה מסכמת את המשתנים הנפוצים ביותר של תבניות התראות.