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

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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

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

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

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

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

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

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

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

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

מאפיין (property)	תיאור	ברירת המחדל	חובה?
`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