אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
מבוא
בתוכנית עם כרטיס תעריפים, המפתח מחויב על כל עסקה. בתוכנית מהסוג הזה, צריך לספק פרטים נוספים, כמו מודל החיוב והתמחור של מודל החיוב.
אפשר גם לציין תוכנית פרימיום למוצרים ספציפיים (במקום לחבילת API) – אפשר לעשות זאת רק לתוכנית שספציפית למוצר.
מתי נגבים תשלומים קבועים ומתי מתבצע איפוס של חבילות?
תוכניות תמחור יכולות לכלול עמלות חוזרות וגם חבילות API (תוכניות עם תמחור לפי נפח ותוכניות חבילה). בשני המקרים יש זמנים ספציפיים שבהם נגבות עמלות, ובתוכניות חבילה יש גם זמנים שבהם החבילות מתאפסות לאפס. בטבלה הבאה מתואר מתי נגבים חיובים חוזרים ומתי מתבצע איפוס של מספר החבילות. אם אפליקציות למפתחים נחסמות מביצוע קריאות נוספות ל-API כי הן הגיעו לתקרת התשלומים, אלה הזמנים שבהם המערכת מאפסת את ספירת הקריאות ל-API לאפס והאפליקציות יכולות להתחיל לבצע קריאות שוב.
| אם בתוכנית יש… | ...זה קורה |
|---|---|
|
האיפוס של העמלה הקבועה ושל תוכנית החבילה מתבצע ביום הראשון של החודש (ברירת מחדל). כדי ליצור תוכנית מחירים עם חזרה חודשית ביום ספציפי, צריך ליצור תוכנית מחירים באמצעות Management API ולציין את היום באמצעות מאפיין |
|
האיפוס של העמלה הקבועה ושל תוכנית החבילה מתרחש כל 7 ימים אחרי תאריך ההתחלה של תוכנית התעריפים של המפתח. |
|
האיפוס של העמלה הקבועה ושל תוכנית החבילה מתרחש כל X ימים אחרי תאריך ההתחלה של תוכנית התמחור של המפתח. |
|
האיפוס של חבילות המינויים מתבצע על סמך בסיס הצבירה שמוגדר במחירון. לדוגמה, אם מפתח מתחיל להשתמש בתוכנית תמחור ב-19 בחודש, והבסיס לצבירה הוא כל חודש, השימוש בחבילה מתאפס כל חודש ב-19 בחודש. שימו לב: התאריך בחודש לא תמיד יהיה זהה. לדוגמה, אם תוכנית תעריפים מתחילה ב-31 בדצמבר, תאריך האיפוס יהיה 28 בפברואר בשנה לא מעוברת, כי יש רק 28 ימים בפברואר. ה-28 בחודש יישאר יום האיפוס לתמיד. |
הגדרת תוכניות מחירון באמצעות ממשק המשתמש
מגדירים תוכניות של כרטיסי תעריפים, כמו שמתואר בהמשך.
Edge
כדי להגדיר תוכנית תעריפים, כשיוצרים או עורכים תוכנית תעריפים, בוחרים את סוג תוכנית התעריפים Rate Card (כרטיס תעריפים) או Rate Card and Revenue Share (כרטיס תעריפים ושיתוף הכנסות), ובקטע Rate Card (כרטיס תעריפים) בוחרים באחד ממודלי החיוב הבאים:
| מודל תמחור | תיאור |
| תעריף קבוע | המפתח מחויב בשיעור קבוע על כל עסקה. |
| Volume Banded | המפתח מחויב בתעריף משתנה בהתאם לנפח העסקאות. |
| חבילות | המפתח מחויב בסכום קבוע מראש על כל חבילת עסקאות. המפתח מחויב בסכום שהוגדר, גם אם לא נעשה שימוש בכל החבילה.
הערה: האפשרות הזו לא זמינה כשבוחרים באפשרות 'כרטיס תעריפים' ו'חלוקת הכנסות'. |
לאחר מכן, מגדירים את הפרטים הבאים בהתאם למודל החיוב שנבחר.
| מודל תמחור | שדה | תיאור |
| הכול | תדירות החישוב | תקופת הזמן שבה מחושב נפח העסקאות (או נפח שקשור למאפיין מותאם אישית). בוחרים מספר חודשים (1-24 חודשים). |
| תעריף קבוע | תעריף קבוע | התעריף שחויב עבור כל עסקה. מזינים מספר עשרוני (עם עד ארבע ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין עבור התעריף שמוגדר באמצעות ה-API (ולא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכנית התמחור. לדוגמה, אם מזינים את הערך 0.10 והמטבע הוא דולר ארה"ב, המפתח יחויב ב-0.10 $על כל עסקה (או אם החיוב מבוסס על מאפיין מותאם אישית כמו מספר הבייטים שמועברים בעסקה, המפתח יחויב ב-0.10 $על העברת מספר הבייטים שצוין). |
| Volume Banded | רצועות עוצמת הקול | טווח אחד או יותר של נפח עסקאות (או נפח שמבוסס על מאפייני לקוחות) (כל טווח הוא 'רצועת נפח') למודל חיוב לפי רצועת נפח. אפשר להקצות תעריף לכל רצועת נפח. השיעור חל על כל העסקאות ברצועת הנפח הרלוונטית. מציינים את הגבול העליון של הטווח הראשון, לדוגמה, עד 1,000 (הגבול התחתון מוגדר מראש כגדול מ-0).
כדי להוסיף עוד טווחים, לוחצים על +חדש. כדי לציין את כל העסקאות שמעל הרמה הזו, משאירים את הגבול העליון של הטווח האחרון ריק. הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין עבור התעריף שמוגדר באמצעות ה-API (ולא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכנית התמחור. לדוגמה, אם מציינים שני טווחי נפח בקטע Volume Band (>0-1000, ו-1000 ומעלה), אפשר להזין 0.15 לטווח הנפח >0-1000 ו-0.10 לטווח הנפח 1000 ומעלה. אם המטבע שנבחר הוא דולר ארה"ב, התעריף ל-1,000 העסקאות הראשונות הוא 0.15 $לכל עסקה, ולמעלה מ-1,000 עסקאות הוא 0.10 $לכל עסקה. |
| חבילות | מחירים של חבילות API | מספר העסקאות בחבילה (או מספר שקשור למאפיין מותאם אישית, כמו המספר הכולל של בייטים שמועברים בחבילה). אפשר להקצות מחיר לכל חבילה. המחיר חל על כל החבילה. מציינים את הגבול העליון של החבילה הראשונה, למשל עד 1, 000 (הגבול התחתון מוגדר מראש כגדול מ-0).
כדי להוסיף חבילות נוספות, לוחצים על +חדש. חובה לציין הגבלה עליונה לחבילה האחרונה, אלא אם רוצים לחייב את המפתח בסכום קבוע עבור מספר בלתי מוגבל של עסקאות בחבילה האחרונה. הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין עבור התעריף שמוגדר באמצעות ה-API (ולא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכנית התמחור. לדוגמה, אם מציינים שני חבילות בקטע 'גודל החבילה' (יותר מ-0 עד 1,000, ויותר מ-1,000 עד 2,000), אפשר להזין 50 לחבילה 'יותר מ-0 עד 1,000' ו-40 לחבילה 'יותר מ-1,000 עד 2,000'. אם המטבע שנבחר הוא דולר ארה"ב, המחיר של החבילה הראשונה הוא 50$, והמחיר של החבילה השנייה הוא 40$. המפתח מחויב במחיר החבילה הרלוונטי, ללא קשר למספר העסקאות שהוא מבצע במסגרת החבילה (כלומר, המפתח מחויב במחיר החבילה ברגע שהעסקה הראשונה בחבילה הושלמה). |
אם הגדרתם מאפיינים מותאמים אישית למוצר ה-API, אתם יכולים להגדיר פרמטר מותאם אישית של דירוג כדי לחייב את מפתח האפליקציה על סמך מאפיין מותאם אישית בכל עסקה. לדוגמה, אם הגדרתם תוכנית שבה אתם מחייבים את המפתח על כל עסקה, אתם יכולים להגדיר את התעריף של התוכנית על סמך מאפיין מותאם אישית, כמו מספר הבייטים שמועברים בקצה העורפי, שיכול להשתנות בהתאם לעסקה.
במקרה כזה, בוחרים באפשרות שימוש בפרמטר מותאם אישית של דירוג ובוחרים את המאפיין המותאם אישית מהרשימה הנפתחת. מידע נוסף זמין במאמר בנושא הגדרת תוכנית תמחור עם מאפיינים מותאמים אישית.
Classic Edge (ענן פרטי)
כדי להגדיר תוכניות של כרטיסי תעריפים באמצעות ממשק המשתמש של Classic Edge:
- פועלים לפי השלבים ליצירת תוכנית תמחור.
- בתפריט הנפתח Rate Plan Type (סוג תוכנית התמחור), בוחרים באפשרות Rate Card (כרטיס תעריפים) כדי להגדיר את מודל ההכנסות.
- אם חבילת ה-API שנבחרה כוללת כמה מוצרי API, בוחרים באחת מהאפשרויות הבאות:
הערה: אם חבילת ה-API כוללת מוצר API אחד, אפשר לדלג על השלב הזה.
- תוכניות ספציפיות למוצרים כדי להגדיר את פרטי תוכנית התמחור לכל מוצר API בנפרד.
- Generic Plan for All Products (תוכנית כללית לכל המוצרים) כדי להגדיר את פרטי תוכנית התמחור לכל מוצרי ה-API.
- לוחצים על כרטיס תעריפים לתוכנית התעריפים הכללית או לכל תוכנית תעריפים ספציפית למוצר API.
הערה: כשמגדירים תוכניות ספציפיות למוצרי API, צריך להגדיר תוכנית של כרטיס תעריפים לכל מוצר API בנפרד.
ייפתח חלון המחירון.
- הגדרת תוכנית פרימיום למוצר API. תוכנית פרימיום מאפשרת למפתחים להשתמש במוצר API בחינם למשך תקופה מסוימת או על סמך היקף השימוש.
הזן את המידע הבא:
שדה תיאור מוצר בגרסה חינמית מוגבלת? משך תקופת הניסיון בחינם. בוחרים באחד מלחצני האפשרויות הבאים:
- לפי כמות. התקופה החינמית מבוססת על כמות שצוינה בשדה Volume (נפח).
- לפי משך הזמן. תקופת התשלום מבוססת על מרווח זמן שצוין בשדה Freemium Duration.
- המוקדם מביניהם. תקופת השימוש בחינם מסתיימת כשמגיעים לכמות בשדה Volume או למרווח הזמן בשדה Freemium Duration, לפי מה שקורה קודם.
- לא. זה לא מינוי פרימיום. זוהי אפשרות ברירת המחדל.
נפח Freemium נפח העסקאות (או נפח שקשור למאפיין מותאם אישית שמתועד במדיניות תיעוד העסקאות) שעליו המפתחים לא מחויבים. הנפח נמדד עבור מוצר ה-API. מזינים מספר נפח, למשל 5,000. כלומר, כשהמפתחים מתחילים את התוכנית, הם לא מחויבים על 5,000 העסקאות הראשונות (או על 5,000 השימושים הראשונים בפריט שקשור למאפיין מותאם אישית). השדה הזה מופעל רק אם בוחרים באפשרות 'לפי כמות' או 'המוקדם מביניהם' בשדה 'מוצר פרימיום?'.
משך השימוש בגרסת Freemium מרווח הזמן שבמהלכו המפתחים לא מחויבים. מזינים מספר ובוחרים תקופת זמן, למשל חודש אחד. המשמעות היא שהמפתחים לא יחויבו למשך חודש אחד. השדה הזה מופעל רק אם בוחרים באפשרות 'לפי משך הזמן' או באפשרות 'המוקדם מביניהם' בשדה 'מוצר פרימיום?'.
- בוחרים אחד ממודלי התמחור הבאים:
- תעריף קבוע. במודל הזה, המפתח מחויב בשיעור קבוע על כל עסקה.
- נפח מחזורי. במודל הזה, המפתח מחויב בשיעור משתנה בהתאם לנפח העסקאות.
- חבילות. במודל הזה, המפתח מחויב בסכום קבוע (מראש) על כל חבילה של עסקאות. המפתח מחויב בסכום שהוגדר בין אם נעשה שימוש מלא בחבילה ובין אם לא.
למודל של תעריף קבוע: מזינים את הפרטים הבאים בקטע Pricing (תמחור) בחלון Generic Rate Card (מחירון כללי):
שדה תיאור אופרטור (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות ערך השדה 'מפעיל' (או 'ארגון') בפרופיל הארגון.
מדינה המדינה שבה הארגון שלך פועל. השדה הזה מוגדר מראש באמצעות הערך של שדה המדינה בפרופיל הארגון.
תעריף קבוע השיעור שחויב עבור כל עסקה. מזינים מספר עשרוני (עם עד ארבע ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין בשער שחויב באמצעות ה-API (לא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכניות תמחור.
לדוגמה, אם מזינים את הערך 0.10 והמטבע הוא דולר ארה"ב, המפתח יחויב ב-0.10 $על כל עסקה (או אם החיוב מבוסס על מאפיין מותאם אישית כמו מספר הבייטים שמועברים בעסקה, המפתח יחויב ב-0.10 $על העברת מספר הבייטים שצוין).
במודל של תעריפים לפי נפח: בחלון Generic Rate Card מוצגים שדות נוספים שבהם מציינים את הבסיס לצבירה ואת 'התעריפים לפי נפח', כלומר טווחי נפח העסקאות שאפשר להחיל עליהם תעריפים שונים.
בדרך כלל, התוכנית הזו מוגדרת כדי לעודד מפתחים לייצר נפחים גבוהים יותר על ידי הצעת תעריפים מוזלים לטווחים של נפחים גבוהים יותר.
בחלון Generic Rate Card (מחירון כללי), מזינים את הפרטים הבאים:
שדה תיאור בסיס הצבירה פרק הזמן שבו נצבר נפח העסקאות (או נפח שקשור למאפיין מותאם אישית). הנפח המצטבר משמש לזיהוי רצועת הנפח והשיעור שיוחלו על כל עסקה. בוחרים מספר חודשים (1-12 חודשים).
פרטים על מועד האיפוס של חבילות זמינים במאמר מתי נגבות עמלות חוזרות ומתי מתבצע איפוס של תוכניות חבילה?
פסי עוצמת הקול טווח אחד או יותר של נפח עסקאות (או נפח שמבוסס על מאפייני לקוח) (כל טווח הוא 'רצועת נפח'). לכל טווח נפח אפשר להקצות תעריף (את התעריף הזה מגדירים בשדה Volume Bands (טווח נפח) בקטע Pricing (תמחור)). התעריף חל על כל העסקאות ברמת היקף הרלוונטית. מציינים את הגבול העליון של הטווח הראשון, למשל עד 1, 000 (הגבול התחתון מוגדר מראש כגדול מ-0). לוחצים על + כדי להוסיף פס שני, למשל, גדול מ-1,000 עד 2,000. לוחצים על + כדי להוסיף עוד רצועות. אפשר להשאיר את הגבול העליון של הטווח האחרון ריק כדי לציין את כל העסקאות שמעל הרמה הזו.
תמחור אופרטור (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות ערך השדה 'מפעיל' (או 'ארגון') בפרופיל הארגון.
מדינה המדינה שבה הארגון שלך פועל. השדה הזה מוגדר מראש באמצעות הערך של השדה Country (מדינה) בפרופיל הארגון.
מטבע המטבע ה "בסיסי" או המטבע החשבונאי שבו הארגון משתמש. השדה הזה מוגדר מראש באמצעות הערך של שדה המטבע בפרופיל הארגון, אבל אפשר לשנות אותו כאן.
רצועות עוצמת הקול התעריף של נפח שימוש מסוים. מציינים תעריף לכל טווח נפח. מזינים מספר עשרוני לכל טווח (עם עד ארבע ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין לשיעור של רצועת נפח באמצעות ה-API (לא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכניות תמחור.
לדוגמה, אם מציינים שני טווחי נפח בקטע Volume Band (טווח נפח), (>0-1000 ו-1000 ומעלה), אפשר להזין 0.15 לטווח הנפח >0-1000 ו-0.10 לטווח הנפח 1000 ומעלה. אם המטבע שנבחר הוא דולר ארה"ב, העלות של כל אחת מ-1,000 העסקאות הראשונות היא 0.15$, והעלות של כל עסקה מעבר ל-1,000 היא 0.10$.
במודל החבילה: בחלון Generic Rate Card (כרטיס תעריפים כללי) מוצגים שדות נוספים שבהם מציינים את הבסיס לצבירה (תקופת הזמן שבה המפתח יכול להשתמש בחבילת העסקאות) ומציינים מידע שקשור לחבילה, כמו גודל החבילה.
בחלון Generic Rate Card (מחירון כללי), מזינים את הפרטים הבאים:
שדה תיאור בסיס הצבירה התקופה שבה המפתח יכול להשתמש בחבילת העסקאות (או להשתמש בחבילה מותאמת אישית שמבוססת על מאפיינים). בוחרים מספר חודשים (1-12 חודשים). אחרי התקופה הזו, התוכנית פגה והמפתח צריך לרכוש אותה (ואת החבילות) שוב.
פרטים על מועד האיפוס של חבילות זמינים במאמר מתי נגבות עמלות חוזרות ומתי מתבצע איפוס של תוכניות חבילה?
גודל החבילה מספר העסקאות בחבילה (או מספר שקשור למאפיין מותאם אישית, כמו המספר הכולל של בייטים שמועברים בחבילה). אפשר להקצות לכל חבילה מחיר (אתם מגדירים את המחיר הזה בשדה 'גודל החבילה' בקטע 'תמחור'). המחיר חל על כל החבילה. מציינים את הגבול העליון של החבילה הראשונה, לדוגמה, עד 1,000 (הגבול התחתון מוגדר מראש כגדול מ-0). לוחצים על + כדי להוסיף חבילה שנייה, למשל, יותר מ-1,000 עד 2,000. לוחצים על + כדי להוסיף עוד חבילות. חובה לציין תקרת הוצאות לחבילה האחרונה, אלא אם רוצים לחייב את המפתח בסכום קבוע עבור מספר בלתי מוגבל של טרנזקציות בחבילה האחרונה.
תמחור אופרטור (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות ערך השדה 'מפעיל' (או 'ארגון') בפרופיל הארגון.
מדינה המדינה שבה הארגון שלך פועל. השדה הזה מוגדר מראש באמצעות הערך של השדה Country (מדינה) בפרופיל הארגון.
מטבע המטבע ה "בסיסי" או המטבע החשבונאי שבו הארגון משתמש. השדה הזה מוגדר מראש באמצעות הערך של שדה המטבע בפרופיל הארגון, אבל אפשר לשנות אותו כאן.
גודל החבילה (מחיר) המחיר של חבילה. מציינים מחיר לכל חבילה. צריך להזין מספר עשרוני (עם עד ארבע ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר הספרות אחרי הנקודה שאפשר לציין עבור מחיר החבילה באמצעות ה-API (ולא ממשק המשתמש). פרטים נוספים זמינים במאמר בנושא הגדרת מספר הספרות אחרי הנקודה בתעריפים של תוכניות תמחור.
לדוגמה, אם מציינים שני חבילות בקטע 'גודל החבילה' (יותר מ-0 עד 1,000, ויותר מ-1,000 עד 2,000), אפשר להזין 50 לחבילה 'יותר מ-0 עד 1,000' ו-40 לחבילה 'יותר מ-1,000 עד 2,000'. אם המטבע שנבחר הוא דולר ארה"ב, המחיר של החבילה הראשונה הוא 50$, והמחיר של החבילה השנייה הוא 40$. המפתח מחויב במחיר החבילה הרלוונטי, בלי קשר למספר העסקאות שהוא מבצע במסגרת החבילה (כלומר, המפתח מחויב במחיר החבילה ברגע שהעסקה הראשונה בחבילה הושלמה).
- לוחצים על Apply and Close (החלה וסגירה) כדי לשמור את פרטי כרטיס המחירים ולחזור לחלון Standard Rate Plan (תוכנית מחירים רגילה).
- לגבי תוכניות תמחור ספציפיות למוצרי API, מגדירים את פרטי תוכנית התמחור למוצרי API נוספים, לפי הצורך.
הגדרת תוכנית של כרטיס תעריפים באמצעות ה-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