כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
בקטע הזה מוסבר איך לרכוש תוכנית תעריפים שפורסמה, ואיך לבטל או לבטל תוכנית תעריפים שנרכשה באמצעות ה-API.
רכישת תוכנית תעריפים שפורסמה באמצעות ה-API
לאחר פרסום תוכנית תעריפים, מפתח או חברה יכולים לרכוש (או 'לאשר') אותה על ידי שליחת בקשת POST אל
/mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans
,
כאשר {org_name}
הוא שם הארגון
ו-{developer_or_company_id}
הוא המזהה של המפתח או החברה.
כדי לוותר על עמלות ההגדרה במהלך רכישה של תוכנית תמחור ותשלומים, צריך להגדיר את פרמטר השאילתה waivefees
כ-true
. הסימון הזה שימושי כשמעבירים מפתחים למונטיזציה, כפי
שמתואר במאמר העברת מפתחים למונטיזציה.
בטבלה הבאה מוצג סיכום של מאפייני התצורה שאפשר לציין בגוף הבקשה, ערכי ברירת המחדל ואם הם נדרשים או לא.
שם | תיאור | ברירת המחדל | חובה? |
---|---|---|---|
startDate |
התאריך שבו תוכנית התמחור והתשלומים מתחילה. לדוגמה: 2017-03-24. |
לא רלוונטי | כן |
endDate |
התאריך שבו תוכנית התמחור והתשלומים תסתיים. לדוגמה: 2017-09-24. תוכנית התעריפים תהיה בתוקף עד סוף היום בתאריך שצוין. לדוגמה, אם רוצים שתוקף תוכנית התמחור יפוג ב-1 בדצמבר 2017, צריך להגדיר את הערך של endDate כ-2017-11-30. במקרה כזה, התוקף של תוכנית התעריפים יפוג בסוף היום ב-30 בנובמבר 2017, וכל הבקשות ב-1 בדצמבר 2017 ייחסמו. |
לא רלוונטי | לא |
developer |
נכס |
לא רלוונטי | כן |
quotaTarget |
מספר יעד העסקאות המותר למפתח האפליקציה. אפשר לקבוע אם ומתי יישלחו התראות על סמך האחוז ממספר היעד שהושג, כגון 90%, 100% או 150%. עסקאות נוספות לא ייחסמו אחרי הגעה למספר היעד. יש להגדיר את הערך הזה לערך של מספר שלם חיובי, או כ-0 כדי להשבית התראות למפתחי אפליקציות. |
0 |
לא |
ratePlan |
נכס המזהה של תוכנית התמחור והתשלומים שונה מהשם המוצג. כדי לראות את הפרטים של תוכנית התעריפים, כולל המזהה, יש לעיין בדף סקירת תוכניות התעריפים. |
לא רלוונטי | כן |
suppressWarning |
סימון שמציין אם להסתיר את השגיאה אם המפתח מנסה לרכוש תוכנית תעריפים שחופפת לתוכנית תעריפים אחרת שנרכשה. הערך יכול להיות אחד מהערכים הבאים:
|
לא רלוונטי | לא |
waveTerminationCharge |
סימון שמציין אם מוותרים על עמלות סיום כשתוכנית תעריפים פעילה מסתיימת במהלך הפעלת תוכנית התמחור החדשה. הערך יכול להיות אחד מהערכים הבאים:
|
לא רלוונטי | לא |
לדוגמה, הבקשה הבאה רוכשת את תוכנית התעריפים של location_&_messaging
למפתח שצוין:
curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \ -X POST \ -H "Content-Type:application/json" \ -u email:password \ -d '{ "developer":{ "id":"5cTWgdUvdr6JW3xU" }, "startDate":"2017-08-30", "ratePlan":{ "id":"location_&_messaging" }, "suppressWarning":false }'
בדוגמה הזו, המאפיין suppressWarning
מוגדר ל-false
. במקרה
זה, תישלל הודעת שגיאה במקרה של התנגשות. לדוגמה, אם המפתח
ינסה לרכוש תוכנית תמחור ותשלומים שחופפת לתוכנית תעריפים אחרת שנרכשה, המערכת תציג הודעת שגיאה. כך אפליקציה שמספקת ממשק משתמש למונטיזציה יכולה ליירט את השגיאה ולהציג את המוצרים המתנגשים למפתח לצורך אישור (לפי הצורך). אם
suppressWarning
מוגדרת לערך true
, המונטיזציה תפסיק את כל תוכניות התעריפים שנרכשו שהמפתח צריך לחבילות API שמכילות את המוצרים המתנגשים. לאחר מכן
הוא רוכש חבילת API חדשה עבור המפתח.
בעקבות הבקשה שבהמשך, רוכשים תוכנית תמחור מותאמת אישית לשליחת התראות, ומספר היעד של העסקאות הוא 4,000.
curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \ -X POST \ -H "Content-Type:application/json" \ -u email:password \ -d '{ "developer":{ "id":"5cTWgdUvdr6JW3xU" }, "ratePlan":{ "id":"adjustable-notification-plan" }, "startDate": "2017-03-24", "quotaTarget": 4000, "suppressWarning":false }'
בכל אחת מהדוגמאות שלמעלה, אם מוחזרת הודעת השגיאה הבאה:
Developer legal name not specified.
לאחר מכן צריך להגדיר את מאפייני המונטיזציה MINT_DEVELOPER_ADDRESS
ו-MINT_DEVELOPER_LEGAL_NAME
, ואז לחזור על הקריאה ל-API.
תוקף תוכנית התמחור והתשלומים שנרכשה על ידי מפתח באמצעות ה-API עומד לפוג
כדי לבטל (או לבטל) תוכנית תעריפים שנרכשה על ידי מפתח, צריך לעדכן את הפרטים של
תוכנית התעריפים שנרכשה ולציין את הנכס endDate
בגוף הבקשה
בבקשת PUT
למשאב /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id}
.
תוכנית התעריפים תהיה בתוקף עד סוף היום בתאריך הסיום שצוין. לדוגמה, אם רוצים שתוקף תוכנית התעריפים יפוג ב-1 בדצמבר 2017, צריך להגדיר את הערך של endDate כ-2017-11-30. במקרה כזה, התוקף של תוכנית התעריפים יפוג בסוף היום ב-30 בנובמבר 2017. כל הבקשות ב-1 בדצמבר 2017 ייחסמו.
הערך {developer_rateplan_id}
מוחזר בתגובה כשרוכשים
את תוכנית התעריפים שפורסמה.
לדוגמה:
{ "created": "2017-03-31 18:59:54", "developer": { ... }, "id": "b1c600b8-f871-496d-8173-12b9950d6ab1", "quotaTarget": 3000, "ratePlan": { ... }, "startDate": "2017-03-31 00:00:00", "updated": "2017-03-31 18:59:54", "waiveTerminationCharge": false }
לחלופין, אפשר לקבל את {developer-rateplan-id}
לתוכנית התעריפים למפתחים על ידי שליחת בקשת GET
אל /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
,
כאשר {developer_id}
היא כתובת האימייל של המפתח. מידע נוסף זמין במאמר איך רואים את כל תוכניות התעריפים שנרכשו על ידי מפתח.
הבקשה הבאה מעדכנת את תאריך הסיום ל-1 בדצמבר 2017. במילים אחרות, התוקף של תוכנית התעריפים יפוג ב-30 בנובמבר 2017 בסוף היום, וכל הבקשות החל מ-1 בדצמבר 2017 ייחסמו.
curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1" -X PUT \ -H "Content-Type:application/json" \ -u email:password \ -d '{ "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1", "developer":{ "id":"dev@mycompany.com" }, "ratePlan":{ "id":"p1_adjustable-notification-plan" }, "startDate": "2017-04-15 00:00:00", "endDate": "2017-11-30", "quotaTarget": 3000, "suppressWarning":false }'