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

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

מבוא

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

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

מתי מתבצע החיוב בעמלות החוזרות ותוכנית החבילות מתאפסת?

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

אם התוכנית כוללת...	...זה קורה
עמלה חוזרת שאינה אפס שמוגדרת ל-Month תוכנית עם נפח אחסון מוגבל או תוכנית חבילה	החיוב הקבוע והתוכנית בחבילה מתאפסים ביום הראשון של החודש (ברירת המחדל). כדי ליצור אירוע קבוע חודשי ביום ספציפי, יוצרים תוכנית תמחור באמצעות API הניהול ומציינים את היום באמצעות המאפיין RecurringStartUnit, כפי שמתואר בקטע יצירת תוכניות תמחור באמצעות ה-API.
עמלה חוזרת שאינה אפס שמוגדרת ל-שבוע תוכנית Volume Banded או תוכנית חבילה	החיוב הקבוע והתוכנית לחבילה מתאפסים כל 7 ימים אחרי תאריך ההתחלה של תוכנית התמחור של המפתח.
עמלה חוזרת בסכום שאינו אפס, שמוגדרת ליום תוכנית עם נפח אחסון מוגבל או תוכנית חבילה	העמלה הקבועה ואיפוס תוכנית החבילה מתרחשים מדי X ימים אחרי תאריך ההתחלה של תוכנית התמחור והתשלומים של המפתח.
ללא עמלה חוזרת (או עמלה בסך אפס דולר) תוכנית עם נפח אחסון מוגבל או תוכנית חבילה	תוכניות חבילת שירותים מתאפלות על סמך 'בסיס הצבירה' שמוגדר בכרטיס התעריפים. לדוגמה, אם מפתח מתחיל להשתמש בתוכנית תמחור ב-19 בחודש, והבסיס לצבירה הוא כל חודש, השימוש בחבילה יאפס בכל חודש ב-19. שימו לב: יכול להיות שהיום בחודש לא יהיה זהה תמיד. לדוגמה, אם תוכנית התמחור מתחילה ב-31 בדצמבר, תאריך האיפוס יהיה 28 בפברואר בשנה שאינה מעוברת, כי בפברואר יש רק 28 ימים. ה-28 יישאר יום האיפוס לכל העת.

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

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

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

מגדירים את פרטי מחיר המחירון באמצעות ה-API, כמו שמתואר בסעיפים הבאים.

ציון פרטי תוכנית של כרטיס תעריפים באמצעות ה-API

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

ציון מודל טעינה בחיוב קבוע

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

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

בתעריף של תוכנית התעריף, מציינים את הפרטים הבאים:

• סוג התעריף של תוכנית התמחור והתשלומים (RATECARD).
• התעריף של התוכנית. לדוגמה, אם מציינים 0.10 והמטבע הוא דולר ארה"ב, המפתח יחויב ב-0.10 $לכל עסקה (או אם החיוב מבוסס על מאפיין מותאם אישית כמו מספר הבייטים המועברים בעסקה, המפתח יחויב ב-0.10 $על העברת מספר הבייטים שצוין).
• יחידת ההתחלה של החלת התעריף (0). כלומר, התעריף יחול על כל עסקה, החל מהעסקה הראשונה.

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

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

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

ציון מודל טעינה עם תחום עוצמת קול

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

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

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

לכל תעריף של תוכנית תמחור ותשלומים, מציינים את הפרטים הבאים:

• הסוג של התעריף של תוכנית התמחור (RATECARD).
• התעריף של התוכנית. לדוגמה, אם מציינים 0.10 והמטבע הוא דולר ארה"ב, המפתח יחויב ב-0.15 $לכל עסקה (או אם החיוב מבוסס על מאפיין מותאם אישית כמו מספר הבייטים המועברים בעסקה, המפתח יחויב ב-0.15 $על העברת מספר הבייטים שצוין).
• היחידה הראשונה והיחידה האחרונה של פס עוצמת הקול. היחידה הראשונה מציינת את המגבלה התחתונה של טווח הנפח, והיחידה האחרונה מציינת את המגבלה העליונה של טווח הנפח. לדוגמה, אם מציינים יחידת התחלה מ-0 ויחידת סיום של 1,000, תדר הנפח מכסה עד 1,000 עסקאות בתקופת הצבירה. אם המטבע הוא דולר ארה"ב, תקופת הסיכום היא חודש אחד והתעריף על 1,000 העסקאות הראשונות הוא 0.15$, המפתח יחויב ב-0.15$ לכל עסקה עד 1,000 עסקאות בחודש.
  
  פרטים על מועד האיפוס של חבילות זמינים במאמר מתי מתבצעים חיובים על עמלות קבועות ומתי מתבצע איפוס של חבילות שירות?
  

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

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

לדוגמה, הדוגמה הבאה יוצרת תוכנית תעריף עם מודל טעינה עם טווח עוצמת קול. שיעור המס מוגדר ל-0.15 $ל-1,000 העסקאות הראשונות ו-0.10 $לכל הטרנזקציות מעל 1,000. בסיס הצבירה הוא חודש אחד. התשלום נדרש תוך 30 יום. (פרטי המחירון מודגשים).

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

ציון מודל טעינה בחבילה

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

לדוגמה, נניח שהגדרתם שני חבילות, כאשר גודל החבילה הראשונה הוא 1 עד 1,000 עסקאות, וגודל החבילה השנייה הוא 1,001 עד 2,000 עסקאות. התעריף הוא 50 $לחבילה הראשונה ו-40 $לחבילה השנייה, וערך הסיכום הוא 1. אם המפתח רוכש תוכנית של כרטיס תעריפים לחבילה הראשונה, הוא משלם 50$ (מראש) על 1,000 עסקאות בחודש. המפתח יחויב בסכום שהוגדר, גם אם חבילת השירות לא נוצלה במלואה. בתום תקופת הצבירה, תוקף התוכנית יפוג. אם המפתח רוצה להשתמש בחבילה שוב, הוא צריך לרכוש שוב את התוכנית (ואת החבילה).

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

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

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

לדוגמה, הקוד הבא יוצר תוכנית של כרטיס תעריפים עם מודל חיוב בחבילה. התעריף מוגדר כ-50 $לחבילה הראשונה (עד 1,000 עסקאות) וכ-40 $לחבילה השנייה (יותר מ-1,000 עסקאות ועד 2,000 עסקאות). בסיס הצבירה הוא חודש אחד. התשלום נדרש תוך 30 יום.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

ציון תוכנית פרימיום בחינם למוצרים ספציפיים באמצעות ה-API

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

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

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

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

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password