אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
בקטעים הבאים מוסבר איך לנהל תוכניות תמחור באמצעות ממשק המשתמש ו-API.
הסבר על הדף 'תוכניות תמחור'
נכנסים לדף של תוכניות התמחור, כמו שמתואר בהמשך.
Edge
כדי לראות את תוכניות התמחור בממשק המשתמש של Edge, ניגשים לדף Rate Plans (תוכניות תמחור):
- נכנסים לחשבון בכתובת apigee.com/edge.
- בסרגל הניווט הימני, בוחרים באפשרות פרסום > מונטיזציה > תוכניות תמחור.
יוצג הדף 'תוכניות תמחור'.

כפי שמודגש באיור, בדף 'תוכניות תמחור' אפשר:
- תוכלו לראות סיכום של כל תוכניות התמחור, כולל שם התוכנית, חבילת מוצרי ה-API, הסטטוס (פורסם או טיוטה), עלות התוכנית ותאריכי ההתחלה והסיום.
NOTE: תוכניות תמחור שתוקפן פג לא מוצגות בממשק המשתמש. כדי לראות תוכניות תמחור שתוקפן פג, צריך להשתמש ב-API. מידע נוסף זמין במאמר בנושא הצגת תוכניות תמחור באמצעות ה-API. - יצירת תוכנית תמחור
- עריכה של תוכנית תמחור
- פרסום תוכנית מחירים
- מחיקת תוכנית תמחור בטיוטה
- מוסיפים תוכנית מחירים עתידית, כמו שמתואר במאמר בנושא ניהול תוכניות מחירים עתידיות
- חיפוש ברשימת תוכניות התמחור בכל שדה שמוצג, או לפי שם המפתח או הקטגוריה (אם רלוונטי)
Classic Edge (ענן פרטי)
כדי לראות את תוכניות התמחור באמצעות ממשק המשתמש הקלאסי של Edge, ניגשים לדף API Packages (חבילות API):
- מתחברים אל
http://ms-ip:9000, כאשר ms-ip היא כתובת ה-IP או שם ה-DNS של צומת שרת הניהול. - בסרגל הניווט העליון, בוחרים באפשרות פרסום > חבילות.
בדף API Packages (חבילות API) מוצגות תוכניות התמחור שהוגדרו לכל חבילה.
בדף 'תוכניות תמחור' אפשר:
- יצירת תוכנית תמחור
- עריכה של תוכנית תמחור
- פרסום תוכנית מחירים
- מחיקת תוכנית תמחור בטיוטה
- מוסיפים תוכנית מחירים עתידית, כמו שמתואר במאמר בנושא ניהול תוכניות מחירים עתידיות
- חיפוש ברשימת תוכניות התמחור לפי כל שדה שמוצג, או לפי שם המפתח או הקטגוריה (אם רלוונטי)
יצירת תוכנית תמחור
כדי ליצור תוכנית תמחור:
- כניסה לדף Rate Plans
- לוחצים על + תוכנית תמחור.
- מגדירים את השדות הבאים בחלונית העליונה:
שדה תיאור ברירת מחדל חובה שם תוכנית התמחור השם של תוכנית התמחור. NOTE: השם חייב להיות ייחודי בחבילת מוצרי API. לשני מינויים באותה חבילת מוצרים לא יכול להיות אותו שם.
לא רלוונטי כן סוג תוכנית התמחור סוג תוכנית התמחור. בוחרים ערך מהרשימה הנפתחת. רשימה של סוגי תוכניות תמחור תקינות מופיעה במאמר סוגים נתמכים של תוכניות תמחור. לא רלוונטי כן חבילת מוצרים חבילת מוצרי API. בוחרים ערך מהרשימה הנפתחת. מידע נוסף על חבילות של מוצרי API זמין במאמר בנושא ניהול חבילות של מוצרי API. אם בוחרים חבילת מוצרים שמכילה יותר ממוצר API אחד, צריך לבחור אם להגדיר תוכניות תמחור נפרדות לכל מוצר API או תוכנית תמחור כללית שתחול על כל מוצרי ה-API.
לא רלוונטי כן קהל הקהל שיכול לגשת לתוכנית המחירים. בוחרים אחד מהערכים הבאים מהרשימה הנפתחת: - כולם – כל המפתחים.
- מפתח – מפתח או חברה. מזינים את שם המפתח או החברה. בזמן ההקלדה, תופיע רשימה נפתחת של המפתחים או החברות שמכילים את המחרוזת. לוחצים על השם של המפתח או החברה מהרשימה הנפתחת.
- קטגוריית מפתח – קטגוריית מפתח. בוחרים קטגוריית מפתחים מהרשימה הנפתחת.
מגדירים את קטגוריות המפתחים לפי הצורך, כפי שמתואר במאמר ניהול קטגוריות מפתחים.
כולם לא תאריך התחלה התאריך שבו תוכנית התמחור נכנסת לתוקף. מזינים תאריך התחלה או בוחרים תאריך באמצעות היומן. היום לא תאריך סיום התאריך שבו תוכנית התמחור מסתיימת. כדי לציין תאריך סיום, מפעילים את המתג יש תאריך סיום ומזינים תאריך סיום או בוחרים תאריך באמצעות היומן. הערה: תוכנית התמחור תהיה בתוקף עד סוף היום בתאריך שצוין. לדוגמה, אם רוצים להגדיר שתוקף תוכנית המחירים יפוג ב-1 בדצמבר 2018, צריך להגדיר את הערך של endDate ל-2018-11-30. במקרה כזה, תוקף תוכנית התמחור יפוג בסוף היום ב-30 בנובמבר 2018, וכל הבקשות ב-1 בדצמבר 2018 ייחסמו.
ללא לא גלוי לפורטלים קובעים אם תוכנית התמחור תהיה גלויה לכולם או פרטית. השוואה בין תוכניות תמחור ציבוריות לפרטיות מופעל לא - מגדירים את העמלות לתוכנית התמחור. איך מגדירים עמלות לתוכנית תמחור
NOTE: לא רלוונטי לתוכניות עם התראות שניתנות להתאמה. - אם בוחרים חבילת מוצרים שמכילה יותר ממוצר API אחד, צריך להגדיר את ההעדפות הבאות בקטע Specific or generic rate plan:
הערה: השלב הזה לא רלוונטי לתוכניות עם התראות שניתנות להתאמה.
שדה תיאור ברירת מחדל הגדרת כל מוצר בנפרד דגל שמציין אם להגדיר תוכנית תמחור נפרדת לכל מוצר API. מושבת הגדרת מבצע פרימיום לכל מוצר בנפרד דגל שמציין אם להגדיר תוכנית פרימיום לכל מוצר API. מושבת בחר מוצר אם מפעילים את אחד מהדגלים או את שניהם, צריך לבחור כל מוצר בנפרד מהתפריט הנפתח ולהגדיר את פרטי תוכנית התמחור שלו. NOTE: חשוב להגדיר את כל המוצרים בחבילת המוצרים.
לא רלוונטי - מגדירים את פרטי תוכנית התמחור בהתאם לסוג תוכנית התמחור שנבחר:
- לוחצים על אחת מהאפשרויות הבאות:
כפתור תיאור שמירה כטיוטה שומרים את תוכנית התמחור כטיוטה. תוכנית התמחור לא תהיה גלויה למפתחי אפליקציות עד שתפרסמו אותה. אפשר לערוך כל שדה בתוכנית תמחור בסטטוס טיוטה.
פרסום תוכנית חדשה מפרסמים את התוכנית. NOTE: אחרי שמפרסמים תוכנית מחירים, אפשר לשנות רק את תאריך הסיום, אם הוא עדיין לא הוגדר. אי אפשר למחוק תוכנית תמחור אחרי שהיא פורסמה, אבל אפשר להגדיר שהיא תפוג ולהחליף אותה בתוכנית תמחור עתידית, כמו שמתואר במאמר הגדרת תפוגה לתוכנית תמחור שפורסמה.
- מצרפים את מדיניות בדיקת מגבלות המונטיזציה לשרתי ה-proxy של ה-API שמשויכים למוצרי ה-API שכלולים בתוכנית התמחור. מדיניות בדיקת מגבלות המונטיזציה אוכפת מגבלות מונטיזציה על שרתי ה-proxy של ה-API, ומוודאת שכל התקלות מתועדות בצורה מדויקת בדוחות הניתוח ובדוחות המונטיזציה. מידע נוסף זמין במאמר בנושא אכיפת מגבלות מונטיזציה על שרתי proxy של API.
עריכה של תוכנית תמחור
אפשר לערוך את כל השדות בתוכנית תמחור בסטטוס 'טיוטה', חוץ מהשדות 'חבילת מוצרים', 'סוג' ו'קהל'. אחרי שמפרסמים תוכנית מחירים, אפשר לערוך רק את תאריך הסיום, ורק אם לא צוין תאריך סיום.
כדי לערוך תוכנית תמחור:
- כניסה לדף Rate Plans
- לוחצים בתוך השורה של תוכנית התמחור שרוצים לערוך.
מוצגת החלונית של תוכנית התמחור. - עורכים את השדות של תוכנית התמחור לפי הצורך.
NOTE: אחרי שמפרסמים תוכנית מחירים, אפשר לשנות רק את תאריך הסיום, אם הוא עדיין לא הוגדר. - לוחצים על אחת מהאפשרויות הבאות:
כפתור תיאור עדכון טיוטה (תוכניות תמחור ותשלומים בטיוטה) שומרים את תוכנית התמחור כטיוטה.
תוכנית התמחור לא תהיה גלויה למפתחי אפליקציות עד שתפרסמו אותה. אפשר לערוך כל שדה בתוכנית תמחור בסטטוס טיוטה.פרסום טיוטה (תוכניות תמחור בטיוטה) מפרסמים את תוכנית התמחור.
NOTE: אחרי שמפרסמים תוכנית מחירים, אפשר לשנות רק את תאריך הסיום שלה, אם הוא עדיין לא הוגדר. אי אפשר למחוק תוכנית תמחור אחרי שהיא פורסמה, אבל אפשר להגדיר שהיא תפוג ולהחליף אותה בתוכנית תמחור עתידית, כמו שמתואר במאמר הגדרת תפוגה לתוכנית תמחור שפורסמה.תאריך סיום מעודכן (תוכניות תמחור שפורסמו) הגדרת תאריך הסיום של תוכנית שפורסמה.
NOTE: אחרי שמגדירים תאריך סיום לתוכנית מחירים שפורסמה, אי אפשר לשנות אותו יותר.
מחיקת תוכנית תמחור בטיוטה
למחוק תוכנית תמחור בטיוטה אם היא כבר לא נחוצה.
הערה: אי אפשר למחוק תוכנית מחירים שפורסמה.
כדי למחוק טיוטה של תוכנית תמחור:
- כניסה לדף Rate Plans
- מציבים את הסמן מעל תוכנית התמחור שרוצים למחוק כדי להציג את תפריט הפעולות.
- לוחצים על
. - לוחצים על מחיקה כדי לאשר את הפעולה.
ניהול תוכניות תמחור באמצעות API
בקטעים הבאים מוסבר איך לנהל תוכניות תמחור באמצעות ה-API.
יצירת תוכניות תמחור באמצעות API
כדי ליצור תוכנית תמחור, שולחים בקשת POST אל
/organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans,
כאשר {monetizationpackage_id} הוא המזהה של חבילת מוצרי ה-API שעבורה יוצרים את תוכנית התמחור (המזהה מוחזר בתגובה כשיוצרים את חבילת מוצרי ה-API).
כשיוצרים תוכנית תמחור, צריך לציין את הפרטים הבאים בגוף הבקשה:
- מזהה הארגון
- מזהה חבילת מוצרים של API
- שם תוכנית התעריפים
- תיאור של תוכנית התמחור
- היקף התוכנית (אם היא חלה על כל המפתחים או רק על מפתח, חברה או קטגוריית מפתחים ספציפיים)
- התאריך שבו תוכנית המחירים נכנסת לתוקף
- המטבע של תוכנית התמחור
- האם לפרסם את תוכנית התמחור
- אם תוכנית התמחור היא ציבורית או פרטית
יש הגדרות אחרות שאפשר לציין, כמו התקופה שבה התשלום אמור להתבצע (לדוגמה, 30 יום). מאפייני ההגדרה של תוכניות תמחור
אם יוצרים חבילת מוצרים ב-API עם תוכנית תמחור (שאינה תוכנית עם עמלות בלבד) שיש בה יותר ממוצר אחד, אפשר להחיל את התוכנית על מוצר ספציפי בחבילת המוצרים. כדי לעשות זאת, צריך לזהות את המוצר בבקשה. אם לא מציינים מוצר, התוכנית חלה על כל המוצרים בחבילת מוצרי ה-API.
בקטעים הבאים מוסבר איך ליצור תוכניות תמחור:
- יצירת תוכנית תמחור רגילה באמצעות API
- יצירת תוכנית תמחור למפתחים או לחברות באמצעות ה-API
- יצירת תוכנית תמחור לקטגוריית מפתחים באמצעות ה-API
- יצירת תוכנית תמחור ספציפית למוצר API באמצעות ה-API
- הגדרת תוכנית התמחור כציבורית או פרטית באמצעות ה-API
יצירת תוכנית תמחור רגילה באמצעות ה-API
כדי ליצור תוכנית מחירים רגילה, מגדירים את מאפיין type לערך STANDARD, כמו בדוגמה הבאה.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Simple rate plan",
"currency": {
"id" : "usd"
},
"description": "Simple rate plan",
"displayName" : "Simple rate plan",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"published": true,
"isPrivate" : false,
"ratePlanDetails": [
{
…
}
],
"startDate": "2013-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password
יצירת תוכנית תמחור למפתחים או לחברות באמצעות API
כדי להחיל את תוכנית התמחור על מפתח או חברה ספציפיים, מגדירים את הערך של type ל-Developer. בנוסף, צריך לזהות בבקשה את המפתח או החברה, ולציין את המזהה, השם החוקי והשם של המפתח או החברה.
לדוגמה, הקטע הבא יוצר תוכנית תמחור למפתח Dev Five:
...
"type": "DEVELOPER",
"developer" : {
"id" : "0mkKu1PALUGfjUph",
"legalName" : "DEV FIVE",
"name" : "Dev Five"
}
...
יצירת תוכנית תעריפים לקטגוריית מפתחים באמצעות ה-API
כדי להחיל את תוכנית התמחור על קטגוריית מפתחים, מגדירים את הערך type ל-Developer_Category. בנוסף, צריך לציין בבקשה את קטגוריית המפתחים.
לדוגמה:
...
"type": "DEVELOPER_CATEGORY",
"developerCategory" : {
"id" : "5e172299-8232-45f9-ac46-40076139f373",
"name" : "Silver",
"description" : "Silver category"
}
...
יצירת תוכנית תמחור ספציפית למוצר API באמצעות ה-API
כשיוצרים תוכנית תמחור לחבילות של מוצרי API שכוללות כמה מוצרי API, אפשר לציין פרטים של תוכנית תמחור לכל מוצר API בנפרד.
לדוגמה, הקוד הבא יוצר תוכנית לחלוקת הכנסות עם שני מוצרי API:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Multi-product rate plan",
"currency": {
"id" : "usd"
},
"description": "Multi-product rate plan",
"displayName" : "Multi-product rate plan",
"monetizationPackage": {
"id": "mypackage",
...
},
"organization": {
"id": "{org_name}",
...
},
"published": true,
"isPrivate" : false,
"ratePlanDetails": [
{
"ratePlanRates":[{
"revshare":0,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"product":{"id":"product1","displayName":"Product1"},
"customPaymentTerm":false
},
{
"ratePlanRates":[{
"revshare":10,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"product":{"id":"product2","displayName":"Product2"},
"customPaymentTerm":false
}
],
"startDate": "2019-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password
כדי להוסיף מוצר API לmy-package חבילת מוצרי API, צריך להוסיף את פרטי תוכנית התמחור של מוצר ה-API בגוף הבקשה, כמו שמתואר במאמר הוספת מוצר API לחבילת מוצרי API עם תוכניות תמחור ספציפיות למוצר ה-API.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"ratePlan": [
{
"id": "my-package_multi-product-rate-plan",
"ratePlanDetails": [
{
"ratePlanRates":[{
"revshare":20,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"customPaymentTerm":false
}]
}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password
הגדרת תוכנית התמחור כציבורית או כפרטית באמצעות ה-API
כשיוצרים תוכנית תמחור, אפשר לציין אם היא גלויה לכולם או פרטית באמצעות המאפיין isPrivate בגוף הבקשה. אם הערך הוא true, תוכנית המחירים תהיה פרטית. מידע נוסף זמין במאמר בנושא תוכניות תמחור ציבוריות לעומת פרטיות.
לדוגמה, הפעולה הבאה יוצרת תוכנית מחירים פרטית:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Simple rate plan",
"currency": {
"id" : "usd"
},
"description": "Simple rate plan",
"displayName" : "Simple rate plan",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"published": true,
"isPrivate" : true,
"ratePlanDetails": [
{
…
}
],
"startDate": "2013-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password
פרסום תוכנית מחירים באמצעות API
כדי לפרסם תוכנית מחירים, מגדירים את ערך המאפיין published ל-true כשיוצרים את תוכנית המחירים. מפתחים יוכלו לראות את תוכנית התמחור החל מהתאריך שצוין במאפיין startDate של התוכנית.
לדוגמה, הקוד הבא יוצר תוכנית של כרטיס תעריפים ומפרסם אותה (מוצג רק חלק מהבקשה):
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
…
"published": "true",
"ratePlanDetails": [
…
],
…
"type": "RATECARD"
}],
…
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
שמירת טיוטה של תוכנית תמחור באמצעות API
כדי לשמור תוכנית מחירים בלי לפרסם אותה, צריך להגדיר את ערך המאפיין published כ-false כשיוצרים את תוכנית המחירים.
לדוגמה, הפקודה הבאה יוצרת תוכנית של כרטיס תעריפים ושומרת אותה כטיוטה (מוצג רק חלק מהבקשה):
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
…
"published": "false",
"ratePlanDetails": [
…
],
…
"type": "RATECARD"
}],
…
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
עריכה של טיוטה של תוכנית תמחור באמצעות ה-API
כדי לעדכן טיוטה של תוכנית תמחור, שולחים בקשת PUT אל
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id},
כאשר{package_id} הוא מזהה חבילת ה-API, ו{plan_Id} הוא מזהה תוכנית התמחור. כשמבצעים את העדכון, צריך לציין בגוף הבקשה את ההגדרות המעודכנות ואת המזהה של תוכנית התמחור. אם מעדכנים תעריף של תוכנית תעריפים, צריך לציין גם את המזהה של התעריף. לדוגמה, הבקשה הבאה מעדכנת את התעריף של תוכנית תעריפים שמזהה שלה הוא location_flat_rate_card_plan (העדכון מודגש):
$ curl -H "Content-Type: application/json" -X PUT -d \
'{
"id" : "location_flat_rate_card_plan",
"name": "Flat rate card plan",
"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": "false",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
"type": "RATECARD",
"rate": "0.15",
"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/location_flat_rate_card_plan" \
-u email:password
התשובה כוללת את המחיר המעודכן של תוכנית התמחור (מוצג רק חלק מהתשובה):
… "ratePlanRates" : [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "rate" : 0.15, "startUnit" : 0, "type" : "RATECARD" } ], …
הצגת תוכניות תמחור באמצעות ה-API
אפשר לראות את תוכניות התמחור באמצעות ה-API של המוניטיזציה, כמו שמתואר בקטעים הבאים.
- הצגת כל התוכניות התמחוריות בארגון באמצעות ה-API
- צפייה בכל תוכניות התמחור של חבילת מוצרי API באמצעות ה-API
- הצגת תוכנית תמחור לחבילת מוצרי API באמצעות ה-API
- הצגת כל תוכניות התמחור הפעילות של מפתח באמצעות ה-API
- איך צופים בתוכנית תעריפים שאושרה למפתח באמצעות ה-API
- צפייה בתוכנית תמחור שאושרה למפתח שמכילה מוצר API באמצעות ה-API
- הצגת כל התוכניות התמחוריות שהמפתח מקבל באמצעות ה-API
הצגת כל תוכניות התמחור לארגון באמצעות ה-API
כדי לראות את כל תוכניות התמחור של הארגון, שולחים בקשת GET אל
/mint/organizations/{org_name}/rate-plans,
כאשר {org_name} הוא שם הארגון.
אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:
| פרמטר שאילתה | תיאור |
|---|---|
all |
דגל שמציין אם להחזיר את כל תוכניות התמחור. אם הערך שלו הוא false, מספר תוכניות התמחור שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא true. |
size |
מספר חבילות ה-API שמוחזרות בכל דף. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
page |
מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
הצגת כל תוכניות התמחור של חבילת מוצרי API באמצעות ה-API
כדי לראות את כל תוכניות התמחור של חבילת API, שולחים בקשת GET אל /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, כאשר {package_id} הוא המזהה של חבילת ה-API (מזהה החבילה מוחזר כשיוצרים את חבילת המונטיזציה).
כברירת מחדל, התוצאות כוללות רק תוכניות תמחור פעילות, ציבוריות ורגילות. כדי לכלול:
- תוכניות מחירים בטיוטה או כאלה שתוקפן פג, מגדירים את פרמטר השאילתה
currentלערךfalse(לדוגמה,?current=false). - בתוכניות מחירים פרטיות, מגדירים את פרמטר השאילתה
showPrivateלערךtrue(לדוגמה,?showPrivate=true). - בכל תוכניות התמחור הרגילות, מגדירים את פרמטר השאילתה
standardלערךtrue(לדוגמה,?standard=true).
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
הצגת תוכנית תמחור לחבילת API באמצעות API
כדי לראות את תוכנית התמחור של חבילת API, שולחים בקשת GET אל /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, כאשר {package_id} הוא המזהה של חבילת ה-API ו-{plan_id} הוא המזהה של תוכנית התמחור (מזהה החבילה מוחזר כשיוצרים את חבילת המונטיזציה, ומזהה תוכנית התמחור מוחזר כשיוצרים את תוכנית התמחור).
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
זוהי דוגמה לתגובה:
{ "advance" : true, "contractDuration" : 1, "contractDurationType" : "YEAR", "currency" : { "id" : "usd", ... "organization" : { ... }, ... }, "description" : "Standard Fixed Plan", "displayName" : "Standard Fixed Plan", "earlyTerminationFee" : 0.0000, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "communications_standard_fixed_plan", "isPrivate" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Standard Fixed Plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : true, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2", "rate" : 0.0500, "startUnit" : 0, "type" : "RATECARD" } ], "ratingParameter" : "VOLUME", "type" : "RATECARD" } ], "recurringFee" : 200.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 100.0000, "startDate" : "2013-01-11 22:00:00", "type" : "STANDARD" }
צפייה בכל תוכניות התמחור הפעילות של מפתח באמצעות ה-API
כדי לראות את כל תוכניות התמחור הפעילות של מפתח, שולחים בקשת GET אל
/mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, כאשר
{developer_id} היא כתובת האימייל של המפתח.
אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:
| פרמטר שאילתה | תיאור |
|---|---|
all |
דגל שמציין אם להחזיר את כל חבילות ה-API. אם הערך מוגדר ל-false, מספר חבילות ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false. |
size |
מספר חבילות ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
page |
מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
זוהי דוגמה לתגובה:
{ "ratePlan" : [ { "advance" : true, "contractDuration" : 1, "contractDurationType" : "MONTH", "currency" : { "description" : "United States Dollar", "displayName" : "United States Dollar", "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Fee Only RatePlan", "displayName" : "Fee Only RatePlan", "earlyTerminationFee" : 10.0000, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "WEEK", "id" : "messaging_package_fee_only_rateplan", "isPrivate" : false, "monetizationPackage" : { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, "name" : "Fee Only RatePlan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ ], "recurringFee" : 10.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 20.0000, "startDate" : "2013-02-20 00:00:00", "type" : "STANDARD" } ], "totalRecords" : 1 }
הצגת תוכנית תמחור שאושרה למפתח באמצעות ה-API
כדי לראות תוכנית תמחור פעילה למפתח, שולחים בקשת GET אל
/mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id},
כאשר {developer_id} היא כתובת האימייל של המפתח, ו-{developer_rateplan_id} הוא
המזהה של תוכנית התמחור שאושרה ומוחזר בתגובה כשמאשרים את תוכנית התמחור שפורסמה.
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
זוהי דוגמה לתגובה:
{ "created" : "2018-01-25 20:01:54", "developer" : { }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }
צפייה בתוכנית תמחור שאושרה למפתח שמכילה מוצר API באמצעות ה-API
כדי לראות תוכנית תמחור שאושרה למפתח ומכילה מוצר API, שולחים בקשת GET אל /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, כאשר {developer_id} הוא מזהה המפתח ו-/{product_id} הוא מזהה המוצר.
כברירת מחדל, התוצאות כוללות רק תוכנית תמחור ציבורית. כדי להציג תוכנית מחירים פרטית,
מגדירים את פרמטר השאילתה showPrivate לערך true (לדוגמה,
?showPrivate=true).
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
הצגת כל תוכניות התמחור שהמפתח מקבל באמצעות ה-API
כדי לראות את תוכניות התמחור שאושרו על ידי מפתח, שולחים בקשת GET אל
/mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans,
כאשר {developer_id} הוא מזהה המפתח.
אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:
| פרמטר שאילתה | תיאור |
|---|---|
all |
דגל שמציין אם להחזיר את כל חבילות ה-API. אם הערך מוגדר ל-false, מספר חבילות ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false. |
size |
מספר חבילות ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
page |
מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
לדוגמה:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
זוהי דוגמה לתגובה:
{ "developerRatePlan" : [ { "created" : "2018-01-25 20:01:54", "developer" : { ... }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }], "totalRecords" : 1 }
מחיקת טיוטה של תוכנית תמחור באמצעות API
כדי למחוק טיוטה של תוכנית תמחור, שולחים בקשת DELETE אל
/organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id},
כאשר {plan_Id} הוא המזהה של תוכנית התמחור שרוצים למחוק, ו-{package_id} הוא המזהה של חבילת ה-API של תוכנית התמחור. לדוגמה:
$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password
מאפייני ההגדרה של תוכניות תעריפים
כשיוצרים תוכנית תמחור באמצעות ה-API, אפשר לציין את הגדרות התצורה הבאות.
| שם | תיאור | ברירת מחדל | חובה? |
|---|---|---|---|
advance |
ההנחה תקפה רק לחיובים חוזרים. דגל שמציין אם החיוב החוזר מתבצע מראש או לא. הערכים התקפים כוללים:
|
false | לא |
contractDuration |
משך החוזה של התוכנית יחד עם |
לא רלוונטי | לא |
contractDurationType |
משך החוזה של התוכנית עם
|
לא רלוונטי | לא |
currency |
המטבע שבו מוצגת תוכנית המחירים. מציינים את קוד המטבע לפי תקן ISO 4217, למשל |
לא רלוונטי | כן |
description |
תיאור של תוכנית התמחור. |
לא רלוונטי | כן |
developer |
מזהה המפתח (כתובת אימייל). ההגדרה הזו רלוונטית רק לתוכניות תעריפים למפתחים. |
לא רלוונטי | לא |
developerCategory |
מזהה הקטגוריה של המפתח. ההגדרה הזו רלוונטית רק לתוכניות תמחור לפי קטגוריית מפתחים. |
לא רלוונטי | לא |
displayName |
שם התוכנית לתצוגה, שיהיה ידידותי למשתמש. |
לא רלוונטי | כן |
earlyTerminationFee |
עמלה חד-פעמית שמוחייבת אם המפתח מסיים את התוכנית לפני תקופת החידוש. |
לא רלוונטי | לא |
endDate |
התאריך שבו התוכנית מסתיימת. המפתחים לא יכולים לראות את תוכנית התמחור אחרי התאריך הזה. אם לא רוצים שתוכנית התמחור תסתיים בתאריך מסוים, צריך לציין ערך null
במאפיין התוכנית לתמחור תהיה בתוקף עד סוף היום בתאריך שצוין. לדוגמה, אם רוצים להגדיר שתוקף של תוכנית מחירים יפוג ב-1 בדצמבר 2016, צריך להגדיר את הערך של endDate ל-2016-11-30. במקרה הזה, התוקף של תוכנית התמחור יפוג בסוף היום ב-30 בנובמבר 2016, וכל הבקשות ב-1 בדצמבר 2016 ייחסמו. NOTE: כשצופים בתוכנית התמחור באמצעות ה-API, חותמת הזמן של endDate מצוינת כ- |
לא רלוונטי | לא |
freemiumDuration |
פרק הזמן של תקופת ה-freemium, יחד עם |
לא רלוונטי | לא |
freemiumDurationType |
פרק הזמן של תקופת ה-freemium יחד עם
|
לא רלוונטי | לא |
freemiumUnit |
כמות פריטים בגרסת פרימיום. הערך יכול להיות מספר העסקאות או מספר היחידות שקשורות למאפיין מותאם אישית שתועד במדיניות תיעוד העסקאות. |
לא רלוונטי | לא |
frequencyDuration |
הקרדיט תקף רק לחיובים חוזרים. תקופת הזמן בין חיובים חוזרים, יחד עם |
לא רלוונטי | לא |
frequencyDurationType |
ההנחה תקפה רק לחיובים חוזרים. תקופת הזמן בין חיובים חוזרים, יחד עם frequencyDuration. הערכים התקפים כוללים:
|
לא רלוונטי | לא |
isPrivate |
דגל שמציין אם תוכנית התעריפים היא ציבורית או פרטית. ברירת המחדל היא
false (ציבורי). מידע נוסף זמין במאמר בנושא תוכניות תמחור ציבוריות לעומת פרטיות. |
לא רלוונטי | לא |
monetizationPackage |
מזהה חבילת מוצרים ב-API של תוכנית התמחור. |
לא רלוונטי | לא |
name |
שם תוכנית התמחור. |
לא רלוונטי | כן |
organization |
מזהה הארגון של תוכנית התמחור. |
לא רלוונטי | כן |
paymentDueDays |
השובר תקף רק לחיובים חוזרים. מספר הימים שעד אליהם צריך לשלם את העמלות. לדוגמה, מגדירים את הערך ל-30 כדי לציין שהתשלום יתבצע תוך 30 יום. |
לא רלוונטי | לא |
proRate |
ההנחה תקפה רק לחיובים חוזרים. דגל שמציין אם החיוב החוזר הוא יחסי כשמפתח מתחיל או מסיים תוכנית באמצע החודש. הערכים התקינים כוללים:
|
false | לא |
published |
דגל שמציין אם תוכנית התמחור צריכה להתפרסם כדי שמפתחים יוכלו לראות אותה. הערכים התקפים כוללים:
|
לא רלוונטי | כן |
ratePlanDetails |
פרטים על תוכנית התמחור (ראו מאפייני ההגדרה של פרטי תוכנית התמחור). |
לא רלוונטי | כן |
recurringFee |
עמלה שהמפתח מחויב בה באופן שוטף עד שהוא מסיים את התוכנית. |
לא רלוונטי | לא |
recurringStartUnit |
בתוקף רק אם המדיניות |
לא רלוונטי | לא |
recurringType |
קובעים מתי יחויב התשלום החוזר. הערכים התקפים כוללים:
|
לא רלוונטי | לא |
setUpFee |
עמלה חד-פעמית שמוחלת על כל מפתח בתאריך ההתחלה של התוכנית (כלומר, התאריך שבו המפתח רוכש את התוכנית). |
לא רלוונטי | לא |
startDate |
התאריך שבו התוכנית מתחילה. מפתחים יכולים לראות את תוכנית התמחור החל מהתאריך הזה. |
לא רלוונטי | כן |
type |
סוג תוכנית התעריפים. מציינים אחת מהאפשרויות הבאות:
|
לא רלוונטי | כן |
מאפייני ההגדרה של פרטי תוכנית התעריפים
כשיוצרים את תוכנית התמחור, אפשר לציין כל אחת מהמאפיינים הבאים של ההגדרה כחלק ממערך ratePlanDetails.
| שם | תיאור | ברירת מחדל | חובה? |
|---|---|---|---|
aggregateFreemiumCounters |
דגל שמציין אם מונים מצטברים מופעלים כדי לקבוע אם השימוש במוצר API הוא במסגרת השימוש בחינם. כדי להגדיר תוכנית פרימיום למוצר, צריך להפעיל את האפשרות 'מונה מצטבר'. הערכים התקפים כוללים:
|
לא רלוונטי | לא |
aggregateStandardCounters |
דגל שמציין אם נעשה שימוש במונה מצטבר כדי לקבוע את טווח השימוש (למשל, טווח נפח בתוכנית של כרטיס תעריפים). הערך יכול להיות אחד מהערכים הבאים:
|
לא רלוונטי | לא |
aggregateTransactions |
NOTE: הנכס הזה לא נמצא כרגע בשימוש למונטיזציה, ואפשר להתעלם ממנו. |
true | לא |
currency |
המרת מטבעות |
לא רלוונטי | לא |
duration |
תקופת הזמן של תדירות החישוב, יחד עם לדוגמה, אם מגדירים את |
לא רלוונטי | לא |
durationType |
תקופת הזמן של תדירות החישוב, יחד עם
|
לא רלוונטי | לא |
freemiumDuration |
תקופת הזמן של תקופת הפרימיום למוצר API ספציפי, יחד עם
|
לא רלוונטי | לא |
freemiumDurationType |
תקופת הזמן של תקופת הפרימיום למוצר API ספציפי, יחד עם
לדוגמה, כדי לציין שתקופת הפרימיום של מוצר API היא 30 ימים, מגדירים את |
לא רלוונטי | לא |
freemiumUnit |
כמות מוצרי ה-API בחינם. הערך יכול להיות מספר העסקאות או מספר היחידות שקשורות למאפיין מותאם אישית שתועד במדיניות תיעוד העסקאות. |
לא רלוונטי | לא |
meteringType |
מודל חיוב לתוכנית מחירון. הערכים התקפים כוללים:
|
לא רלוונטי | כן |
organization |
מזהה הארגון. |
לא רלוונטי | לא |
paymentDueDays |
המועד האחרון לתשלום למפתחים שמשלמים בסוף החודש. לדוגמה, אם מגדירים את הערך ל-30, המשמעות היא שהתשלום צריך להתבצע תוך 30 יום. |
לא רלוונטי | לא |
product |
פרטי מוצר ב-API, כמו מזהה. |
לא רלוונטי | לא |
ratePlanRates |
פרטי התעריף של תוכנית התמחור, כמו סוג תוכנית התמחור ( |
לא רלוונטי | כן |
ratingParameter |
הבסיס לתוכנית התמחור. תוכנית התמחור מבוססת על עסקאות או על מאפיין מותאם אישית. הערכים התקפים כוללים:
|
VOLUME |
כן |
ratingParameterUnit |
היחידה שחלה על |
לא רלוונטי | כן |
revenueType |
הבסיס לחלוקת ההכנסות בתוכנית לחלוקת הכנסות. הערכים התקפים כוללים:
|
לא רלוונטי | לא |
type |
סוג תוכנית התמחור. הערכים התקפים כוללים:
מידע נוסף על סוגי תוכניות התמחור זמין במאמר סוגי תוכניות תמחור נתמכים. |
לא רלוונטי | כן |