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

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

מבוא

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

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

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

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

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

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

נכס	ערך
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

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

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

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

" ב11c60600b8- "id" : "b1c1c60600b8-f871email:password