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

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

מבוא

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

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

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

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

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

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

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

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

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

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

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