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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

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

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

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

סיור בדף ההתראות

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

Edge

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

  1. נכנסים לאתר apigee.com/edge.
  2. בסרגל הניווט הימני בוחרים באפשרות פרסום > מונטיזציה > התראות.

הדף 'התראות' מוצג.

כפי שמודגש באיור, הדף 'התראות' מאפשר לך:

Classic Edge (ענן פרטי)

כדי לגשת לדף ההתראות באמצעות ממשק המשתמש הקלאסי של Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות מנהל מערכת > התראות בסרגל הניווט העליון.

הדף 'התראות' מאפשר לכם:

עריכת התראות

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

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

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

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

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

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

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

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

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

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

סוג אירוע Trigger הערות
חבילה חדשה חבילת ה-API החדשה זמינה

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

מוצר חדש המוצר החדש של ה-API זמין

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

שווקים/כיסוי חדשים מוצרי API חדשים זמינים בשווקים גיאוגרפיים ספציפיים

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

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

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

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

סוג אירוע Trigger הערות
התנאים וההגבלות לא אושרו או שפג תוקפם פורסמו תנאים חדשים של תנאים והגבלות והמפתח עדיין לא אישר אותם

ההודעה תישלח 30 ימים, 7 ימים ויום אחד לפני שהתנאים וההגבלות החדשים ייכנסו לתוקף.

תוכנית מחירים חדשה פורסמו תוכניות תעריפים חדשות

אם תוכנית התמחור והתשלומים היא:

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

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

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

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

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

עליך להודיע למפתח שהעמלות הרלוונטיות יחויבו.

חרגת מהגבלת הקצב של יצירת בקשות חרגת מהמגבלה של תוכנית התמחור והתשלומים

עליך להודיע למפתח שהעמלות הרלוונטיות יחויבו.

תוכנית התעריפים של Freemium שאזלה מוצו תקופות השימוש בחינם, שנמדדות לפי מספר העסקאות או הימים,

תקופת השימוש בחינם מוגדרת בתוכנית התמחור והתשלומים של Freemium.

פורסם מסמך החיוב

מסמכי חיוב (כמו חשבוניות) זמינים עבור המפתח.

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

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

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

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

סוג אירוע Trigger
הרשמה של מפתח חדש

המפתח נרשם לחשבון.

המפתח מוסיף אפליקציה

המפתח יצר אפליקציה חדשה.

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

המפתח נרשם לתוכנית תמחור ותשלומים.

המפתח משנה את הפרטים הפיננסיים

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

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

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

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

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

הגדרת התראות באמצעות תבניות באמצעות ה-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

יצירת תנאי ופעולה להתראה שיובילו להודעה אוטומטית על ידי שליחה של בקשת 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. פרטי נמען ההתראה נשלחים אל ה-handler של הקריאה החוזרת (webhook). למידע נוסף, ניתן לקרוא את המאמר הגדרת התראות באמצעות תגובות לפעולה מאתר אחר (webhook).
לא רלוונטי כן
value

הערך של מאפיין הפעולה.

אם המדיניות actionAttribute מוגדרת לערך ORG_EMAIL או DEV_ID, הערך ANY שולח את ההתראה לכל נמען רלוונטי, לדוגמה, כל כתובת ORG_EMAIL או כל DEV_ID.

אם המדיניות actionAttribute מוגדרת לערך WEBHOOK, צריך להגדיר את הערך הזה למזהה של ה-webhook.

אם המדיניות actionAttribute מוגדרת כ-COMPANY_ADMINS, המערכת תתעלם מהערך הזה. ההודעה נשלחת לכל מנהלי המערכת של החברה.

לא רלוונטי כן
templateID

המזהה של תבנית ההתראה.

הערה: האפשרות הזו לא חוקית אם הערך של actionAttribute הוגדר ל-WEBHOOK.

לא רלוונטי כן
postURL

handler של קריאה חוזרת ל-webhook.

הערה: האפשרות הזו נדרשת אם הערך של actionAttribute הוא WEBHOOK. האפשרות הזו לא חוקית אם הערך מוגדר ל-ORG_EMAIL, ל-DEV_ID או ל-COMPANY_ADMINS.

לא רלוונטי כן

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

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

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

משתנה התיאור
${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 כדי להגדיר עבור הארגון שם וכתובת לתשובות בהתאמה אישית.