פתרון בעיות הקשורות למונטיזציה

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

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

המפתח הושעה

תיאור הבעיה

המפתח מושעה ולא יוכל לבצע עסקאות מונטיזציה נוספות/קריאות נוספות ל-API.

הודעות שגיאה

<error>
   <messages>
        <message>Exceeded developer limit configuration -</message>
        <message>Is Developer Suspended - true</message>
   </messages>
</error>

אבחון

כדי לברר את הסיבה להשעיית המפתח, מבצעים את השלבים הבאים:

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

      curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org}/suspended-developers/{developer-email}" -u orgadminEmail:password
      

   2. אם אתם משתמשים בענן פרטי, עליכם להשתמש ב-API הבא:

      curl -X GET "http://<management-host>:<port#>/v1/mint/organizations/{org}/suspended-developers/{developer-email}" -u orgadminEmail:password
      

2. משווים את קוד השגיאה לקודי הסיבות הבאים כדי לקבוע מדוע המפתח הושעה.

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

קוד סיבה	הסיבה	פרטים
INSUFFICIENT_FUNDS	היתרה בחשבון המפתח נוצלה במלואה	אם אין מספיק כסף ביתרה של חשבון הפיתוח בתשלום מראש, לביצוע עסקאות נוספות, המפתח יושעה. מפתחים שמשלמים לאחר השימוש (postpay) יכולים לקבל את השגיאה הזאת אם הם חורגים ממסגרת האשראי או אם מיציתם את מסגרת האשראי שהוגדרה במטבע שבו נעשה שימוש.
LIMIT_VIOLATED RATE_PLAN_RATE_BAND_EXCEEDED	המפתח לא יכול לבצע עסקאות נוספות	כל מפתח רשאי לבצע מספר קבוע של עסקאות על סמך תוכנית התמחור והתשלומים שנרכשה. אם תהיה חריגה ממספר העסקאות, המפתח מושעה ולא יכול להשלים עסקאות נוספות.
NO_CURRENT_PUBLISHABLE_ENTITY	המפתח לא רכש תוכנית תמחור ותשלומים	מפַתח צריך לרכוש תוכנית תמחור ותשלומים לפני השלמת עסקאות.

רזולוציה

שגיאה	שלבים לפתרון הבעיה
INSUFFICIENT_FUNDS	כדי להשלים עסקאות נוספות, המפתח צריך לוודא שיש יתרה מספקת בחשבון או שיש זיכוי זמין.
LIMIT_VIOLATED RATE_PLAN_RATE_BAND_EXCEEDED	מבצעים את הקריאות הבאות ל-API כדי לקבל את מחירון למפתחים ואת פרטי העסקאות, בהתאמה: מריצים את הקריאה הבאה ל-API כדי לקבל את תאריכי ההתחלה והסיום של תוכניות התעריפים שהמפתח רכש: http://docs.apigee.com/monetize/apis/get/organizations/%7Borg_name%7D/developers/%7Bdeveloper_id%7D/developer-accepted-rateplans כדי לקבל את מספר העסקאות שבוצעו בהצלחה על ידי המפתח, מריצים את הקריאה הבאה ל-API: http://docs.apigee.com/monetize/apis/get/organizations/%7Borg_name%7D/transactions/developers/%7Bdeveloper_email_or_id%7D בממשק המשתמש של Edge אפשר גם לבדוק את מספר השיחות שמותר למפתח לבצע על ידי בחירה באפשרויות הבאות: Packages > PackageName > RatePlanName > Rate Card לדוגמה, אם שם החבילה הוא Pro Package ו-Free Plan, הנתיב יהיה: חבילות > חבילת Pro > תוכנית חינם > מחירון
NO_CURRENT_PUBLISHABLE_ENTITY	המפתח צריך לרכוש תוכנית תמחור ותשלומים כדי לבצע קריאות ל-API.

בעיות בהגדרת המונטיזציה

תיאורי בעיות

הבעיות בהגדרת המונטיזציה יכולות לבוא לידי ביטוי בתסמינים שונים, למשל:

• הפונקציונליות של ה-webhooks לא פועלת
• לא ניתן ליצור webhooks
• לא מופעלות התראות על תגובה לפעולה מאתר אחר (webhook)
• דוחות מונטיזציה שלא מציגים עסקאות כלל. לדוגמה, לפי נתוני Analytics, המפתח ביצע הרבה עסקאות בפרק זמן מסוים, אבל בדוחות המונטיזציה לא מפורטות העסקאות האלה.
• עסקאות לא מתועדות

הודעות שגיאה

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

סיבות אפשריות

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

אבחון הסיבה

1. אפשר להשתמש בקריאה ל-API לניהול המתוארת בקטע הבא כדי לבדוק אם מתבצעת מונטיזציה בטרנזקציות.

   הצגת הסטטוס של עסקאות

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

הסיבות האופייניות לעסקאות שלא מתבצעת בהן מונטיזציה הן:

• המדיניות בנושא בדיקת מגבלות המונטיזציה לא מצורפת לשרת proxy ל-API
• לא ניתן לייצר הכנסות מ-APIProduct
• המדיניות בנושא הקלטת עסקאות הוגדרה באופן שגוי
• המפתח לא רכש תוכנית תמחור ותשלומים

הקטעים הבאים מתארים איך לאבחן ולפתור כל בעיה.

המדיניות בנושא בדיקת מגבלות המונטיזציה לא משמשת בשרת proxy ל-API

אבחון

1. בודקים אם המדיניות בנושא בדיקת מגבלות המונטיזציה מצורפת לשרתי ה-proxy של ה-API.
2. אם המדיניות לא מצורפת, יכול להיות שזו הסיבה שהטרנזקציות רשומות כ-FAILED.

רזולוציה

צריך לצרף את המדיניות בנושא בדיקת מגבלות המונטיזציה לשרתי ה-API הנדרשים, כפי שמתואר במאמר אכיפת הגבלות מונטיזציה בשרתי proxy של API.

אם הבעיה נמשכת, צריך לסמן את התיבה לא הופעלה מונטיזציה במוצר ב-API.

לא הופעלה מונטיזציה במוצר ה-API

אבחון

1. צריך לבדוק אם במוצר ה-API מתבצעת מונטיזציה (רק מוצרי API שעברו מונטיזציה מדורגים ויוצגו בקטע 'עסקאות'). מוצר שמייצר הכנסות הוא מוצר שיש לו לפחות תוכנית פעילה אחת של תעריפים.
2. משתמשים בקריאה הבאה ל-API לניהול כדי להציג את רשימת מוצרי ה-API שמשמשים לצורכי מונטיזציה:
   1. אם אתם משתמשים בענן ציבורי, עליכם להשתמש ב-API הבא:

      curl -v https://api.enterprise.apigee.com/v1/mint/organizations/{org_id}/products?monetized=true -u orgadminEmail:password
      

   2. אם אתם משתמשים בענן פרטי, עליכם להשתמש ב-API הבא:

      curl -v http://<management-host>:<port#>/v1/mint/organizations/{org_id}/products?monetized=true -u orgadminEmail:password
      

3. אם לא מתבצעת מונטיזציה במוצר ה-API שמשויך לשרת ה-API של ה-API, ייתכן שזו הסיבה לכך שלא מתבצעת מונטיזציה בטרנזקציות.

רזולוציה

כדי לייצר הכנסות ממוצר של API, צריך לבצע את השלבים הבאים:

1. הגדרת המדיניות בנושא תיעוד טרנזקציות.

2. צריך לוודא שלמוצר ה-API יש תוכנית תמחור ותשלומים פעילה.

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

המדיניות בנושא תיעוד עסקאות הוגדרה באופן שגוי

אבחון

1. הפעלת מעקב אחר ממשק המשתמש עבור שרת ה-API של שרת ה-API שאליו מצורפת המדיניות בנושא בדיקת מגבלות המונטיזציה.
2. בוחרים בקשת API מסוימת מתוך מעקב ממשק המשתמש.
3. בוחרים את התהליך של AX ב-Analytics ובודקים אם למשתני התהליך הבאים של מונטיזציה (mint) יש את הערכים המתאימים:

   mint.tx.status - Should match the value set up for "success criteria" in the transaction recording policy for the API product being used. When tracing, the txProviderStatus in the transaction recording policy is stored in the variable 'mint.tx.status'.
   mint.tx.app_id - Application id of API product.
   mint.tx.prod_id - API product id.
   

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

   

5. אם מופיעה שגיאה במשתנה mint.tx.status, המשמעות היא שהמדיניות של תיעוד העסקאות לא מוגדרת.

רזולוציה

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

המפתח לא רכש תוכנית תמחור ותשלומים

אבחון

1. משתמשים בקריאה הבאה ל-API לניהול כדי לאמת את תוכניות התעריפים שנרכשו על ידי המפתח:
   1. אם אתם משתמשים ב-Public Cloud, תוכלו להשתמש ב-API הבא:

      curl -v https://api.enterprise.apigee.com/v1/mint/organizations/{org}/developers/{dev_email}/products/{prod}/developer-rateplans -u orgadminEmail:password
      

   2. אם אתם משתמשים בענן פרטי, עליכם להשתמש ב-API הבא:

      curl -v http://<management-host>:<port#>/v1/mint/organizations/{org}/developers/{dev_email}/products/{prod}/developer-rateplans -u orgadminEmail:password
      

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

רזולוציה

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

אם הבעיה נמשכת, יש לפנות לתמיכה של Apigee Edge.