הגדרה של תוכנית התראות שניתנת להתאמה

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

מבוא

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

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

יש להגדיר תוכניות ניתנות להתאמה של התראות, כפי שמתואר בהמשך.

Edge

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

שדה תיאור ברירת המחדל
תדירות החישוב התקופה שבה מחושב נפח העסקאות (או נפח הקשור למאפיינים מותאמים אישית). בוחרים את מספר החודשים (1-24 חודשים). חודש אחד

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

לדוגמה, יכול להיות שתצטרכו:

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

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

Classic Edge (ענן פרטי)

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

  1. בוחרים באפשרות Adjustable Notification (הודעה ניתנת להתאמה) בשדה Rate Plan Type (סוג תוכנית התעריפים) שבכרטיסייה Plan Details (פרטי התוכנית) שבחלון Plan Plan (תוכנית התעריפים).

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

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

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

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

צריך לציין את הפרטים של תוכנית ההתראות שניתן לשנות במאפיין ratePlanDetails בגוף הבקשה בבקשת POST ל-/organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

כדי להגדיר תוכנית התראות ניתנת להתאמה, צריך לציין את הערכים הבאים ב-ratePlanDetails של גוף הבקשה:

מאפיין (property) ערך
type הגדרה ל-USAGE_TARGET.
meteringType הגדרה ל-DEV_SPECIFIC.
duration הגדרה של תקופת הזמן של בסיס הצבירה, יחד עם durationType. בתוכניות עם קצב יצירת התראות אפשר להגדיר את הערך של מספר שלם בין 1 ל-24.
durationType

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

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

הגדרת מספר היעד של העסקאות לכל מפתח אפליקציה באמצעות ה-API

לכל מפתח אפליקציה שהסכים לתוכנית תמחור ותשלומים ניתנת להתאמה של התראות צריך להגדיר את מספר היעד של העסקאות. אפשר להגדיר אם ומתי יישלחו התראות על סמך הגעה לאחוז מסוים ממספר היעד, כגון 90%, 100% או 150%. עסקאות נוספות לא ייחסמו לאחר הגעה למספר היעד.

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

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

כשמאשרים את תוכנית התמחור והתשלומים, כדי להגדיר את מספר היעד של העסקאות, צריך לציין את המאפיין quotaTarget בגוף הבקשה שבבקשת POST למשאב /organizations/{org_name}/developers/{developer_id}/developer-rateplans. יש להגדיר את quotaTarget למספר שלם חיובי או 0 כדי להשבית את ההתראות ממפתח האפליקציה. אם לא צוין ערך, ערך ברירת המחדל של quotaTarget הוא 0.

לדוגמה, הבקשה הבאה מגדירה את מספר היעד של עסקאות ל-4,000 כשמפתח האפליקציה מאשר את תוכנית ההתראות הניתנת להתאמה.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

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

כדי להגדיר את מספר היעד של העסקאות, אפשר לעדכן את תוכנית התעריפים המקובלת ולציין את הנכס quotaTarget בגוף הבקשה, בבקשת PUT, למשאב /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. יש להגדיר את quotaTarget למספר שלם חיובי או 0 כדי להשבית את ההתראות ממפתח האפליקציה. אם לא צוין ערך, ערך ברירת המחדל של quotaTarget הוא 0.

הערך {developer_rateplan_id} מוחזר בתגובה לאישור תוכנית התעריפים שפורסמה.

לדוגמה:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

לחלופין, אפשר לקבל את {developer-rateplan-id} לתוכנית התעריפים למפתחים על ידי שליחת בקשת GET אל /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, כאשר {developer_id} היא כתובת האימייל של המפתח. מידע נוסף זמין במאמר איך רואים את כל תוכניות התעריפים שאושרו על ידי מפתח?

לדוגמה:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

הבקשה הבאה מעדכנת את מספר היעד של העסקאות ל-4,000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
 "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
 "developer":{
 "id":"@mycompany.comrate"
 },email:password