דף זה תורגם על ידי Cloud Translation API.

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

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

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

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

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

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

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

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

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

נכס	תיאור	ברירת מחדל	חובה?
`application`	המזהה של האפליקציה למפתחים.	לא רלוונטי	כן
`batchSize`	מספר העסקאות שרוצים להעביר.	1	לא
`custAttn`	הערך של המאפיין המותאם אישית שבו נעשה שימוש יחד עםbatSize כדי לחשב את טרנזקציות. יש לציין את מספר המאפיין המותאם אישית בהודעה כמספר שלם חיובי או עשרוני (עד ארבע ספרות אחרי הנקודה העשרונית). אסור להזין ערכים שליליים. יש להגדיר את המאפיין המותאם אישית באמצעות: מדיניות תיעוד טרנזקציות למוצר ה-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

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

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

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

נכס	תיאור	ברירת מחדל	חובה?
`currency`	המטבע שמשמש בתוכנית התעריפים. מציינים את קוד ISO 4217 של המטבע, למשל דולר ארה"ב או 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