העברת מפתחים למונטיזציה

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

   הערה: כדי לוותר על דמי ההגדרה, אם כבר חויבתם, צריך להגדיר את פרמטר השאילתה waivefees לערך true.

6. אם למפתח שאתם מעבירים יש עסקאות קיימות, אתם יכולים להעביר את השימוש בעסקאות באופן ידני באמצעות המשאב הבא:
   /organizations/{org_name}/transactions, כאשר {org_name} הוא השם של הארגון.

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

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

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

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

   נכס	תיאור	ברירת מחדל	חובה?
   application	המזהה של אפליקציית המפתח.	לא רלוונטי	כן
   batchSize	מספר העסקאות שרוצים להעביר.	1	לא
   custAttn	הערך של המאפיין המותאם אישית שמשמש עם batchSize לחישוב השימוש בעסקאות. מספר המאפיין המותאם אישית בהודעה צריך להיות מספר שלם חיובי או מספר עשרוני (עד ארבע ספרות אחרי הנקודה). אסור להזין ערכים שליליים. צריך להגדיר את המאפיין המותאם אישית ב: מדיניות תיעוד העסקאות של מוצר ה-API. הגדרת מדיניות לתיעוד עסקאות תוכנית תמחור פעילה למוצר ה-API. איך מגדירים תוכנית תמחור עם מאפיינים מותאמים אישית	לא רלוונטי	כן
   product	המזהה של מוצר ה-API.	לא רלוונטי	כן
   type	הערך חייב להיות CHARGE (שהוא ברירת המחדל).	CHARGE	לא

   כדי לדלג על שלבי האימות ולהגדיר בכוח את מספר העסקאות, מגדירים את פרמטר השאילתה force לערך true (לדוגמה, ?force=true). כברירת מחדל, מתבצעים שלבי האימות ?force=false. לדוגמה, אם למפתח עם חשבון בתשלום מראש יש יתרה אפסית והפעילות בחשבון מושעית, ?force=false הבקשה תיכשל במהלך האימות.

   לדוגמה, הבקשה הבאה מגדירה את מספר העסקאות ל-50 עבור האפליקציה ומוצר ה-API שצוינו:

   $ curl -H "Content-Type:application/json" -X POST -d \
   '{ 
      "application":{
        "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
      },
      "product":{
        "id":"testproduct"
      },
      "batchSize":50
   }' \
   "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
   -u email:password
   

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

   $ curl -H "Content-Type:application/json" -X POST -d \
   '{ 
      "application":{
        "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
      },
      "product":{
        "id":"testproduct"
      },
      "batchSize": 125,
      "custAtt1" : 0.1
   }' \
   "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
   -u email:password
   

7. אם לא חויב מפתח בעמלות ההגדרה או בעמלות הקבועות הנדרשות, אפשר לחייב אותו ידנית בעמלת הגדרה או בעמלה קבועה על תוכנית תמחור באמצעות המשאב הבא:
   /organizations/{org_name}/transactions, כאשר {org_name} הוא השם של הארגון.

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

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

   נכס	תיאור	ברירת מחדל	חובה?
   currency	המטבע שבו מוצגת תוכנית המחירים. מציינים את קוד המטבע לפי תקן ISO 4217, למשל usd לדולר ארה"ב או chf לפרנק שווייצרי.	לא רלוונטי	כן
   developer	המזהה של המפתח.	לא רלוונטי	כן
   rate	עמלת הגדרה או עמלה קבועה לחיוב.	לא רלוונטי	כן
   ratePlan	המזהה של תוכנית התמחור.	לא רלוונטי	כן
   type	הערך שהוגדר הוא SETUPFEES או RECURRINGFEES.	CHARGE	כן

   כדי לדלג על שלבי האימות ולחייב את העמלה בכוח, מגדירים את פרמטר השאילתה force לערך true (לדוגמה, ?force=true). כברירת מחדל, מתבצעים שלבי האימות ?force=false. לדוגמה, אם למפתח עם חשבון בתשלום מראש יש יתרה אפסית והפעילות בחשבון מושעית, ?force=false הבקשה תיכשל במהלך האימות.

   לדוגמה, בבקשה הבאה מחויב מפתח שנרשם לתוכנית התמחור בדמי הקמה בסך 10 דולר ארה"ב:

   $ curl -H "Content-Type:application/json" -X POST -d \
   '{ 
      "developer":{
        "id":"dev1@myorg.com"
      },
      "currency":{
        "id":"usd"
      },
      "ratePlan":{
        "id":"mypackage_rateplan1"
      },   
      "rate":10,
      "type":"SETUPFEES"
   }' \
   "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
   -u email:password