תודה על המשוב.
משוב?דוחות חיוב
שותפים יכולים להשתמש בממשקי API הבאים לחיוב סיטונאי כדי ליצור דוחות חיוב שיעזרו להם לאמת את דיוק השימוש וההקצאה. ממשקי ה- API לחיוב סיטונ אי נגישים דרך developer.webex.com.
-
התאמה — מציג את צריכת השימוש ברמת שותף, לקוח או למשתמש. שותפים יכולים להשתמש ב מידע זה של דוח חיוב מותאם אישית כדי להתאים את החשבונית החודשית שלהם, כך שיוכלו לחייב את הלקוחות והמשתמשים שלהם בהתאם לצריכת השימוש שלהם.
-
נקודת זמן — מציג את הקצאות החבילות הנוכחיות ברמת לקוח או למשתמש. הדוח "נקודת זמן" מספק ספירה בזמן אמת של הקצאות ח בילות. שותפים יכולים להשתמש במידע זה כדי לאמת את דיוק ההקצאה ולהבטיח התאמה עם הזמנות הלקוח.
שותפים יכולים גם ליצור דוחות חיוב מותאמים אישית עבור שותפי משנה באמצעות הפרמטר SubpartnerOrgID.
ישנם ארבעה ממשקי API הזמינים למנהלי מערכת שותפים העומדים בדרישות הגישה המינימליות.
|
ממשק API לחיוב |
מטרת ה- API |
דרישת גישה למנהל השותפים |
|---|---|---|
|
יצירת דוח חיוב סיטונאי |
משמש ליצירת דוח חיוב. |
קריאה/כתיבה |
|
קבל דוח חיוב סיטונאי |
משמש לקבלת דוח חיוב שנוצר להורדה. |
קרא |
|
רשימת דוחות חיוב סיטונאיים |
משמש לרשימת דוחות החיוב הקיימים עבור אותו שותף. |
קרא |
|
מחיקת דוח חיוב סיטונאי |
משמש למחיקת דוח חיוב קיים. |
קריאה/כתיבה |
מקור נתונים
הנתונים עבור דוחות החיוב נשלפים מהקצאות חבילות ונתוני שימוש ש- Webex עוקב אחר עבור כל שותף. Webex צובר מדי יום את נתוני חבילת הלקוח והמשתמש כדי ליצור את החשבונית החודשית של השותף. ממשקי API לחיוב משתמשים בנתונים אלה ומ אפשרים למנהלי השותפים ליצור דוחות מותאמים אישית. דוחות אלה עוזרים לשותפים ליישב את צריכת השימוש מהחשבונית החודשית שלהם ברמת השותף, הלקוח ו המשתמש.
לקבלת מידע מפורט יותר על האופן שבו חשבוניות Webex משתפות פעולה, ראה חיוב ספק השירות.
יצירת דוח חיוב סיטונאי
| 1 |
מתוך developer.webex.com, עבור אל יצירת ממשק API של דוח חיוב סיטונ אי. |
| 2 |
בחר אחת מקטגוריות הדוחות הבאות:
אם ברצונך ליצור דוח פיוס, אין צורך לשנות דבר מכיוון שהתאמה נבחרה כברירת מחדל, כך שתוכל להמשיך לשלב הבא. אם ברצונך ליצור דוח נקודה בזמן, שנה את הבחירה לנקודת זמן. |
| 3 |
הזן את BillingStartDate ו- BillingEndDate בפורמט שמציין ה- API. אתה יכול להכניס כל תאריך מחמש השנים האחרונות, אך לא את היום הנוכחי. עבור דוח נקודה בזמן, השדות BillingStartDate ו- Billing EndDate אינם נדרשים ומתע למים מהם אם הם מוזנים. הדו"ח משקף תמיד את הקצאות החבילות הנוכחיות. |
| 4 |
הזן את סוג הדוח:
|
| 5 |
בשדה כ לול, הזן את העמודות הנוספות או האופציונליות שברצונך לראות בדוחות. לכל סוג דוח יש קבוצה של תכונות חובה וקבוצה של תכונות אופציונליות. באפשרותך להחליט אילו מהתכונות האופציונליות להציג עבור כל דוח. אם לא תכלול את התכונות האופציונליות, הדוח מציג רק את התכונות המחייבות. העמודות הבאות הן התכונות האופציונליות שבאפשרותך לבקש לכלול בדוח הלקוח והמשתמש:
עליך לכלול CUSTOMER_GROUP_ID CUSTOMER_GROUP_NAME יחד אם ברצונך לראות תכונות אלה בדוח שלך. בעת בחירת עמודות אופציונליות, סדר העמודות בדוחות התאמת לקוחות ומשתמשים משתנה. על השותפים לעדכן את שילוב ה- API שלהם כדי לקבל את פורמט csv החדש. סדר העמודות של דוחות נקודת זמן נשאר ללא שינוי. נכון לעכשיו, הגדרות התכונה הקיימות מחזיקות עדיפות על פני הפרמטר Include בעת קביעת סדר העמודות. לדוגמה, אם הגדרת תכונה מסוימת מופעלת עבור לקוח, עמודת תכונה זו תופיע בהתאם לתבנית הדוח הישנה גם אם תוסיף אותן בפרמטר כלול. אנו נסיר את ההגדרות האלה בקרוב. לאחר הסרתם, באפשרותך לבקש את העמודות האופציונליות רק באמצעות הפרמטר כלול. |
| 6 |
לחץ על הפ על כדי ליצור את הדוח. |
| 7 |
העתק את מז הה הדוח מפלט ה- API. באפשרותך להשתמש בערך זה עם Get API כדי לקבל את דוח החיוב שנוצר. |
מה לעשות הלאה
עבור למקטע קבל דוח חיוב סיטונ אי כדי להוריד עותק של הדו ח.
קבל דוח חיוב סיטונאי
לאחר יצירת דוח חיוב, השתמש בממשק API זה כדי לקבל דוח חיוב ספציפי. הדוח מקבל פלט לכתובת URL שבה הוא זמין להורדה למשך 30 דקות לאחר השלמת בקשת GET.
| 1 |
מ- developer.webex.com, עבור אל קבל ממשק API של דוח חיוב סי טונאי. |
| 2 |
הזן את ערך המזהה הייחודי עבור הדוח ולחץ על הפ על. פלטי ה- API מדווחים על מצב. הפלט כולל את הפרמטר TempDownloadURL, המספק כתובת אתר שמ מנה ניתן להוריד את הדוח. |
| 3 |
העתק את ה - TempDownloadURL לדפדפן כדי לגשת לדוח ולה וריד אותו. |
רשימת דוחות חיוב סיטונאיים
השתמש בממשק API זה כדי לקבל רשימה של דוחות חיוב שנוצרו עבור הארגון השותף. באפשרותך לרשום את כל הדוחות הקיימים, או להגביל את הרשימה לדוחות העומדים בפרמטרים שצוינו, כגון תקופת החיוב וסוג החיוב שלך (שותף, לקוח, משתמש).
אם אתה מזן פרמטרים אופציונליים, ה- API מחזיר רק את הדוחות הת ואמים בדיוק לפרמטרים שציינת. לדוגמה, אם תציין תקופת חיוב, יוחזרו רק דוחות המשתמשים בתקופת חיוב ספציפית זו. דוחות שנמצאים בתוך התקופה, אך אינם תואמים בדיוק את התאריכים אינם מו חזרים.
| 1 |
מתוך developer.webex.com, עבור אל רשימת ממשק API של דוח חיוב סיטונאי. |
| 2 |
תחת פרמטרי שאילתה, הזן את כל פר מטרי החיפוש שבהם ברצונך להשתמש (לדוגמה, התאריך התחלתו, תאריך סיום, סוג, SortBy). |
| 3 |
לחץ על הפ על. ה- API מוציא את רשימת הדוחות יחד עם מזהה הדוח הייחו די וה סטטוס (COMPLETED,IN_PROGRESS).
|
מה לעשות הלאה
רשום את המז הה עבור כל הדוחות שברצונך להוריד. עבור אל קבל דוח חיוב סיטונאי כדי להוריד את הדוח.
מחיקת דוח חיוב סיטונאי
השתמש בהליך זה כדי למחוק דוח חיוב שנוצר בהתבסס על מזהה דוח. כמה דוגמאות שבהן ייתכן שתרצה למחוק דוח כוללות:
-
אם ברצונך ליצור מחדש דוח חיוב קיים של התאמה, עליך למחוק תחילה את הדוח הקיים. לאחר מחיקת הדוח הקיים, באפשרותך ליצור דוח חדש לתקופה זו. לא ניתן למחוק דוח אם ייצור ו נכשל או שהוא עדיין בעיצומו.
עבור דוח נקודת זמן, אינך צריך למחוק דוח קיים, מכיוון שהמערכת אינה מחדשת דוחות אלה. כל דוח משקף תמיד נתונים נכון לחותמת הזמן הנוכחית.
-
אם אתה שולח כתובת URL של דוח שנוצרה לאדם הלא נכון, תוכל למחוק את הדוח כדי שלא יוכל לגשת אליו.
| 1 |
מ- developer.webex.com, עבור אל מחיקת ממשק ה- API של דוח חיוב סיטונ אי. |
| 2 |
הזן את מז הה הדוח ולחץ על הפ על. |
שדות דוח חיוב
דוחות החיוב כוללים את השדות הבאים:
|
שדה |
תיאור |
סוג דוח נתמך |
קטגוריית דוחות נתמכת |
תכונה חובה או אופציונלית |
|---|---|---|---|---|
|
PARTNER_NAME |
שם השותף |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
PARTNER_ORG_ID |
מזהה שותף ייחודי |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
SUBSCRIPTION_ID |
מזהה מנוי ייחודי |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
CUSTOMER_GROUP_ID | המזהה הייחודי של הקבוצה שאליה שייך הלקוח. אם הלקוח מועבר בין קבוצות במהלך תקופת החיוב, השימוש מחולק על סמך הקבוצות שאליהן השתייך הלקוח במהלך אותה תקופה. |
CUSTOMER, USER |
פיוס, נקודה בזמן |
אופציונלי |
|
CUSTOMER_GROUP_NAME | שם תצוגה של קבוצת הלקוחות. אם שם הקבוצה השתנה במהלך תקופת החיוב, נעשה שימוש בשם האחרון. |
CUSTOMER, USER |
פיוס, נקודה בזמן |
אופציונלי |
|
CUSTOMER_ORG_ID |
מזהה ייחודי לקוח פנימי |
CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
CUSTOMER_EXTERNAL_ID |
מזהה ייחודי של לקוח כפי שסופק על ידי שותף |
CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
TYPE |
סוג משתמש או סביבת עבודה |
CUSTOMER, USER |
נקודה בזמן |
חובה |
|
SUBSCRIBER_ID |
מזהה ייחודי עבור המנוי |
USER |
פיוס, נקודה בזמן |
חובה |
|
USER_ID |
מזהה המשתמש Webex של המנוי |
USER |
פיוס, נקודה בזמן |
חובה |
|
WORKSPACE_ID |
מזהה סביבת עבודה ייחודי |
USER |
פיוס, נקודה בזמן |
חובה |
|
SERVICE_NAME |
שם השירות (למשל,COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
SKU |
Sku עבור השירות |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
DESCRIPTION |
תיאור השירות |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
CONSUMPTION_START_DATE |
תחילת צריכת השירות. יחד עם השדה הבא, ערך זה מגדיר את תקופת השימוש. |
PARTNER, CUSTOMER, USER |
פיוס |
חובה |
|
CONSUMPTION_END_DATE |
סוף צריכת השירות. יחד עם השדה הקודם, ערך זה מגדיר את תקופת צריכת השימוש. |
PARTNER, CUSTOMER, USER |
פיוס |
חובה |
|
REPORT_DATE |
התאריך והשעה שבהם הדוח נוצר. |
CUSTOMER, USER |
נקודה בזמן |
חובה |
|
QUANTITY |
מייצג את צריכת השימוש המצטברת של המשתמש לכל שותף, ללקוח או למשתמש (בהתאם לדוח ולרמה שבה אתה מציג את הנתונים). חישוב: המערכת מחשבת את הכמות ליום עבור כל משתמש על בסיס יחסי עבור אותו יום. שימוש ליום שלם = 1 שימוש במשך חצי יום = 0.5 לאחר מכן, הוא מסכם את הסיכומים ליום עבור כל הימים בתקופת החיוב כדי לחשב את הכמות הכוללת עבור אותו משתמש בתקופת חיוב זו. עבור דוחות ברמת הלקוח והשותף, הסיכומים של כל המשתמשים מצטברים כדי לספק כמות כוללת עבור אותו לקוח או שותף. נקודת זמן: דוח הלקוח מפרט הקצאות חבילות ללקוח. כל שורה מייצגת את הכמות הכוללת של חבילה ספציפית שהוקצתה למשתמשים או לסביבות עבודה בארגון לקוח מסוים. הכמות מציגה "0" אם אין חבילות שהוקצו. דוח המשתמש מפרט את החבילות שהוקצו למשתמשים או לסביבות עבודה. כל שורה מציגה כמות של 1, המייצגת משתמש או סביבת עבודה ואת החבילה או התוסף האישי שלהם. אם מספר חבילות או תוספות מוקצות למשתמש או לסביבת עבודה, הדוח מציג מספר ערכים, כל אחד עם כמות של 1. |
PARTNER, CUSTOMER, USER |
פיוס, נקודה בזמן |
חובה |
|
LOCATION_ID |
מזהה מיקום ייחודי |
CUSTOMER, USER |
פיוס, נקודה בזמן דוח נקודת זמן הלקוח אינו כולל מזהה מיקום |
אופציונלי |
|
LICENSE_ID |
מזהה רישיון שדה זה גלוי רק עבור חבילות סיטונאיות עבור דוח התאמה, הרי License_ID ק ריק עבור רישיונות שהוקצו לפני הכנסת שדה זה. דוח החיוב מציג שורות מרובות עבור אותה חבילה סיטונאית אם היא משויכת לשילובים שונים של LOCATION_ID וLICENSE_ID. |
CUSTOMER, USER |
פיוס, נקודה בזמן |
אופציונלי |
בחירת עמודות אופציונליות משנה את סדר העמודות של דוחות התאמת לקוחות ומשתמשים. ההזמנה הבאה חלה על שותפים עם SKU סיטונאי בלבד במנוי שלהם:
דוח ברמת המשתמש— PARTNER_NAMEPARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SUBSCRIBER_ID,USER_ID, WORKSPACE_IDSERVICE_NAME, מק"ט, תיאור,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, כמות
דוח ברמת PARTNER_NAME הלקוח—PARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID, LICENSE_IDSERVICE_NAME, מק"ט, תיאור,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, כמות
הקצאת חבילה למשתמש מפעילה חיוב Webex Wholesale, בעוד הסרת הקצאת החבילה מפסיקה אותו.
ארגון לקוחות יכול להשתייך לקבוצת לקוחות אחת בלבד בכל זמן נתון. תמיכה במספר קבוצות לקוחות בארגון אינה זמינה כרגע.
