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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

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

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

הסבר על הדף 'התראות'

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

התראות על שינויים

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

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

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

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

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

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

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

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

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

בטבלה הבאה מפורטות ההתראות לפי סוגי האירועים בקטע Notify All Developers (התראה לכל המפתחים). מידע נוסף מופיע במאמר עריכת התראות באמצעות ממשק המשתמש.

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

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

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

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

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

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

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

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

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

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

לדוגמה, הבקשה הבאה עורכת את התוכן של הודעה חדשה על מוצר 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), כדי לייצג ערכים שמוחזרים באובייקט Transaction.

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

התאמה אישית של כתובת האימייל לתשובה

לצורך מונטיזציה, מוגדרת כתובת ברירת מחדל noreply@apigee.com לשימוש בהתראות באימייל שנשלחות לחברות ולמפתחים. כדי להגדיר שם וכתובת מותאמים אישית לתשובה של הארגון, צריך לפנות לתמיכה של Apigee.