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

מוצג המסמך של 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. הסימון הזה שימושי כאשר אתם מעבירים מפתחים למונטיזציה, למשל שמתואר במאמר העברת מפתחים אל מונטיזציה.

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

לדוגמה, הבקשה הבאה רוכשת את תוכנית התעריפים של 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 חדשה למפתח.

הבקשה הבאה רוכשת תוכנית ניתנת להתאמה של תעריפי התראות ומגדירה את מספר היעד של עסקאות ל-4000.

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 עד 30-11-2017. במקרה הזה, הפרמטר התוקף של תוכנית התמחור והתשלומים יפוג בסוף היום ב-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
  }'