כרגע מוצג התיעוד של Apigee Edge.
נכנסים למסמכי התיעוד של
Apigee X. מידע
לפני שמתחילים
לפני שמתחילים להשתמש במונטיזציה בארגון Apigee, צריך לבצע את המשימות המוקדמות הבאות:
- יוצרים חשבון Apigee Edge, כפי שמתואר ביצירת חשבון Apigee Edge.
- מונטיזציה של רכישה. Edge לא כולל בהתחלה את ממשק ה-API למונטיזציה או משלב את המונטיזציה בממשק המשתמש של הניהול. עליך לרכוש את תכונת המונטיזציה כדי לשלב את רכיבי ה-API למונטיזציה וממשק המשתמש למונטיזציה ב-Edge של הארגון שלך ב-Apigee.
אחרי שרוכשים מונטיזציה, צריך לבצע את המשימות הבאות:
- צריך לעבוד עם צוות ההגדרה של Apigee כדי להשלים את ההגדרה הראשונית של המונטיזציה. מידע נוסף זמין בקטע הגדרה ראשונית באמצעות Apigee.
- הגדרת המונטיזציה. כדאי לעיין בקטע הגדרת מונטיזציה.
- מייצרים הכנסות מממשקי ה-API. מידע נוסף זמין במאמר ייצור הכנסות מממשקי ה-API.
- לנהל מונטיזציה על ידי יצירת דוחות, ניהול יתרות בחשבון ועוד. כדאי לעיין במאמר ניהול מונטיזציה.
הגדרה ראשונית באמצעות Apigee
צריך לעבוד עם צוות התצורה של Apigee Edge כדי להשלים את ההגדרה הראשונית של המונטיזציה. על סמך המידע שלכם, צוות ההגדרות יגדיר את ההגדרות הבאות:
- האם הארגון שלכם הוא חברת תקשורת.
- באיזה סוג חיוב ברצונך לתמוך, מפתחים שרוכשים תוכניות תעריפים: תשלום מראש, תשלום לאחר השימוש (postpay) או שניהם. לפרטים, אפשר לעיין בקטע חשבונות בתשלום מראש לעומת חשבונות בתשלום לאחר השימוש.
- האם רוצים לחולץ נתונים ממונטיזציה מפורטים או תמציתיים למערכת ניהול החשבונות שלכם ולפורמט הנתונים הנדרש.
- כתובת אימייל מותאמת אישית לתשובה. להתראות באימייל בנושא מונטיזציה שנשלחות לחברות ולמפתחים, מוגדרת כברירת מחדל כתובת noreply@apigee.com. עליך לבקש שם וכתובת לתשובה בהתאמה אישית לארגון שלך.
צוות התצורה של Apigee מריץ סקריפט כדי לסנכרן את המונטיזציה עם הארגון שלך ועם כל המפתחים, האפליקציות ומוצרי ה-API שיצרת באמצעות Apigee Edge. יכול להיות שצוות התמיכה של Apigee יבקש מכם לסנכרן את הארגון שלכם בעתיד, כפי שמתואר במאמר סנכרון נתוני Apigee Edge עם מונטיזציה לפרטים נוספים. אין לסנכרן נתוני מונטיזציה, אלא אם קיבלתם הוראה מ-Apigee.
הגדרת מונטיזציה
הטבלה הבאה מסכמת את השלבים הנדרשים להגדרת מונטיזציה בארגון Apigee.שלב | תיאור |
---|---|
עריכת הפרופיל של הארגון | כחלק מההגדרה הראשונית של המונטיזציה, צוות ההגדרה של Apigee Edge מגדיר את הפרופיל של הארגון שלך.
כדי להוסיף או לעדכן מידע על הארגון, צריך לערוך את הפרופיל של הארגון. לדוגמה, יכול להיות שתצטרכו לעדכן את סוג החיוב, הגדרות המטבע או מודל המס. |
ניהול המטבעות הנתמכים | כחלק מההגדרה הראשונית של המונטיזציה, צוות ההגדרה של Apigee Edge מציין את המטבעות שהארגון שלך תומך בהם ומגדיר את מטבע ברירת המחדל.
אפשר לאחזר את המטבעות שהארגון שלך תומך בהם, ולהוסיף או למחוק מטבעות נתמכים (כדי לשקף את המטבעות שבהם משתמשים המפתח או תוכנית התמחור). הערה: כשמפעילים מונטיזציה, המערכת מבצעת באופן אוטומטי משימה יומית שבה מתקבל שער החליפין בדולר ארה"ב לכל מטבע נתמך. כברירת מחדל, המשימה פועלת בכל יום בשעה אחת אחרי חצות. פרטים נוספים זמינים במאמר תזמון משימות מונטיזציה. |
פירוט התנאים וההגבלות | לחלופין, אפשר להוסיף תנאים והגבלות לפרופיל של הארגון לפני הפרסום של תוכניות תעריפים. לאחר הפרסום של תוכנית תעריפים, הגרסה הנוכחית של התנאים וההגבלות מוצגת בפורטל המפתחים. הערה: התנאים וההגבלות מפורטים מחוץ לפרופיל של הארגון. בפרופיל הארגון, אתם מציינים את המיקום (כתובת ה-URL הציבורית) של התנאים וההגבלות. אפשר להוסיף כמה גרסאות של התנאים וההגבלות כדי לשקף את השינויים לאורך זמן. |
אכיפת מגבלות מונטיזציה | כדי לאכוף מגבלות מונטיזציה, צריך לצרף את המדיניות MonetizeLimitsCheck לספקי proxy של API. באופן ספציפי, המדיניות מופעלת בתנאים הבאים:
|
הגדרת התראות | ניתן להגדיר התראות כדי להודיע למפתחים או לספקי API לגבי אירוע ספציפי, כמו תוכנית תעריפים חדשה שפורסמה. |
ייצור הכנסות מממשקי ה-API
כאשר אתם מייצרים הכנסות מממשקי API, אתם מקבצים מוצר אחד או יותר של API בחבילת מוצרים של API ומגדירים את תוכנית התעריפים המשויכת.
חבילת מוצרים של API לא תהיה גלויה למפתחים עד שיפרסמו תוכנית תעריפים לחבילה (עם תאריך ההתחלה של התאריך הנוכחי או תאריך עתידי). מפתחים יכולים לרשום את האפליקציות שלהם לשימוש בחבילת מוצרים של API רק על ידי רכישה של אחת מתוכניות התעריפים שבתוקף כרגע. אם חבילת מוצרים ב-API לא פרסמה תוכנית תעריפים שנמצאת כרגע בתוקף, לא ניתן לייצר הכנסות מהחבילה.
בטבלה הבאה מופיע סיכום של השלבים הדרושים למונטיזציה של ממשקי ה-API.
שלב | תיאור |
---|---|
ניהול חבילות מוצרים ל-API | יצירת חבילות מוצרים של API כדי לקבץ את מוצרי ה-API. הערה: בממשק המשתמש הקלאסי של Edge וב-API למונטיזציה, חבילות מוצרים נקראות 'חבילות API'. כדי להשתמש ב-API לניהול חבילות מוצרים של API, אפשר לעיין במאמרים הבאים: |
הגדרת המדיניות בנושא תיעוד עסקאות | מגדירים את המדיניות בנושא תיעוד עסקאות לכל אחד ממוצרי ה-API. המדיניות בנושא תיעוד עסקאות מגדירה מה רוצים לתעד ברשומות של העסקאות במוצר API, כולל מאפיינים מותאמים אישית. איך משתמשים ב-API להגדרת מדיניות תיעוד עסקאות? |
ניהול ופרסום של תוכניות תעריפים | מומלץ ליצור תוכנית תעריפים כדי להגדיר את גישת המונטיזציה לממשקי ה-API. לדוגמה, אם אתם גובים תעריף קבוע או משתנה עבור השימוש ב-API. כדי לנהל תוכניות מחירים באמצעות ה-API: |
רכישת תוכנית תעריפים שפורסמה | לרכוש תוכנית תעריפים שפורסמה, עם API, אם רוצים, פג תוקף או לבטל תוכנית תעריפים שנרכשה. |
הגדרת מונטיזציה בפורטל המפתחים | אפשר להגדיר את המונטיזציה בפורטל המפתחים כדי לספק למפתחים גישה בשירות עצמי ליצירת דירוג של מינוי לתוכנית, לעיבוד וחיוב אוטומטי של תשלומים, לדוחות, לקטלוגים של מוצרים ולהגדרות נוספות שספציפיות למונטיזציה. |
ניהול מונטיזציה
אחרי שמגדירים את המונטיזציה ומייצרים הכנסות מ-API, אפשר לבצע את אחד או יותר מהשלבים המסוכמים בטבלה הבאה:
שלב | תיאור |
---|---|
ניהול חברות ומפתחים | ניהול החברות והמפתחים שמשתמשים בממשקי ה-API שלך. מפתח הוא ישות אחת, שמזוהה באופן ייחודי באמצעות כתובת האימייל. חברה היא אוסף של מפתחים שמנוהלים כישות אחת. |
יצירת דוחות | יצירת דוחות על יתרה בתשלום מראש, הכנסות ודוחות משתנים. מפתחים ששולמו מראש יכולים להתאים דוחות יתרה ששולמה מראש באמצעות הפקדות בבנק. |
ביצוע התאמות חיוב | מומלץ לבצע התאמות בחיוב כדי לתקן פערים בנתונים, לדוגמה. |
הנפקת זיכויים | אם צריך, מנפיקים קרדיטים למפתחים. אצל מפתח בתשלום מראש, הזיכוי מופיע כירידה בשימוש שמגדילות את יתרת התשלום מראש של המפתח מעתה ואילך. למפתחים שמשלמים לאחר השימוש (postpay), הזיכוי מופיע בתור שורה נפרדת בחשבונית, ומפחית את החיוב בחשבונית. |
ניהול היתרות בתשלום מראש בחשבון | הצגת היתרה הקיימת בחשבון משולם מראש וטעינה מחדש של חשבונות ששולמו מראש או על ידי הגדרת טעינה מחדש אוטומטית באמצעות ספק תשלום של צד שלישי. |
ניהול יתרות התשלום לאחר השימוש באמצעות מסגרות אשראי | כשמוסיפים מטבע נתמך לארגון, אפשר להגדיר מסגרת אשראי למפתח ששולם לאחר השימוש. מסגרת האשראי חלה על כל המפתחים בארגון שמשלמים לאחר השימוש (postpay). בנוסף, אפשר להגדיר מסגרת אשראי למפתח ספציפי שמשלמים לאחר השימוש. במקרה כזה, מסגרת האשראי מבטלת כל תקרה שהוגדרה למטבע עבור המפתח שצוין בלבד. |
פרסום החזרים כספיים | לפרסם החזרים כספיים למפתחים עבור עסקאות רכישה. |
תזמון משימות מונטיזציה | המונטיזציה מספקת מתזמן משימות וקבוצה של משימות שמתוזמנות מראש להפעלה בשעות שצוינו. ניהול לוח הזמנים של משימת המונטיזציה באמצעות ה-API. |
הצגת הסטטוס של עסקאות | הצגת הסטטוס של עסקאות שהתרחשו בטווח זמן מסוים באמצעות ה-API. |
סנכרון של נתוני Apigee עם מונטיזציה | אם התבקשת לעשות זאת על ידי Apigee, סנכרן מחדש את הנתונים עם המונטיזציה כדי להבטיח שהנתונים מסונכרנים. ניתן לסנכרן את: הארגון, מוצרי ה-API, המפתחים והאפליקציות. |
מחיקת נתוני מונטיזציה מהארגון | כדאי למחוק את נתוני המונטיזציה מהארגון כדי לפנות ארגון לבדיקה או למחוק ארגון. |