Dziękujemy za opinię.
Opinia?Raporty rozliczeniowe
Partnerzy mogą korzystać z następujących interfejsów API rozliczeń hurtowych do generowania raportów rozliczeniowych , które pomagają im sprawdzać poprawność użytkowania i udostępniania. Interfejsy API rozliczeń hurtowych są dostępne za pośrednictwem developer.webex.com.
-
Zgodność — wyświetla zużycie zużycia na poziomie jednego partnera, klienta lub użytkownika. Partnerzy mogą korzystać z tych niestandardowych informacji o raportach rozliczeniowych, aby uzgodnić miesięczną fakturę, aby mogli rozliczać swoich klientów i użytkowników zgodnie z ich zużyciem.
-
Punkt w czasie — wyświetla bieżące alokacje pakietów na klienta lub na poziomie użytkownika. Raport Point-In-Time zapewnia liczbę alokacji pakietów w czasie rzeczywistym. Partnerzy mogą wykorzystać te informacje do weryfikacji dokładności udostępniania i zapewnienia zgodności z zamówieniami klientów.
Partnerzy mogą również generować niestandardowe raporty rozliczeniowe dla podpartnerów przy użyciu parametru SubPartnerOrgID.
Istnieją cztery interfejsy API, które są dostępne dla partnerów, którzy spełniają minimalne wymagania dostępu.
|
API rozliczeń |
Cel API |
Wymóg dostępu administratora partnera |
|---|---|---|
|
Tworzenie raportu rozliczeń hurtowych |
Służy do generowania raportu rozliczeniowego. |
Odczyt/zapis |
|
Uzyskaj raport rozliczeniowy hurtowy |
Służy do pobrania wygenerowanego raportu rozliczeniowego. |
Przeczytaj |
|
Lista hurtowych raportów rozliczeniowych |
Służy do wyświetlania raportów rozliczeniowych istniejących dla tego partnera. |
Przeczytaj |
|
Usuwanie raportu rozliczeń hurtowych |
Służy do usuwania istniejącego raportu rozliczeniowego. |
Odczyt/zapis |
Źródło danych
Dane dla raportów rozliczeniowych są pobierane z przypisań pakietów i danych dotyczących użytkowania, które Webex śledzi dla każdego partnera. Webex codziennie agreguje dane dotyczące pakietu klienta i użytkownika, aby wygenerować miesięczną fakturę partnera. Interfejsy API rozliczeń wykorzystują te dane, umożliwiając administratorom partnerów generowanie niestandardowych raportów. Raporty te pomagają partner om uzgodnić zużycie użytkowania z ich miesięczną fakturą na poziomie partnera, klienta i użytkownika.
Aby uzyskać bardziej szczegółowe informacje na temat sposobu, w jaki Webex fakturował partnerami, zobacz Rozliczenia przez dostawcę usług.
Tworzenie raportu rozliczeń hurtowych
| 1 |
Na stronie developer.webex.com przejdź do Utwórz interfejs API raportu rozliczeń hurtowych. |
| 2 |
Wybierz jedną z następujących kategorii raportów:
Jeśli chcesz wygenerować raport uzgadniania, nie ma potrzeby zmieniania czego kolwiek, ponieważ domyślnie wybrane jest Uzgodnienie, więc możesz przejść do następnego kroku. Jeśli chcesz wygenerować raport Punkt w czasie, zmień zaznaczenie na Punkt w czasie. |
| 3 |
Wprowadź billingStartDate i BillingEndDate w formacie określonym przez interfejs API. Możesz wprowadzić dowolną datę z ostatnich pięciu lat, ale nie bieżący dzień. W raporcie Punkt w czasie pola BillingStartDate i BillingEndDate nie są wymagane i są ignorowane, jeśli zostaną wprowadzone. Raport zawsze odzwierciedla bieżące przydziały pakietów. |
| 4 |
Wprowadź typ raportu:
|
| 5 |
W polu Do łącz wprowadź dodatkowe lub opcjonalne kolumny, które mają być wyświetlane w raportach. Każdy typ raportu ma zestaw atrybutów obowiązkowych i zestaw atrybutów opcjonalnych. Możesz zdecydować, który z opcjonalnych atrybutów będzie wyświetlany dla każdego raportu. Jeśli nie uwzględnisz atrybutów opcjonalnych, raport wyświetla tylko atrybuty obowiązkowe. Poniższe kolumny są opcjonalnymi atrybutami, które można poprosić o uwzględnienie w raporcie Klienta i Użytkownika:
Jeśli chcesz zobaczyć te atrybuty w raporcie, musisz uwzględnić CUSTOMER_GROUP_ID i CUSTOMER_GROUP_NAME razem. Po wybraniu kolumn opcjonalnych kolejność kolumn w raportach Uzgodniania klienta i użytkownika ulegnie zmianie. Partnerzy muszą zaktualizować swoją integrację API, aby zaakceptować nowy format csv. Kolejność kolumn raportów punkt-in-time pozostaje niezmieniona. Obecnie istniejące ustawienia elementu mają pierwszeństwo przed parametrem Uwzględnij podczas określania kolejności kolumn. Na przykład, jeśli określone ustawienie elementu jest włączone dla klienta, kolumna ta jest wyświetlana zgodnie ze starym formatem raportu, nawet jeśli zostanie dodana do parametru Uwzględnij. Niedługo usuniemy te ustawienia. Po ich usunięciu można żądać opcjonalnych kolumn tylko za pomocą parametru Uwzględnij. |
| 6 |
Kliknij przycisk Uruch om, aby wygenerować raport. |
| 7 |
Skopiuj identyfikator ra portu z wyjścia API. Możesz użyć tej wartości za pomocą interfejsu API Pobierz, aby uzyskać wygenerowany raport rozliczeniowy. |
Co robić dalej
Przejdź do sekcji Pobierz raport rozliczeniowy hur towy, aby pobrać kopię ra portu.
Uzyskaj raport rozliczeniowy hurtowy
Po wygenerowaniu raportu rozliczeniowego użyj tego interfejsu API, aby uzyskać określony raport rozliczeniowy. Raport zostanie wyświetlony na adres URL, w którym jest dostępny do pobrania przez 30 minut po zakończeniu żądania GET.
| 1 |
Na stronie developer.webex.com przejdź do Pobierz interfejs API raportu rozliczeń hurtowych. |
| 2 |
Wprowadź unikat ową wartość identyfik atora raportu i kliknij przycisk U ruchom. Interfejs API wyświetla stan raportu. Wyjście zawiera parametr tempDownload Url, który zapewnia adres URL, z którego można pobrać raport. |
| 3 |
Skopiuj TempDownloadURL do przeglądarki, aby uzyskać dostęp do raportu i pobrać go. |
Lista hurtowych raportów rozliczeniowych
Użyj tego interfejsu API, aby uzyskać listę wygenerowanych raportów rozliczeniowych dla organizacji partnerskiej. Możesz wyświetlić listę wszystkich istniejących raportów lub ograniczyć listę do tych raportów, które spełniają określone parametry, takie jak okres rozliczeniowy i typ rozliczenia (Partner, klient, użytkownik).
Jeśli wprowadzisz parametry opcjonalne, interfejs API zwraca tylko te raporty, które dokładnie odpowiadają określonym parametrom. Na przykład, jeśli określisz okres rozliczeniowy, zwracane są tylko raporty używające tego określonego okresu rozliczeniowego. Raporty, które mieszczą się w danym okresie, ale które nie pasują dokładnie do dat, nie są zwracane.
| 1 |
Z developer.webex.com przejdź do listy hurtowych raport ów rozliczeniowych API. |
| 2 |
W obszarze Parametry zapytania wprowadź dowolne parametry wyszukiwania, których chcesz użyć (na przykład StartDate, EndDate, Type, SortBy włączone). |
| 3 |
Kliknij przycisk Uruch om. Interfejs API wyświetla listę raportów wraz z unikalnym identyfik atorem raportu i stanem (COMPLETED,IN_PROGRESS).
|
Co robić dalej
Zapisz identyfikator wszystkich raportów, które chcesz pobrać. Przejdź do Pobierz raport rozliczeniowy hur towy, aby pobrać raport.
Usuwanie raportu rozliczeniowego hurtowego
Procedura ta służy do usunięcia wygenerowanego raportu rozliczeniowego na podstawie identyfikatora raportu. Kilka przykładów, w których możesz chcieć usunąć raport, to:
-
Jeśli chcesz zregenerować istniejący raport rozliczeniowy z uzgodnieniami, musisz najpierw usunąć istniejący raport. Po usunięciu istniejącego raportu można utworzyć nowy raport dla tego okresu. Nie można usunąć raportu, jeśli jego generowanie nie powiodło się lub nadal trwa.
W przypadku raportu „Punkt w czasie” nie trzeba usuwać istniejącego raportu, ponieważ system nie regeneruje tych raportów. Każdy raport zawsze odzwierciedla dane z bieżącego sygnatury czasowej.
-
Jeśli wyślesz wygenerowany adres URL raportu niewłaściwej osobie, możesz usunąć raport, aby nie miała dostępu do niego.
| 1 |
Na stronie developer.webex.com przejdź do Usuń interfejs API raportu rozliczeń hurtowych. |
| 2 |
Wprowadź identyfikator raportu i kliknij przycisk U ruchom. |
Pola raportu rozliczeniowego
Raporty rozliczeniowe zawierają następujące pola:
|
Pole |
Opis |
Obsługiwany typ raportu |
Obsługiwana kategoria raportów |
Atrybut obowiązkowy lub opcjonalny |
|---|---|---|---|---|
|
PARTNER_NAME |
Imię i nazwisko partnera |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
PARTNER_ORG_ID |
Unikalny identyfikator partnera |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
SUBSCRIPTION_ID |
Unikalny identyfikator subskrypcji |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
CUSTOMER_GROUP_ID | Unikalny identyfikator grupy, do której należy klient. Jeśli klient jest przenoszony między grupami w okresie rozliczeniowym, użycie jest podzielone na grupy, do których należał klient w tym okresie. |
CUSTOMER, USER |
Pojednanie, punkt w czasie |
Opcjonalnie |
|
CUSTOMER_GROUP_NAME | Wyświetlana nazwa grupy klientów. Jeśli nazwa grupy zmieniła się w okresie rozliczeniowym, używana jest najnowsza nazwa. |
CUSTOMER, USER |
Pojednanie, punkt w czasie |
Opcjonalnie |
|
CUSTOMER_ORG_ID |
Wewnętrzny niepowtarzalny identyfikator klienta |
CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
CUSTOMER_EXTERNAL_ID |
Niepowtarzalny identyfikator klienta podany przez partnera |
CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
TYPE |
Typ użytkownika lub obszaru roboczego |
CUSTOMER, USER |
Punkt w czasie |
Obowiązkowe |
|
SUBSCRIBER_ID |
Unikalny identyfikator abonenta |
USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
USER_ID |
Identyfikator użytkownika Webex subskrybenta |
USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
WORKSPACE_ID |
Unikalny identyfikator obszaru roboczego |
USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
SERVICE_NAME |
Nazwa usługi (np.COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
SKU |
SKU dla usługi |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
DESCRIPTION |
Opis usługi |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
CONSUMPTION_START_DATE |
Rozpoczęcie zużycia usługi. Wraz z poniższym polem ta wartość określa okres użytkowania. |
PARTNER, CUSTOMER, USER |
Pojednanie |
Obowiązkowe |
|
CONSUMPTION_END_DATE |
Koniec zużycia usługi. Wraz z poprzednim polem ta wartość określa okres użytkowania. |
PARTNER, CUSTOMER, USER |
Pojednanie |
Obowiązkowe |
|
REPORT_DATE |
Data i godzina generowania raportu. |
CUSTOMER, USER |
Punkt w czasie |
Obowiązkowe |
|
QUANTITY |
Reprezentuje zagregowane zużycie użytkowników na partnera, klienta lub użytkownika (w zależności od raportu i poziomu, na którym wyświetlane są dane). Obliczenia: System oblicza ilość dzienną dla każdego użytkownika proporcjonalnie dla tego dnia. Stosowanie przez cały dzień = 1 Stosowanie przez pół dnia = 0,5 Następnie sumuje sumy dzienne za wszystkie dni w okresie rozliczeniowym, aby obliczyć całkowitą ilość dla tego użytkownika w tym okresie rozliczeniowym. W przypadku raportów na poziomie klientów i partnerów sumy dla wszystkich użytkowników są agregowane, aby zapewnić całkowitą ilość dla tego klienta lub partnera. Punkt w czasie: Raport klienta zawiera listę alokacji pakietów na klienta. Każdy wiersz reprezentuje całkowitą ilość określonego pakietu przypisanego użytkownikom lub obszarom roboczym w danej organizacji klienta. Ilość pokazuje „0”, jeśli nie ma przydzielonych pakietów. Raport użytkownika zawiera listę pakietów przypisanych do użytkowników lub obszarów roboczych. Każdy wiersz pokazuje ilość 1, reprezentującą użytkownika lub obszar roboczy oraz ich indywidualny pakiet lub dodatek. Jeśli do użytkownika lub obszaru roboczego przypisanych jest wiele pakietów lub dodatków, raport wyświetla wiele wpisów, każdy z ilością 1. |
PARTNER, CUSTOMER, USER |
Pojednanie, punkt w czasie |
Obowiązkowe |
|
LOCATION_ID |
Unikalny identyfikator lokalizacji |
CUSTOMER, USER |
Pojednanie, punkt w czasie Raport „Punkt w czasie klienta” nie zawiera identyfikatora lokalizacji |
Opcjonalnie |
|
LICENSE_ID |
Identyfikator licencji To pole jest widoczne tylko dla paczek hurtowych W przypadku raportu uzgodnienia License_ID opcja jest pusta dla licencji przypisanych przed wprowadzeniem tego pola. Raport rozliczeniowy pokazuje wiele wierszy dla tego samego pakietu hurtowego, jeśli jest on powiązany z różnymi kombin LOCATION_ID acjami iLICENSE_ID. |
CUSTOMER, USER |
Pojednanie, punkt w czasie |
Opcjonalnie |
Wybranie opcjonalnych kolumn powoduje modyfikację kolejności kolumn raportów uzgadniania klientów i użytkowników. Poniższa kolejność dotyczy partnerów posiadających tylko hurtowe SKU w subskrypcji:
Raport na poziomie użytkownika— PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SUBSCRIBER_ID,USER_ID,WORKSPACE_ID,SERVICE_NAME, SKU, OPIS, CONSUMPTION_START_DATECONSUMPTION_END_DATE, ILOŚĆ
Raport na poziomie klienta— PARTNER_NAMEPARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SERVICE_NAME,, SKU, OPIS, CONSUMPTION_START_DATECONSUMPTION_END_DATE, ILOŚĆ
Dostarczenie pakietu użytkownikowi powoduje rozliczanie hurtowe Webex, a usunięcie przypisania pakietu zatrzymuje je.
Organizacja klienta może należeć tylko do jednej grupy klientów w danym momencie. Wsparcie dla wielu grup klientów na organizację nie jest obecnie dostępne.
