ניהול תוכניות תמחור למוצרי API

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

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

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

בקטעים הבאים מוסבר איך לנהל תוכניות תמחור למוצרי ה-API.

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

צפייה בתוכניות תמחור

בקטעים הבאים מוסבר איך לראות את תוכניות התמחור בארגון.

ממשק המשתמש של Apigee

אפשר לעיין בתוכניות התמחור כמו שמתואר בקטעים הבאים:

• צפייה בתוכניות תמחור שהוגדרו לארגון
• איך רואים את תוכניות התמחור שמשויכות למוצר API

איך צופים בתוכניות התמחור שהוגדרו לארגון

בדף 'תוכניות תמחור' אפשר לראות את תוכניות התמחור שהוגדרו לארגון.

כדי לגשת לדף 'תוכניות תמחור':

במסוף Google Cloud , עוברים לדף Apigee > Distribution > Monetization.

עוברים לכרטיסייה 'מונטיזציה'

הדף Rate Plans (תוכניות תמחור) נפתח ומוצגות בו תוכניות התמחור הנוכחיות.

בדף 'תוכניות תמחור' אפשר:

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

צפייה בתוכניות תמחור שמשויכות למוצר API

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

Apigee API

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

• רשימת תוכניות התמחור למוצר API
• הצגת הפרטים של תוכנית תמחור

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

כדי להציג את תוכניות התמחור של הארגון, שולחים בקשת GET אל ה-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

לדוגמה, באמצעות curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בדוגמה הבאה מוצג פלט התגובה, כולל שני תוכניות התמחור, myrateplan1 ו-myrateplan2 שמשויכות למוצר API‏ HelloworldProduct:

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

מידע נוסף על ה-API ועל מטען הייעודי (payload) של התגובה שלו זמין במאמר בנושא List rate plans API.

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

כדי לראות את הפרטים של תוכנית תמחור, שולחים בקשת GET ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

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

לדוגמה, באמצעות curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בדוגמה הבאה מוצגת פלט התגובה של תוכנית התמחור עם השם 6b51b501-ac15-41b7-bb3e-621edb849e13 והשם המוצג myrateplan2:

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

מידע נוסף על ה-API ועל מטען הייעודי (payload) של התגובה שלו זמין במאמר בנושא Get rate plan API.

יצירת תוכניות תמחור

יוצרים תוכניות מחירים כמו שמתואר בקטעים הבאים.

ממשק המשתמש של Apigee

כדי ליצור תוכנית תמחור:

1. במסוף Google Cloud , עוברים לדף Apigee > Distribution > Monetization.

עוברים לכרטיסייה 'מונטיזציה'

2. מבצעים אחת מהמשימות הבאות:
   • לוחצים על יצירה.
   • עורכים מוצר API ולוחצים על Add rate plan בקטע Rate plans.
3. מזינים את פרטי תוכנית התמחור באופן הבא:

   שדה	תיאור
   שם תוכנית התמחור	מזינים את השם של תוכנית התמחור.
   מוצר API	בוחרים מהתפריט הנפתח את מוצר ה-API שאליו רוצים לשייך את תוכנית התמחור.

4. לוחצים על הבא.
5. מזינים את פרטי החיוב באופן הבא:

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

6. לוחצים על הבא.
7. מזינים את פרטי התמחור באופן הבא.

   שדה	תיאור	ברירת מחדל
   עמלה קבועה וחוזרת	הפעלת עמלה קבועה חוזרת ליחידה: בוחרים באפשרות גביית תשלום חוזר קבוע. מגדירים את התדירות של העמלה הקבועה ואת הסכום של העמלה הקבועה החוזרת. העמלה תחושב באופן יחסי לתקופת החיוב הראשונה. אם האפשרות הזו מופעלת, אפשר לראות בתצוגה מקדימה את ההשפעה של העמלה הקבועה שחוזרת על עצמה על החיובים המפורטים והכוללים, כמו שמתואר במאמר תצוגה מקדימה של תוכנית התמחור. כדי להשבית את העמלה, מבטלים את הסימון של גביית עמלה קבועה חוזרת.	מושבת
   עמלות שמבוססות על צריכה	כדי להפעיל תמחור לפי צריכה: בוחרים באפשרות גביית עמלה לפי צריכה. בוחרים באחת מהאפשרויות הבאות: עמלה קבועה ליחידה (עמלה קבועה לכל יחידה שנצרכה) מדורג (עמלה משתנה לכל יחידה שנצרכת, שנקבעת לפי טווחי צריכה) עמלה קבועה ליחידה: עמלה קבועה שמוחלת על כל עסקה שמניבה הכנסות. מזינים ערך בשדה Fixed fee per unit (עמלה קבועה לכל יחידה) שיוחייב על כל עסקה. מדורגת: על כל עסקה שמניבה הכנסות נגבית עמלה משתנה. העמלות של עסקה נקבעות לפי טווח העסקה והצריכה. טווח מתייחס לטווח צריכת API, ולכל טווח יש עמלה שונה. בקטע Ranges of unit consumption אפשר לציין את טווחי הדירוג ואת העמלות התואמות לדירוג. אפשר לציין כמה טווחים שרוצים בלחיצה על + טווח. דוגמה: נניח שאתם רוצים לחייב את 1,000 הקריאות הראשונות ל-API ב-2 דולר לקריאה, ואת כל הקריאות הבאות ל-API בדולר אחד לקריאה. כדי להגדיר את זה, מציינים את שני התדרים הבאים בקטע Ranges of unit consumption: בשורה הראשונה מזינים את הערכים הבאים: התחלה: 0 סיום: 1000 עמלה: 2 בשורה השנייה מזינים את הערכים הבאים: התחלה: 1001 סוף: יחידות ללא הגבלה עמלה: 1 בדוגמה הזו, אם מפתח צורך 1,500 ממשקי API, העמלות הכוללות יהיו 2,500 $ ((1000 * 2) + (500 * 1)). אם מפעילים עמלות כלשהן על סמך צריכה, אפשר לראות בתצוגה מקדימה את ההשפעות של סוג העמלה שנבחר על ההכנסות הכוללות, כמו שמתואר במאמר תצוגה מקדימה של תוכנית התמחור. כדי להשבית את העמלה, מבטלים את הסימון של האפשרות מודל תמחור של תשלום לפי שימוש. אם הגדרתם את משתנה המונטיזציה perUnitPriceMultiplier במדיניות DataCapture, העלות לכל טרנזקציה שצוינה בכל סוג של עמלות מבוססות-צריכה (עמלה קבועה לכל יחידה או עמלה מדורגת) מוכפלת בערך של perUnitPriceMultiplier. הערה: מונטיזציה של עסקה מתבצעת על סמך הערך של משתנה המונטיזציה transactionSuccess. מידע נוסף זמין במאמר בנושא משתני מונטיזציה.	מושבת

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

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

10. לוחצים על הבא.
11. לוחצים על אחת מהאפשרויות הבאות:
    • שמירה ופרסום כדי לשמור ולפרסם את תוכנית התמחור. תתבקשו לבחור תאריך הפעלה. מידע נוסף זמין במאמר בנושא הגדרת תאריך ההפעלה של תוכנית התמחור.
    • שמירה כדי לשמור טיוטה של תוכנית התמחור.
    • מקישים על ביטול כדי לבטל.

Apigee API

כדי ליצור תוכנית תמחור, שולחים בקשת POST אל ה-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

מגדירים את תוכנית התמחור על ידי העברת שדות החובה בגוף הבקשה, כמו שמתואר במאמר משאב: RatePlans.

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

שדות חובה לתוכנית תמחור בסטטוס טיוטה	שדות חובה לתוכנית מחירים שפורסמה
apiproduct displayName state	apiproduct billingPeriod currencyCode displayName startTime state

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

לדוגמה, הקריאה הבאה ל-API יוצרת תוכנית תמחור בשלב טיוטה בשם myrateplan5 שמשויכת למוצר ה-API‏ HelloworldProduct:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט של התגובה:

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

מידע נוסף מופיע במאמר בנושא יצירת תוכנית תמחור באמצעות API

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

1. במסוף Google Cloud , נכנסים לדף Distribution > Monetization (הפצה > מונטיזציה).

   עוברים לכרטיסייה 'מונטיזציה'

2. לוחצים על תוכנית תמחור קיימת או על יצירה.

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



4. כדי לשנות את ההערכות בתצוגה המקדימה, מעדכנים את השדה API unit consumption בקטע Example consumer data. החיובים המפורטים והסכומים הכוללים מתעדכנים על סמך הנתונים שתזינו.

5. מעדכנים את השדות הבאים בקטע Example consumer data:

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

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

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

כשמגדירים את זמני ההפעלה והתפוגה, חשוב לקחת בחשבון את הנקודות הבאות:

• בכל זמן נתון, רק תוכנית תמחור אחת יכולה להיות פעילה למוצר API.
• אפשר לפרסם כמה תוכניות תמחור לאותו מוצר API עם זמני הפעלה ותפוגה שלא חופפים.
• צריך להגדיר את זמן ההפעלה של תוכנית תמחור לפני פרסום שלה.
  כשמפרסמים תוכנית תמחור באמצעות ממשק המשתמש, אם לא הוגדר זמן הפעלה, תופיע בקשה להגדיר אותו.
• שעת ההפעלה צריכה להיות מוקדמת משעת התפוגה (אם היא מוגדרת), ושעת התפוגה צריכה להיות מאוחרת משעת ההפעלה.
• לא חובה לציין את זמן התפוגה. אם לא מציינים תאריך תפוגה, ברירת המחדל היא Never (התוכנית לא תפוג לעולם).
• כשמגדירים את זמני ההפעלה והתפוגה באמצעות ממשק המשתמש, אפשר לציין רק את התאריך ולא את השעה ביום (hh:mm:ss:mmm). השעה ביום של ערכי ההפעלה והתפוגה מוגדרת כברירת מחדל ל-12:00:00:000 AM ול-11:59:59:999 PM, בהתאמה.

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

ממשק המשתמש של Apigee

כדי להגדיר את שעת ההפעלה של תוכנית תמחור:

1. כניסה לדף Rate Plans
2. לוחצים על עוד ואז על הגדרת הפעלה בתוכנית התמחור שרוצים להגדיר לה את זמן ההפעלה.
3. בוחרים באחת מהאפשרויות הבאות:
   • Undetermined (לא נקבע) כדי לבטל את הגדרת זמן ההפעלה של תוכנית התמחור (האפשרות הזו זמינה רק לתוכניות תמחור בסטטוס 'טיוטה').
   • באופן מיידי כדי להגדיר את תוכנית התמחור כפעילה באופן מיידי.
   • בתאריך עתידי כדי לבחור את התאריך שבו תוכנית התמחור תהיה פעילה.
4. לוחצים על הגדרת הפעלה.
5. אם עדיין לא פרסמתם את תוכנית התמחור, פרסמו אותה כדי שמפתחים יוכלו להשתמש בה באפליקציות שלהם.

כדי להגדיר את מועד התפוגה של תוכנית תמחור:

1. כניסה לדף Rate Plans
2. לוחצים על עוד ואז על הגדרת תאריך תפוגה בתוכנית התמחור שרוצים להגדיר לה תאריך תפוגה.
3. בוחרים באחת מהאפשרויות הבאות:
   • ‫Never (אף פעם) – ברירת המחדל, כדי שתוקף התוכנית לא יפוג לעולם.
   • באופן מיידי כדי להגדיר את תוכנית התמחור כפעילה באופן מיידי.
   • בתאריך עתידי כדי לבחור את התאריך שבו תוכנית התמחור תהיה פעילה.
4. לוחצים על הגדרת תאריך תפוגה.

Apigee API

כדי להגדיר את זמני ההפעלה או התפוגה של תוכנית תמחור באמצעות ה-API:

1. צופים בפרטים של תוכנית התמחור שרוצים לעדכן.
2. משתמשים בתשובה כדי ליצור את גוף הבקשה ומעדכנים את השדות הבאים:
   • ‫startTime כדי להגדיר את שעת ההפעלה
   • ‫endTime כדי להגדיר את שעת התפוגה
   הערה: כשמעדכנים תוכנית מחירים באמצעות ה-API, הגדרות התצורה שמציינים בבקשה מחליפות את כל ההגדרות הקיימות. חשוב לציין ערכים לכל ההגדרות שרוצים לשמור, גם אם הן לא משתנות. אחרת, ההגדרות יוסרו.

3. כדי לעדכן את תוכנית התמחור עם ההגדרה החדשה, שולחים בקשת PUT ל-API הבא ומעבירים את גוף הבקשה ששונה בבקשה: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

לדוגמה, הפקודה הבאה מגדירה את שעת ההפעלה ל-1 באפריל 2021 (1617302588000 זמן epoch):

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

מידע נוסף על השדות שאפשר לציין בגוף הבקשה זמין במאמר משאב: RatePlans.

זוהי דוגמה לפלט של התגובה:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

מידע נוסף זמין במאמר בנושא עדכון תוכנית תמחור באמצעות API

פרסום תוכניות תמחור

מפרסמים תוכניות תמחור כמו שמתואר בקטעים הבאים.

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

ממשק המשתמש של Apigee

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

• כשיוצרים או מעדכנים תוכנית תמחור, אפשר ללחוץ על שמירה ופרסום כדי לשמור ולפרסם את תוכנית התמחור. תוצג לכם בקשה להגדיר את תאריך ההפעלה.
• נכנסים לדף Rate Plans (תוכניות תמחור), לוחצים על ואז על Publish (פרסום) בתוכנית התמחור בטיוטה שרוצים לפרסם.

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

Apigee API

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

1. מציגים את הפרטים של תוכנית התמחור שרוצים לפרסם.
2. משתמשים בתשובה כדי ליצור את גוף הבקשה ומעדכנים את השדות הבאים:
   • מגדירים את state לערך PUBLISHED.
   • מגדירים את startTime לשעת ההפעלה באלפיות השנייה מאז תחילת התקופה של זמן מערכת.
   • אפשר גם להגדיר את endTime לשעת התפוגה באלפיות השנייה מאז תחילת התקופה של זמן מערכת, או להגדיר את הערך Never. אם לא מציינים זמן תפוגה, ברירת המחדל היא Never.
   • מגדירים את שאר השדות שרוצים לשמור.
     הערה: כשמעדכנים תוכנית תמחור באמצעות ה-API, הגדרות התצורה שמציינים בבקשה מחליפות את כל ההגדרות הקיימות. חשוב לציין ערכים לכל ההגדרות שרוצים לשמור, גם אם הן לא משתנות. אחרת, ההגדרות יוסרו.

3. כדי לפרסם את תוכנית המחירים, שולחים בקשת PUT אל ה-API הבא ומעבירים את גוף הבקשה ששונה בבקשה: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

לדוגמה, הפעולה הבאה משנה את הסטטוס של תוכנית התמחור rateplan1 ל-PUBLISHED ומגדירה את זמן ההפעלה ל-1 באפריל 2021, שצוין כאלפיות שנייה מאז תקופת האפוק:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"PUBLISHED",
    "startTime": 1617302588000
    }'

מידע נוסף על השדות שאפשר לציין בגוף הבקשה זמין במאמר Resource: RatePlans.

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט של התגובה:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "PUBLISHED",
    "startTime": "1617302588000"
}

מידע נוסף זמין במאמר בנושא עדכון תוכנית תמחור באמצעות API

העברת תוכניות מחירים שפורסמו למצב טיוטה

מעבירים את תוכניות התמחור שפורסמו לסטטוס 'טיוטה' כמו שמתואר בקטעים הבאים.

ממשק המשתמש של Apigee

כדי להעביר תוכנית תמחור שפורסמה לסטטוס טיוטה:

1. כניסה לדף Rate Plans
2. לוחצים על אפשרויות נוספות ואז על העברה לטיוטה.

התוכנית לתמחור מתעדכנת והשדה Status משתנה לטיוטה.

Apigee API

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

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

3. כדי להעביר את תוכנית המחירים שפורסמה למצב טיוטה, שולחים בקשת PUT ל-API הבא ומעבירים את גוף הבקשה ששונה בבקשה: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

לדוגמה, הפקודה הבאה משנה את הסטטוס של תוכנית התמחור rateplan1 ל-DRAFT:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

מידע נוסף על השדות שאפשר לציין בגוף הבקשה זמין במאמר Resource: RatePlans.

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט של התגובה:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

מידע נוסף זמין במאמר בנושא עדכון תוכנית תמחור באמצעות API

עדכון תוכניות תמחור

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

ממשק המשתמש של Apigee

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

1. כניסה לדף Rate Plans
2. לוחצים על השם של תוכנית התמחור שרוצים לעדכן ברשימה.
3. מעדכנים את תוכנית התמחור לפי הצורך.
4. לוחצים על אחת מהאפשרויות הבאות:
   • שמירה ופרסום כדי לשמור ולפרסם את תוכנית התמחור. תתבקשו לבחור תאריך הפעלה. מידע נוסף זמין במאמר בנושא הגדרת תאריך ההפעלה של תוכנית תמחור.
   • שמירה כדי לשמור טיוטה של תוכנית התמחור.
   • ביטול כדי לבטל את העדכונים.

Apigee API

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

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

3. כדי לעדכן תוכנית מחירים, שולחים בקשת PUT ל-API הבא ומעבירים את גוף הבקשה ששונה בבקשה: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

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

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"5",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"6.5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

מידע נוסף על השדות שאפשר לציין בגוף הבקשה זמין במאמר Resource: RatePlans.

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט של התגובה:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

מידע נוסף זמין במאמר בנושא עדכון תוכנית תמחור באמצעות API

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

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

מאמרים קשורים:

• פרסום תוכניות תמחור
• הגדרת זמני ההפעלה והתפוגה של תוכנית תמחור

שיבוט של תוכניות תמחור

משכפלים תוכניות תמחור כדי ליצור תוכניות תמחור כפולות שמבוססות על תוכניות תמחור קיימות.

ממשק המשתמש של Apigee

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

1. כניסה לדף Rate Plans
2. בוחרים באפשרות ואז באפשרות שיבוט.
3. מעדכנים את השדות שם תוכנית התמחור ומוצר API.
4. לוחצים על Clone (שיבוט).

התוכנית לתמחור נוספת לרשימה של תוכניות לתמחור.

Apigee API

כדי לשכפל תוכנית תמחור באמצעות ה-API:

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

מחיקת תוכניות תמחור

מחיקה של תוכנית תמחור היא סופית. תוכנית התמחור תימחק באופן מיידי ולא ניתן יהיה לשחזר אותה.

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

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

ממשק המשתמש של Apigee

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

1. כניסה לדף Rate Plans
2. בוחרים באפשרות ואז באפשרות מחיקה לתוכנית התמחור שרוצים למחוק.
3. מוודאים שזו תוכנית התמחור שרוצים למחוק ולוחצים על מחיקה.

תוכנית התמחור נמחקת ומוסרת מהרשימה.

Apigee API

כדי למחוק תוכנית תמחור, שולחים בקשת DELETE אל ה-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME.

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

לדוגמה, הפקודה הבאה מוחקת את תוכנית התמחור עם השם cc6252c0-c5d0-4aaf-85f2-203ec8fa5707 והשם המוצג myrateplan3:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN

‫$TOKEN מוגדר כאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט של התגובה:

{
    "name": "93ca14aa-7a48-4384-ae09-c85a0e8a8df8",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

מידע נוסף זמין במאמר בנושא מחיקת תוכניות תמחור באמצעות API.