מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
מבוא
בתוכנית של מחירון, המפתח מחויב על כל עסקה. בסוג התוכנית הזה, יהיה צורך לספק פרטים נוספים, כמו מודל הטעינה והמחיר של דגם הטעינה.
לחלופין, אפשר לציין תוכנית ללא תשלום למוצרים ספציפיים (במקום לציין API [חבילה]) — אפשר לעשות את זה רק בתוכנית ספציפית למוצר.
מתי מתבצע החיוב בעמלות הקבועות ותוכנית החבילות מתאפסת?
תוכניות תמחור ותשלומים יכולות לכלול עמלות חוזרות וגם חבילות API (תוכניות בהתאם לעומס (scaling) וחבילות. בשתיהן נקבע מועד ספציפי שבו תחויבו בעמלות, ותוכניות החבילות מתאפסות. בטבלה הבאה מוסבר מתי מתבצע החיוב בעמלות הקבועות והאיפוס של מספרי החבילות. אם המיקום אפליקציות למפתחים חסומות לא לבצע קריאות נוספות ל-API כי הן הגיעו לסף מסוים מגבלת עסקאות, אלה הזמנים שבהם ספירות הקריאות ל-API מתאפסות לאפס והאפליקציות הוא יוכל להתחיל לבצע שוב שיחות.
| אם בתוכנית יש... | ...זה קורה |
|---|---|
|
איפוס העמלה הקבועה ואיפוס תוכנית החבילה מתבצעות ביום הראשון של החודש (ברירת המחדל). כדי להגדיר חזרה חודשית ביום ספציפי, יוצרים תוכנית תמחור ותשלומים באמצעות
API ולציין את היום באמצעות מאפיין |
|
העמלה הקבועה ואיפוס תוכנית החבילה מתרחשים כל 7 ימים אחרי התעריף של המפתח תאריך ההתחלה של התוכנית. |
|
העמלה הקבועה ואיפוס תוכנית החבילה מתרחשים כל X ימים אחרי תאריך ההתחלה של תוכנית התמחור והתשלומים של המפתח. |
|
תוכניות החבילות מתאפסות בהתאם לבסיס הצבירה שמוגדר בכרטיס המחיר. עבור לדוגמה, אם מפתח מתחיל תוכנית תמחור ותשלומים ב-19 בחודש, ודוח הצבירה בסיס הבסיס הוא כל חודש, ואז השימוש בחבילה מתאפס מדי חודש ב-19 בחודש. שימו לב: יכול להיות שהיום בחודש לא יהיה זהה תמיד. לדוגמה, אם תעריף התוכנית מתחילה ב-31 בדצמבר, תאריך האיפוס הופך ל-28 בשנה שאינה מעוברת בפברואר, מפני שיש רק 28 ימים בפברואר. ה-28 בחודש נשאר היום המאופס כל הזמן. |
הגדרת תוכניות מחירון באמצעות ממשק משתמש
מגדירים תוכניות מחירון, כמו שמתואר בהמשך.
Edge
כדי להגדיר תוכנית תמחור ותשלומים בזמן יצירה או עריכה תוכנית תמחור ותשלומים, בוחרים את סוג תוכנית התמחור והתשלומים מחירון או מחירון וחלוקת הכנסות ובקטע מחירון בוחרים את אחד מדגמי החיוב הבאים:
| מודל טעינה | תיאור |
| תעריף קבוע | המפתח מחויב בתעריף קבוע לכל עסקה. |
| תחום עוצמת קול | המפתח מחויב בתעריף משתנה בהתאם לנפח העסקאות. |
| חבילות | המפתח מחויב בסכום קבוע מראש לכל חבילת עסקאות. המפתח מחויב בסכום המוגדר, גם אם החבילה נמצאת בשימוש וגם אם לא.
הערה: האפשרות הזו לא זמינה כשבוחרים 'מחירון' ו'חלוקת הכנסות'. |
לאחר מכן, צריך להגדיר את המידע הבא בהתאם למודל הטעינה שנבחר.
| דגם טעינה | שדה | תיאור |
| הכול | תדירות החישוב | תקופת הזמן שבה מחושב נפח העסקאות (או נפח שקשור למאפיינים מותאמים אישית). בוחרים מספר חודשים (1-24 חודשים). |
| תעריף קבוע | תעריף קבוע | המחיר שחויב עבור כל עסקה. צריך להזין מספר עשרוני (עם ארבע ספרות לכל היותר אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר המקומות אחרי הנקודה העשרונית עבור תעריף החיוב דרך ה-API (ולא דרך ממשק המשתמש). אפשר לקרוא פרטים נוספים בקטע הגדרת מספר הספרות אחרי הנקודה העשרונית לתעריפים של תוכניות תעריפים. לדוגמה, אם הזנת 0.10 והמטבע הוא דולר אמריקני, המפתח יחויב ב-0.10 $עבור כל עסקה (או אם על סמך מאפיין מותאם אישית, כגון מספר הבייטים שהועברו בעסקה, המפתח יחויב ב-0.10 $בגין העברת מספר הבייטים שצוין). |
| תחום עוצמת קול | רצועות עוצמת קול | אחד או יותר מהטווחים של נפח עסקאות (או מבוסס על מאפייני לקוח) (כל טווח הוא 'תדר נפח') של מודל חיוב עם תחום נפח. ניתן להקצות קצב לכל תדר של עוצמת הקול. התעריף יחול על כל העסקאות בטווח הנפח הרלוונטי. מציינים את הגבול העליון של התדר הראשון. לדוגמה, עד 1, 000 (הגבול התחתון מוגדר מראש למספר גדול מ-0).
לוחצים על +חדש כדי להוסיף עוד תדרים. משאירים את הגבול העליון של התדר הסופי ריק כדי לציין את כל העסקאות מעל הרמה הזו. הערה: אפשר להגדיר את מספר המקומות אחרי הנקודה העשרונית עבור תעריף החיוב דרך ה-API (ולא דרך ממשק המשתמש). אפשר לקרוא פרטים נוספים בקטע הגדרת מספר הספרות אחרי הנקודה העשרונית לתעריפים של תוכניות תעריפים. לדוגמה, אם ציינתם שני תדרים של עוצמת קול בקטע 'תדרים של עוצמת קול' (>0-1,000 ו-1,000 ומעלה), תוכלו להזין 0.15 עבור תדר של עוצמת קול מ-0-1000 ו-0.10 לתדר של 1,000 ומעלה. אם המטבע שנבחר הוא דולר ארה"ב, התעריף ל-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:
- מבצעים את השלבים ליצירת תוכנית תעריפים.
- בוחרים מחירון בתפריט הנפתח 'סוג תוכנית תעריפים' כדי להגדיר את מודל ההכנסה.
- אם חבילת ה-API שנבחרה כוללת כמה מוצרי API, צריך לבחור באחת מהאפשרויות הבאות:
הערה: אם חבילת ה-API כוללת מוצר אחד של API, אפשר לדלג על השלב הזה.
- תוכניות ספציפיות למוצר – להגדרת פרטי תוכנית תמחור ותשלומים לכל מוצר API בנפרד.
- תוכנית כללית לכל המוצרים כדי להגדיר פרטים של תוכנית תמחור ותשלומים לכל מוצרי ה-API.
- לוחצים על מחירון לתוכנית התעריפים הגנרית או לכל תוכנית תעריפים ספציפית למוצר של API.
הערה: כשמגדירים תוכניות ספציפיות למוצר API, צריך להגדיר תוכנית תמחור ותשלומים לכל מוצר API בנפרד.
חלון המחירון ייפתח.
- להגדיר תוכנית ללא תשלום למוצר API. תוכנית ללא תשלום מציעה למפתחים שימוש בחינם
מוצר API לאורך תקופה או בהתאם לכמות השימוש.
הזן את המידע הבא:
שדה תיאור מוצר Freemium? היקף התקופה ללא תשלום. בוחרים באחד מלחצני הבחירה הבאים:
- לפי כמות. התקופה ללא תשלום מבוססת על הכמות שצוינה בנפח האחסון השדה הזה.
- לפי משך זמן. תקופת העמלה מבוססת על פרק הזמן שמצוין בשדה שדה Freemium Duration.
- הראשון מביניהם. התקופה ללא תשלום מסתיימת כשהכמות ממלאים את שדה עוצמת הקול או את מרווח הזמן בשדה 'משך חינם', הראשון מביניהם.
- לא. זו לא תוכנית ללא תשלום. (זוהי ברירת המחדל)
נפח ב-Freemium נפח העסקאות (או נפח שקשור למאפיין מותאם אישית שתועד ב: מדיניות תיעוד העסקאות) שלגביה המפתחים לא מחויבים. עוצמת הקול היא שנמדדות במוצר ה-API. מזינים מספר כרך, למשל 5000. המשמעות היא כשמפתחים מתחילים את התוכנית, הם לא מחויבים על 5,000 העסקאות הראשונות (או ל-5,000 השימושים הראשונים בפריט שקשור למאפיין מותאם אישית). השדה הזה הוא רק אם בוחרים באפשרות 'לפי כמות' או "מה שיתרחש קודם" ב"פרימיום מוצר?" השדה הזה.
משך זמן חופשי פרק הזמן שבמהלכו המפתחים לא מחויבים. מזינים מספר. בוחרים תקופה, לדוגמה 'חודש אחד'. המשמעות היא שמפתחים חיוב למשך חודש אחד. השדה הזה מופעל רק אם בוחרים באפשרות 'לפי משך זמן' או "מה שיתרחש קודם" ב-'freemium Product? ' השדה הזה.
- בוחרים אחד מדגמי הטעינה הבאים:
- תעריף קבוע במודל הזה, המפתח מחויב בתעריף קבוע לכל העסקה.
- תחום עוצמת הקול. במודל הזה, המפתח מחויב בתעריף משתנה בהתאם נפח העסקאות.
- חבילות. במודל הזה, המפתח מחויב בסכום קבוע (מראש) לכל חבילה של עסקאות. המפתח מחויב בסכום שהוגדר, גם אם החבילה לא כוללת במצב מלא.
למודל תעריף קבוע: מזינים את המידע הבא בקטע 'תמחור' של החלון הכללי של המחירון:
שדה תיאור מפעיל (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות המפעיל (או ערך השדה Organization) בפרופיל הארגון.
מדינה מדינת הפעילות של הארגון. השדה הזה מוגדר מראש באמצעות ערך שדה המדינה בפרופיל הארגון.
תעריף קבוע התעריף שבו מחויב כל עסקה. יש להזין מספר עשרוני (עם עד 4 אפשרויות ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר המקומות אחרי הנקודה העשרונית. לתעריף החיוב דרך ה-API (לא דרך ממשק המשתמש). מידע נוסף מופיע בקטע הגדרה מספר הספרות אחרי הנקודה העשרונית לתעריפים של תוכניות התעריף.
לדוגמה, אם הזנת 0.10 והמטבע הוא דולר אמריקני, המפתח הוא מחויב ב-0.40 ש"ח לכל עסקה (או אם הוא מבוסס על מאפיין מותאם אישית כמו מספר הבייטים שהועברו בעסקה, המפתח מחויב ב-0.10 $עבור העברת מספר הבייטים שצוין).
במודל עם טווח עוצמת הקול: בחלון המחירון הכללי מוצגים ערכים נוספים שבהם משתמשים כדי לציין בסיס לצבירה ולציון 'תחומי עוצמת קול', הוא טווחים של נפח עסקאות שעליהם אפשר להחיל תעריפים שונים.
סוג התוכנית הזה בדרך כלל מוגדר כדי לעודד מפתחים לייצר נפחים גדולים יותר על ידי הצעת תעריפים מוזלים לתדרים בעוצמת קול גבוהה יותר.
מזינים את הפרטים הבאים בחלון 'מחירון כללי':
שדה תיאור בסיס צבירה תקופת הזמן שבה הנפח של העסקאות (או המרות מותאמות אישית) נפח הקשור למאפיינים) הוא מצטבר. הנפח המצטבר משמש לזיהוי את תדר עוצמת הקול והתעריף שיחול על כל עסקה. בחירת מספר חודשים (חודש עד 12 חודשים).
כדי לדעת מתי חבילות מתאפסות, אפשר לעיין בקטע מתי החזרות של החבילות מתבצעות באופן קבוע עמלות שחויבו ושתוכניות החבילות יתאפסו?
תדרים של עוצמת קול טווח אחד או יותר של נפח עסקאות (או לפי מאפיין לקוח) (כל טווח היא 'רצועת עוצמת קול'). ניתן להקצות קצב לכל תדר של עוצמת הקול ( השדה 'תדרים של עוצמת קול' שבקטע 'תמחור'.) התעריף יחול על כל עסקאות בטווח הנפח הרלוונטי. צריך לציין את הגבול העליון של תחום מסוים, לדוגמה, עד 1000 (הגבול התחתון מוגדר מראש ליותר מ-0). לוחצים על + כדי להוסיף תדר שני, לדוגמה: גדול מ-1,000 עד 2,000. צריך ללחוץ על + כדי להוסיף עוד מספר תדרים. ניתן להשאיר את הגבול העליון של התדר הסופי ריק כדי לציין את כל עסקאות מעל רמה זו.
Pricing מפעיל (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות המפעיל (או ארגון) בפרופיל הארגון.
מדינה מדינת הפעילות של הארגון. השדה הזה מוגדר מראש באמצעות ערך השדה 'מדינה' בפרופיל הארגון.
מטבע "הבסיס" או המטבע הנהוג שבו הארגון שלך משתמש. השדה הזה הוא הגדרה קבועה מראש באמצעות ערך השדה 'מטבע' בפרופיל הארגון, אבל היא יכולה להיות השתנה כאן.
רצועות עוצמת קול התעריף של תדר עוצמת הקול. אתם מציינים קצב לכל תדר של עוצמת הקול. עליך להזין עשרוני לכל תדר (עם עד ארבע ספרות אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר המקומות אחרי הנקודה העשרונית. לקצב רצועת עוצמת הקול באמצעות ה-API (לא ממשק המשתמש). מידע נוסף מופיע בקטע הגדרה מספר הספרות אחרי הנקודה העשרונית לתעריפים של תוכניות התעריף.
לדוגמה, אם ציינתם שני תדרים של עוצמת קול בקטע 'תדר עוצמת קול' (מעל 0-1000 וכן 1000 ומעלה), אפשר להזין 0.15 עבור נפח תנועה גדול מ-0-1000 ו-0.10 לתדר של 1000 ומעלה. אם המטבע שנבחר הוא ארה"ב בדולרים, השער עבור 1000 העסקאות הראשונות הוא 0.15 $לכל עסקה, ו עבור יותר מ-1,000 עסקאות, שער החליפין הוא 0.10 $לכל עסקה.
במודל שכלול בחבילה: בחלון המחיר הכללי מוצגים שדות נוספים שבו משתמשים כדי לציין בסיס לצבירה (פרק הזמן שבו המפתח יכול להשתמש את חבילת העסקאות) וכדי לציין מידע שקשור לחבילה, כמו גודל חבילה.
מזינים את הפרטים הבאים בחלון 'מחירון כללי':
שדה תיאור בסיס צבירה התקופה שבה המפתח יכול להשתמש בחבילת העסקאות (או אם יש לכם חבילה מותאמת אישית שמבוססת על מאפיינים). בוחרים מספר חודשים (1-12 חודשים). אחרי בתקופה הזו, תוקף התוכנית פג והמפתח חייב לרכוש את התוכנית (וחבילות) שוב.
כדי לדעת מתי חבילות מתאפסות, אפשר לעיין בקטע מתי החזרות של החבילות מתבצעות באופן קבוע עמלות שחויבו ושתוכניות החבילות יתאפסו?
גודל החבילה מספר העסקאות בחבילה (או מספר שקשור למאפיין מותאם אישית למשל: המספר הכולל של הבייטים שהועברו בחבילה). אפשר להקצות כל חבילה מחיר (את המחיר הזה מגדירים בשדה 'גודל חבילה' בקטע 'תמחור') המחיר חל על החבילה כולה. ציינו את הגבול העליון של החבילה הראשונה, עבור לדוגמה, עד 1,000 (המגבלה התחתונה מוגדרת מראש כגדולה מ-0). יש ללחוץ על + כדי להוסיף החבילה השנייה, לדוגמה, בין 1,000 ל-2,000. צריך ללחוץ על + כדי להוסיף עוד חבילות. עליך לציין גבול עליון עבור החבילה האחרונה, אלא אם ברצונך לחייב את המפתח בסכום קבוע עבור עסקאות ללא הגבלה חבילה.
Pricing מפעיל (או ארגון) שם הארגון. השדה הזה מוגדר מראש באמצעות המפעיל (או ארגון) בפרופיל הארגון.
מדינה מדינת הפעילות של הארגון. השדה הזה מוגדר מראש באמצעות ערך השדה 'מדינה' בפרופיל הארגון.
מטבע "הבסיס" או המטבע הנהוג שבו הארגון שלך משתמש. השדה הזה הוא הגדרה קבועה מראש באמצעות ערך השדה 'מטבע' בפרופיל הארגון, אבל היא יכולה להיות השתנה כאן.
גודל החבילה (מחיר) מחיר החבילה. מציינים מחיר לכל חבילה. צריך להזין מספר עשרוני מספר (עם ארבע ספרות לכל היותר אחרי הנקודה העשרונית).
הערה: אפשר להגדיר את מספר המקומות אחרי הנקודה העשרונית. למחיר החבילה באמצעות ה-API (לא ממשק המשתמש). מידע נוסף מופיע בקטע הגדרה מספר הספרות אחרי הנקודה העשרונית לתעריפים של תוכניות התעריף.
לדוגמה, אם מציינים שתי חבילות בקטע 'גודל החבילה' (גדול מ-0). בין 1,000, ומעל 1,000 עד 2,000), אפשר להזין 50 עבור מ-0 עד 1,000 חבילה, ו-40 לחבילה שמכילה יותר מ-1,000 עד 2,000. אם המטבע שנבחר הוא דולר ארה"ב, המחיר עבור החבילה הראשונה הוא 50$, ועבור החבילה השנייה, המחיר הוא 160 ש"ח. המפתח מחויב במחיר החבילה הרלוונטי בלי קשר לכמות העסקאות שהם ביצעו בתוך החבילה (כלומר, המפתח מחויב במחיר החבילה ברגע שהעסקה הראשונה בחבילה הושלמה).
- לוחצים על אישור וסגירה כדי לשמור את פרטי המחירון ולחזור לתוכנית התמחור הרגילה. חלון.
- בתוכניות תעריפים ספציפיות למוצר 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 יום. (הפרטים שקשורים למחירון הם highlighted.)
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 ויחידת סיום של 1000, רצועת עוצמת הקול תכסה
עד 1,000 עסקאות בתקופת הצבירה. אם המטבע הוא דולר אמריקני,
תקופת הצבירה היא חודש, והשיעור של 1,000 העסקאות הראשונות הוא 0.15,
המפתח מחויב ב-0.15 $לכל עסקה עבור עד 1,000 עסקאות בחודש.
כדי לדעת מתי החבילות מתאפסות, אפשר לעיין במאמר מתי יתבצע החיוב בעמלות קבועות? ולאפס את תוכניות החבילה?
אם לא תציינו יחידת סיום לתדר עוצמת הקול הסופי, התעריף של התדר הזה הוא חל על כל העסקאות לאחר שמספר העסקאות עבר מעל יחידת ההתחלה של הלהקה הזו. לדוגמה, אם יחידת ההתחלה של התדר האחרון היא 1000, ולא לציין יחידת סיום עבור הרצועה, התעריף של הרצועה יחול על כל הטרנזקציות. לאחר 1,000 עסקאות בתקופת הצבירה.
לעיון בתוכנית המחירים פרטי ההגדרות האישיות כדי לקבל רשימה מלאה של האפשרויות לפרטי תוכנית התעריפים.
לדוגמה, הדוגמה הבאה יוצרת תוכנית תעריף עם מודל טעינה עם טווח עוצמת קול. שער החליפין מוגדר ל-0.15 $עבור 1, 000 העסקאות הראשונות ו-0.10 $לכל העסקאות מעל 1000. בסיס הצבירה הוא חודש אחד. המועד לתשלום חל בעוד 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 יחידות (המפרטים הקשורים ל-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