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

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

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

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

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

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

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

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

עריכת התראות

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

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

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

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

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

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

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

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

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

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

סוג האירוע	Trigger	הערות
חבילה חדשה	חבילת API חדשה זמינה	מוסיפים את השם של כל חבילת שירות חדשה (ואת המוצרים הכלולים בכל חבילת שירות) לגוף של תבנית האימייל כחלק מהעדכון. אפשר גם להוסיף קישור לפורטל למפתחים או לאתר אחר שמספק מידע נוסף על ההודעה.
מוצר חדש	מוצר API חדש זמין	מוסיפים את השם של כל מוצר חדש לגוף של תבנית האימייל כחלק מהעדכון. אפשר גם להוסיף קישור לפורטל למפתחים או לאתר אחר שמספק מידע נוסף על ההודעה.
שווקים חדשים/כיסוי חדש	מוצרי API חדשים זמינים בשווקים גיאוגרפיים ספציפיים	מוסיפים את השם של כל שוק חדש ואת המוצרים הרלוונטיים לגוף של תבנית האימייל כחלק מהעדכון. אפשר גם להוסיף קישור לפורטל למפתחים או לאתר אחר שמספק מידע נוסף על ההודעה.

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

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

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

סוג האירוע	Trigger	הערות
התנאים וההגבלות לא אושרו או שהתוקף שלהם פג	פורסמה קבוצה חדשה של התנאים וההגבלות והמפתח עדיין לא אישר אותם	ההודעה תישלח 30 יום, 7 ימים ויום אחד לפני שהתקנון החדש ייכנס לתוקף.
תוכנית תמחור חדשה	פורסמו תוכניות התעריפים החדשות	אם תוכנית התמחור היא: תוכנית רגילה, כל המפתחים מקבלים התראה. תוכנית התמחור לפי קטגוריית מפתחים, רק מפתחים בקטגוריה הזו יקבלו התראה. תוכנית תמחור למפתחים, רק המפתח הספציפי יקבל הודעה.
תוכנית תמחור מתוקנת	יש גרסה חדשה יותר של תוכנית תעריפים שנרכשה	רק המפתחים שרכשו את הגרסה הנוכחית יקבלו הודעה. ההתראה תאפשר למפתחים לבדוק את הגרסה החדשה, ולסגור תוכניות או להחליף תוכניות אם הם לא מעוניינים לאשר את התעריפים החדשים.
תוכנית תמחור שפג תוקפה	פג התוקף של תוכנית התמחור והתשלומים בלי תוכנית מעקב	ההודעה הזו נשלחת כשמגדירים לראשונה את התאריך שבו יפוג תוקף תוכנית התמחור, ועוד הודעות נשלחות 30, 7 ויום אחד לפני תאריך התפוגה. רק מפתחים שקנו את חבילת התמחור שפג תוקפה יקבלו הודעה.
תוכנית תמחור מחודשת	המינוי לתוכנית התמחור חודש.	מודיעים למפתח שיחויבו עליו החיובים הרלוונטיים.
חריגה ממגבלת הקצב	חרגת מהמגבלה של תוכנית התמחור	מודיעים למפתח שהחיובים הרלוונטיים יחויבו.
תוכנית תעריף של Freemium שנגמר בה המכסה	תקופות השימוש בחינם, שנמדדות לפי מספר העסקאות או הימים, הסתיימו	תקופת השימוש בחינם מוגדרת לפי תוכנית התמחור של גרסת ה-freemium.
מסמך החיוב פורסם	מסמכי חיוב (כמו חשבוניות) של המפתח זמינים.
מפתח נרשם לתוכנית התמחור החדשה	המפתח נרשם לתוכנית תמחור חדשה.

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

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

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

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

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

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

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, מאפייני ההגדרה הבאים של תנאי התראות זמינים.

שם	תיאור	ברירת מחדל	חובה?
attribute	פרטי התנאי של ההתראה. אפשר לציין מאפיין אחד או יותר כדי לצמצם את תנאי ההתראה. הערך יכול להיות אחד או יותר מהערכים הבאים: 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 (תקף להגדרת webhooks בלבד)	לא רלוונטי	כן
value	הערך של המאפיין.	לא רלוונטי	לא
associatedCondition	הפניה לתנאי משויך.	לא רלוונטי	לא

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

מאפייני ההגדרה הבאים זמינים לפעולות של התראות כשמשתמשים ב-API.

שם	תיאור	ברירת מחדל	חובה?
actionAttribute	השיטה שבה נעשה שימוש כדי לזהות את נמען ההתראה. הערך יכול להיות אחד או יותר מהערכים הבאים: ORG_EMAIL. הנמען של ההודעה מזוהה לפי כתובת האימייל שלו. DEV_ID. הנמען של ההודעה מזוהה לפי מזהה המפתח (כתובת האימייל). COMPANY_ADMINS. התראה נשלחת לכל האדמינים בחברה, ללא קשר לערך שהוגדר. חשוב לזכור שאדמינים ברמת החברה שונים מאדמינים ברמת הארגון. WEBHOOK. פרטי הנמען של ההתראה נשלחים לטיפול בקריאה החוזרת (callback) של ה-webhook. למידע נוסף, ראו הגדרת התראות באמצעות webhook.	לא רלוונטי	כן
value	הערך של מאפיין הפעולה. אם הערך של actionAttribute מוגדר כ-ORG_EMAIL או כ-DEV_ID, הערך ANY שולח את ההתראה לכל נמען רלוונטי, למשל כל כתובת ORG_EMAIL או כל DEV_ID. אם הערך של actionAttribute מוגדר כ-WEBHOOK, צריך להגדיר את הערך הזה כמזהה של ה-webhook. אם actionAttribute מוגדר ל-COMPANY_ADMINS, המערכת מתעלמת מהערך הזה. ההתראה נשלחת לכל האדמינים של החברה.	לא רלוונטי	כן
templateID	המזהה של תבנית ההתראה. הערה: האפשרות הזו לא תקפה אם הערך של actionAttribute מוגדר ל-WEBHOOK.	לא רלוונטי	כן
postURL	גורם מטפל בקריאה חוזרת ל-webhook. הערה: האפשרות הזו נדרשת אם הערך של actionAttribute מוגדר ל-WEBHOOK. האפשרות הזו לא תקפה אם הערך מוגדר ל-ORG_EMAIL, ל-DEV_ID או ל-COMPANY_ADMINS.	לא רלוונטי	כן

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

כשעורכים הודעה בתבנית התראות, אפשר לכלול משתנה אחד או יותר באמצעות 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.