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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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