תודה על המשוב.
משוב?דוחות חיוב
שותפים יכולים להשתמש בממשקי ה-API הבאים לחיוב סיטונאי כדי ליצור דוחות חיוב שיעזרו להם לאמת את דיוק השימוש וההקצאה. ממשקי ה-API לחיוב סיטונאי נגישים דרך developer.webex.com.
-
התאמה - מציג את צריכת השימוש ברמת כל שותף, כל לקוח או כל משתמש. שותפים יכולים להשתמש במידע זה של דוח חיוב מותאם אישית כדי להתאים את החשבונית החודשית שלהם, כך שיוכלו לחייב את הלקוחות והמשתמשים שלהם בהתאם לצריכת השימוש שלהם.
-
נקודת זמן - מציג את הקצאות החבילות הנוכחיות ברמת לקוח או משתמש. דוח נקודת הזמן מספק ספירה בזמן אמת של הקצאות חבילות. שותפים יכולים להשתמש במידע זה כדי לאמת את דיוק ההקצאה ולהבטיח התאמה להזמנות הלקוחות.
שותפים יכולים גם ליצור דוחות חיוב מותאמים אישית עבור שותפי משנה באמצעות הפרמטר subPartnerOrgId.
ישנם ארבעה ממשקי API הזמינים למנהלי שותפים העומדים בדרישות הגישה המינימליות.
|
ממשק API לחיוב |
מטרת ה-API |
דרישת גישת מנהל שותף |
|---|---|---|
|
צור דוח חיוב סיטונאי |
משמש להפקת דוח חיוב. |
Read/write |
|
קבל דוח חיוב סיטונאי |
משמש לקבלת דוח חיוב שנוצר להורדה. |
קרא |
|
רשימת דוחות חיוב סיטונאיים |
משמש לרישום דוחות החיוב הקיימים עבור שותף זה. |
קרא |
|
מחיקת דוח חיוב סיטונאי |
משמש למחיקת דוח חיוב קיים. |
Read/write |
מקור נתונים
הנתונים עבור דוחות החיוב נמשכים מהקצאות חבילות ונתוני שימוש ש-Webex עוקב אחריהם עבור כל שותף. Webex אוסף את נתוני חבילת הלקוחות והמשתמשים מדי יום כדי ליצור את החשבונית החודשית של השותף. ממשקי API לחיוב משתמשים בנתונים אלה, ומאפשרים למנהלי שותפים ליצור דוחות מותאמים אישית. דוחות אלה עוזרים לשותפים ליישב את צריכת השימוש מהחשבונית החודשית שלהם ברמת השותף, הלקוח והמשתמש.
למידע מפורט יותר על אופן שליחת חשבוניות של Webex לשותפים, ראו חיוב ספקי שירות.
צור דוח חיוב סיטונאי
| 1 |
מאתר developer.webex.com, עבור אל צור API של דוח חיוב סיטונאי. |
| 2 |
בחר אחת מקטגוריות הדוחות הבאות:
אם ברצונך ליצור דוח התאמה, אין צורך לשנות דבר מכיוון שהתאמה נבחרה כברירת מחדל, כך שתוכל להמשיך לשלב הבא. אם ברצונך ליצור דוח נקודת זמן, שנה את הבחירה לנקודת זמן. |
| 3 |
הזן את billingStartDate ואת billingEndDate בפורמט שמציין ה-API. ניתן להזין כל תאריך מחמש השנים האחרונות, אך לא את היום הנוכחי. עבור הדוח נקודת זמן, השדות billingStartDate ו- billingEndDate אינם חובה ויש להתעלם מהם אם יוזנו. הדוח תמיד משקף את הקצאות החבילות הנוכחיות. |
| 4 |
הזן את סוג הדוח :
|
| 5 |
בשדה כלול, הזן את העמודות הנוספות או האופציונליות שברצונך לראות בדוחות. לכל סוג דוח יש קבוצה של מאפיינים חובה וקבוצה של מאפיינים אופציונליים. באפשרותך להחליט אילו מהמאפיינים האופציונליים להציג עבור כל דוח. אם לא תכלול את המאפיינים האופציונליים, הדוח יציג רק את המאפיינים החובה. העמודות הבאות הן המאפיינים האופציונליים שתוכלו לבקש לכלול בדוח הלקוח והמשתמש:
עליך לכלול את מזהה קבוצת הלקוח__ואת שם קבוצת הלקוח__יחד אם ברצונך לראות מאפיינים אלה בדוח שלך. בעת בחירת עמודות אופציונליות, סדר העמודות בדוחות התאמת הלקוח והמשתמש משתנה. על שותפים לעדכן את שילוב ה-API שלהם כדי לקבל את פורמט ה-CSV החדש. סדר העמודות של דוחות נקודת זמן נותר ללא שינוי. נכון לעכשיו, להגדרות התכונות הקיימות יש עדיפות על פני הפרמטר Include בעת קביעת סדר העמודות. לדוגמה, אם הגדרת תכונה מסוימת מופעלת עבור לקוח, עמודת התכונה תופיע לפי תבנית הדוח הישנה גם אם תוסיף אותה בפרמטר Include. נסיר את ההגדרות הללו בקרוב. לאחר הסרתן, ניתן לבקש את העמודות האופציונליות רק דרך הפרמטר Include. |
| 6 |
לחץ על הפעל כדי ליצור את הדוח. |
| 7 |
העתק את מזהה הדוח מפלט ה-API. ניתן להשתמש בערך זה באמצעות Get API כדי לקבל את דוח החיוב שנוצר. |
מה הלאה?
עבור אל קבל דוח חיוב סיטונאי כדי להוריד עותק של הדוח.
קבל דוח חיוב סיטונאי
לאחר יצירת דוח חיוב, השתמשו בממשק API זה כדי לקבל דוח חיוב ספציפי. הדוח מופץ לכתובת URL שבה הוא זמין להורדה למשך 30 דקות לאחר השלמת בקשת ה-GET.
| 1 |
מאתר developer.webex.com, עבור אל קבל ממשק API של דוח חיוב סיטונאי. |
| 2 |
הזן את הערך הייחודי id עבור הדוח ולחץ על הפעל. פלט ה-API מדווח על סטטוס. הפלט כולל את הפרמטר tempDownloadURL, המספק כתובת URL שממנה ניתן להוריד את הדוח. |
| 3 |
העתיקו את ה- tempDownloadURL לדפדפן כדי לגשת לדוח ולהוריד אותו. |
רשימת דוחות חיוב סיטונאיים
השתמש ב-API זה כדי לקבל רשימה של דוחות חיוב שנוצרו עבור ארגון השותף. ניתן לפרט את כל הדוחות הקיימים, או להגביל את הרשימה לדוחות שעומדים בפרמטרים שצוינו, כגון תקופת החיוב וסוג החיוב (שותף, לקוח, משתמש).
אם תזין פרמטרים אופציונליים, ה-API יחזיר רק את הדוחות שתואמים בדיוק לפרמטרים שציינת. לדוגמה, אם תציין תקופת חיוב, יוחזרו רק דוחות המשתמשים בתקופת חיוב ספציפית זו. דוחות שנופלים בתוך התקופה, אך אינם תואמים במדויק לתאריכים, לא יוחזרו.
| 1 |
מאתר developer.webex.com, עבור אל רשימת דוחות חיוב סיטונאי API. |
| 2 |
תחת פרמטרי שאילתה, הזן את כל פרמטרי החיפוש שברצונך להשתמש בהם (לדוגמה, startDate, endDate, Type, sortBy on). |
| 3 |
לחץ על הפעלה. ממשק ה-API מפיק את רשימת הדוחות יחד עם המזהה הייחודי של הדוח והסטטוס (הושלם, בתהליך_).
|
מה הלאה?
רשום את ה- id עבור כל דוח שברצונך להוריד. עבור אל קבל דוח חיוב סיטונאי כדי להוריד את הדוח.
מחיקת דוח חיוב סיטונאי
השתמש בהליך זה כדי למחוק דוח חיוב שנוצר על סמך מזהה דוח. כמה דוגמאות שבהן ייתכן שתרצה למחוק דוח כוללות:
-
אם ברצונך ליצור מחדש דוח חיוב התאמה קיים, עליך תחילה למחוק את הדוח הקיים. לאחר מחיקת הדוח הקיים, ניתן ליצור דוח חדש עבור תקופה זו. לא ניתן למחוק דוח אם יצירתו נכשלה או עדיין בתהליך.
עבור דוח נקודת זמן, אין צורך למחוק דוח קיים, מכיוון שהמערכת אינה יוצרת מחדש דוחות אלה. כל דוח תמיד משקף נתונים נכון לחותמת הזמן הנוכחית.
-
אם תשלחו כתובת URL של דוח שנוצרה לאדם הלא נכון, תוכלו למחוק את הדוח כדי שלא יוכלו לגשת אליו.
| 1 |
מאתר developer.webex.com, עבור אל מחיקת ממשק API של דוח חיוב סיטונאי. |
| 2 |
הזן את מזהה הדוח ולחץ על הפעל. |
שדות דוח חיוב
דוחות חיוב מכילים את השדות הבאים:
|
שדה |
תיאור |
סוג דוח נתמך |
קטגוריית דוחות נתמכת |
מאפיין חובה או אופציונלי |
|---|---|---|---|---|
|
שם השותף_ |
שם השותף |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מזהה ארגון_של שותף_ |
מזהה שותף ייחודי |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מזהה מנוי_ |
מזהה מנוי ייחודי |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מזהה קבוצת לקוח__ | המזהה הייחודי של הקבוצה שאליה שייך הלקוח. אם הלקוח מועבר בין קבוצות במהלך תקופת החיוב, השימוש מתחלק בהתאם לקבוצות אליהן השתייך הלקוח במהלך אותה תקופה. |
לקוח, משתמש |
התאמה, נקודת זמן |
אופציונלי |
|
שם קבוצת לקוח__ | שם התצוגה של קבוצת הלקוחות. אם שם הקבוצה השתנה במהלך תקופת החיוב, ייעשה שימוש בשם העדכני ביותר. |
לקוח, משתמש |
התאמה, נקודת זמן |
אופציונלי |
|
מזהה לקוח_ארגון_ |
מזהה ייחודי פנימי של הלקוח |
לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מזהה חיצוני של לקוח__ |
מזהה ייחודי של לקוח כפי שסופק על ידי שותף |
לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
סוּג |
סוג משתמש או סביבת עבודה |
לקוח, משתמש |
נקודת זמן |
חובה |
|
מזהה מנוי_ |
מזהה ייחודי עבור המנוי |
מִשׁתַמֵשׁ |
התאמה, נקודת זמן |
חובה |
|
מזהה משתמש_ |
מזהה המשתמש של Webex של המנוי |
מִשׁתַמֵשׁ |
התאמה, נקודת זמן |
חובה |
|
מזהה סביבת עבודה_ |
מזהה ייחודי של סביבת עבודה |
מִשׁתַמֵשׁ |
התאמה, נקודת זמן |
חובה |
|
שם השירות_ |
שם השירות (לדוגמה, שיחות אזור משותף__, שיחות WEBEX_, סוויטת WEBEX_, פגישות WEBEX_) |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מק"ט |
סקו עבור השירות |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
תֵאוּר |
תיאור השירות |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
תאריך התחלה של צריכה__ |
תחילת צריכת השירות. יחד עם השדה הבא, ערך זה מגדיר את תקופת השימוש. |
שותף, לקוח, משתמש |
התאמה |
חובה |
|
תאריך סיום צריכה__ |
סוף צריכת השירות. יחד עם השדה הקודם, ערך זה מגדיר את תקופת צריכת השימוש. |
שותף, לקוח, משתמש |
התאמה |
חובה |
|
תאריך דיווח_ |
התאריך והשעה שבהם הדוח נוצר. |
לקוח, משתמש |
נקודת זמן |
חובה |
|
כַּמוּת |
מייצג את צריכת השימוש המצטברת של משתמשים לכל שותף, לכל לקוח או לכל משתמש (בהתאם לדוח ולרמה שבה אתה צופה בנתונים). תַחשִׁיב: המערכת מחשבת את הכמות היומית עבור כל משתמש באופן יחסי עבור אותו יום. שימוש למשך יום שלם = 1 שימוש למשך חצי יום = 0.5 לאחר מכן, הוא מסכם את הסכומים היומיים עבור כל הימים בתקופת החיוב כדי לחשב את הכמות הכוללת עבור משתמש זה בתקופת חיוב זו. עבור דוחות ברמת הלקוח והשותף, הסכומים עבור כל המשתמשים מצורפים כדי לספק כמות כוללת עבור אותו לקוח או שותף. נקודת זמן: דוח הלקוח מפרט הקצאות חבילות לכל לקוח. כל שורה מייצגת את הכמות הכוללת של חבילה ספציפית שהוקצתה למשתמשים או לסביבות עבודה בתוך ארגון לקוח מסוים. הכמות מציגה "0" אם לא הוקצו חבילות. דוח המשתמש מפרט את החבילות שהוקצו למשתמשים או לסביבות עבודה. כל שורה מציגה כמות של 1, המייצגת משתמש או סביבת עבודה ואת החבילה או התוסף האישיים שלו. אם מוקצות מספר חבילות או תוספים למשתמש או לסביבת עבודה, הדוח מציג מספר ערכים, כל אחד עם כמות של 1. |
שותף, לקוח, משתמש |
התאמה, נקודת זמן |
חובה |
|
מזהה מיקום_ |
מזהה מיקום ייחודי |
לקוח, משתמש |
התאמה, נקודת זמן דוח נקודת הזמן של הלקוח אינו כולל מזהה מיקום |
אופציונלי |
|
מזהה רישיון_ |
מזהה רישיון שדה זה גלוי רק עבור חבילות סיטונאיות עבור דוח התאמה, המזהה License_ריק עבור רישיונות שהוקצו לפני הכנסת שדה זה. דוח החיוב מציג שורות מרובות עבור אותה חבילה סיטונאית אם היא משויכת לשילובים שונים של מזהה מיקום_ומזהה רישיון_. |
לקוח, משתמש |
התאמה, נקודת זמן |
אופציונלי |
בחירת עמודות אופציונליות משנה את סדר העמודות של דוחות התאמת לקוחות ומשתמשים. הסדר הבא חל על שותפים עם מספרי אחסון סיטונאיים בלבד במנוי שלהם:
דוח ברמת משתמש - שם שותף_, מזהה ארגון__, מזהה מנוי_, מזהה קבוצת לקוח__, שם קבוצת לקוח_, מזהה ארגון_, מזהה לקוח__, מזהה חיצוני_, מזהה מיקום__, מזהה רישיון_, מזהה מנוי_, מזהה משתמש_, מזהה סביבת עבודה_], שם שירות_, מק"ט, תיאור, תאריך התחלה__, תאריך סיום__, כמות
דוח ברמת לקוח - שם_שותף , מזהה ארגון_של שותף_, מזהה_מנוי , מזהה קבוצת לקוח_, שם קבוצת_לקוח_, מזהה ארגון_של לקוח, מזהה לקוח_חיצוני_,_מזהה מיקום, מזהה רישיון_, שם שירות_, מק"ט, תיאור_,_תאריך התחלה של_צריכה , תאריך סיום_של_צריכה ,_כמות
הקצאת חבילה למשתמש מפעילה חיוב של Webex Wholesale, בעוד שהסרת הקצאת החבילה עוצרת אותו.
ארגון לקוחות יכול להשתייך לקבוצת לקוחות אחת בלבד בכל זמן נתון. תמיכה בקבוצות לקוחות מרובות לכל ארגון אינה זמינה כעת.
