Dziękujemy za opinię.
Opinia?Raporty rozliczeniowe
Partnerzy mogą używać następujących interfejsów API rozliczeń hurtowych w celu generowania raportów rozliczeniowych, które pomogą im weryfikować wykorzystanie i dokładność aprowizacji. Dostęp do interfejsów API rozliczeń hurtowych można uzyskać za pośrednictwem serwisu developer.webex.com.
-
Uzgodnienie — wyświetla dane dotyczące zużycia na poziomie partnera, klienta lub użytkownika. Partnerzy mogą wykorzystać informacje z tego niestandardowego raportu rozliczeniowego do uzgadniania swoich miesięcznych faktur, dzięki czemu będą mogli wystawiać rachunki swoim klientom i użytkownikom na podstawie ich zużycia.
-
Punkt w czasie — wyświetla bieżące przydziały pakietów na poziomie klienta lub użytkownika. Raport „Punkt w czasie” umożliwia bieżące zliczanie przydzielonych pakietów. Partnerzy mogą wykorzystać te informacje w celu sprawdzenia poprawności realizacji zamówień i zapewnienia ich zgodności z zamówieniami klientów.
Partnerzy mogą również generować niestandardowe raporty rozliczeniowe dla podpartnerów, korzystając z parametru subPartnerOrgId.
Administratorzy partnerscy, którzy spełniają minimalne wymagania dostępu, mają dostęp do czterech interfejsów API.
|
API rozliczeń |
Cel API |
Wymagania dotyczące dostępu administracyjnego partnera |
|---|---|---|
|
Utwórz raport rozliczeń hurtowych |
Służy do generowania raportu rozliczeniowego. |
Read/write |
|
Uzyskaj raport rozliczeń hurtowych |
Służy do uzyskania wygenerowanego raportu rozliczeniowego do pobrania. |
Czytaj |
|
Wyświetl raporty rozliczeń hurtowych |
Służy do wyświetlania listy raportów rozliczeniowych istniejących dla danego partnera. |
Czytaj |
|
Usuwanie raportu rozliczeń hurtowych |
Służy do usuwania istniejącego raportu rozliczeniowego. |
Read/write |
Źródło danych
Dane do raportów rozliczeniowych pochodzą z przypisań pakietów i danych o użytkowaniu, które Webex śledzi dla każdego partnera. Webex codziennie gromadzi dane dotyczące pakietów klientów i użytkowników, aby wygenerować miesięczną fakturę dla partnera. Interfejsy API do rozliczeń wykorzystują te dane, umożliwiając administratorom partnerów generowanie niestandardowych raportów. Raporty te pomagają partnerom uzgadniać zużycie energii na podstawie miesięcznych faktur na poziomie partnera, klienta i użytkownika.
Aby uzyskać bardziej szczegółowe informacje na temat fakturowania partnerów przez Webex, zapoznaj się z artykułem Rozliczenia dostawców usług.
Utwórz raport rozliczeń hurtowych
| 1 |
Ze strony developer.webex.comprzejdź do Utwórz raport API rozliczeń hurtowych. |
| 2 |
Wybierz dowolną z następujących kategorii raportów:
Jeśli chcesz wygenerować raport uzgodnienia, nie musisz niczego zmieniać, ponieważ opcja uzgodnienia jest wybrana domyślnie. Możesz więc przejść do następnego kroku. Jeśli chcesz wygenerować raport z punktu w czasie, zmień wybór na „Punkt w czasie”. |
| 3 |
Wprowadź billingStartDate i billingEndDate w formacie określonym przez API. Można wpisać dowolną datę z ostatnich pięciu lat, ale nie dzień bieżący. W przypadku raportu Point-In-Time pola billingStartDate i billingEndDate nie są wymagane i zostaną zignorowane, jeśli zostaną wprowadzone. Raport zawsze odzwierciedla aktualny przydział pakietów. |
| 4 |
Wprowadź typ raportu :
|
| 5 |
W polu Dołącz wprowadź dodatkowe lub opcjonalne kolumny, które chcesz zobaczyć w raportach. Każdy typ raportu ma zestaw atrybutów obowiązkowych i zestaw atrybutów opcjonalnych. Możesz zdecydować, które z opcjonalnych atrybutów mają być wyświetlane dla każdego raportu. Jeśli nie uwzględnisz atrybutów opcjonalnych, w raporcie będą wyświetlane tylko atrybuty obowiązkowe. Poniższe kolumny to opcjonalne atrybuty, o których uwzględnienie możesz poprosić w raporcie dotyczącym klientów i użytkowników:
Aby wyświetlić te atrybuty w raporcie, należy uwzględnić identyfikator CUSTOMER_GROUP_i NAZWĘ CUSTOMER_GROUP_razem. Po wybraniu kolumn opcjonalnych kolejność kolumn w raportach uzgodnienia klientów i użytkowników ulega zmianie. Partnerzy muszą zaktualizować integrację API, aby zaakceptować nowy format CSV. Kolejność kolumn w raportach dotyczących konkretnych momentów czasowych pozostaje niezmieniona. Obecnie istniejące ustawienia funkcji mają pierwszeństwo przed parametrem Include podczas określania kolejności kolumn. Na przykład, jeśli dla klienta włączono określone ustawienie funkcji, to kolumna tej funkcji będzie wyświetlana zgodnie ze starym formatem raportu, nawet jeśli dodasz ją w parametrze Uwzględnij. Wkrótce usuniemy te ustawienia. Po usunięciu opcjonalnych kolumn można zażądać tylko za pomocą parametru Include. |
| 6 |
Kliknij Uruchom, aby wygenerować raport. |
| 7 |
Skopiuj raport id z wyjścia API. Możesz użyć tej wartości w interfejsie API Get, aby uzyskać wygenerowany raport rozliczeniowy. |
Co zrobić dalej
Przejdź do sekcji Pobierz raport rozliczeń hurtowych, aby pobrać kopię raportu.
Uzyskaj raport rozliczeń hurtowych
Po wygenerowaniu raportu rozliczeniowego użyj tego interfejsu API, aby uzyskać konkretny raport rozliczeniowy. Raport jest przesyłany na adres URL, pod którym można go pobrać przez 30 minut od zakończenia żądania GET.
| 1 |
Ze strony developer.webex.comprzejdź do Pobierz raport dotyczący rozliczeń hurtowych w interfejsie API. |
| 2 |
Wprowadź unikalną wartość id raportu i kliknij Uruchom. Interfejs API generuje raport o stanie. Dane wyjściowe obejmują parametr tempDownloadURL, który zawiera adres URL, z którego można pobrać raport. |
| 3 |
Skopiuj tempDownloadURL do przeglądarki, aby uzyskać dostęp do raportu i go pobrać. |
Wyświetl raporty rozliczeń hurtowych
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ć ją do tych, które spełniają określone parametry, takie jak okres rozliczeniowy i typ rozliczenia (Partner, Klient, Użytkownik).
Jeśli wprowadzisz parametry opcjonalne, API zwróci tylko te raporty, które dokładnie odpowiadają określonym przez Ciebie parametrom. Na przykład, jeśli określisz okres rozliczeniowy, zwrócone zostaną wyłącznie raporty wykorzystujące ten konkretny okres rozliczeniowy. Raporty, które mieszczą się w danym okresie, ale nie odpowiadają dokładnie podanym datom, nie są zwracane.
| 1 |
Ze strony developer.webex.comprzejdź do List Wholesale Billing Report API. |
| 2 |
W obszarze Parametry zapytaniawprowadź dowolne parametry wyszukiwania, których chcesz użyć (na przykład datę rozpoczęcia, datę zakończenia, typ, sortowanie według). |
| 3 |
Kliknij przycisk Uruchom. Interfejs API generuje listę raportów wraz z unikalnym identyfikatorem raportu i statusem (ZAKOŃCZONO, W TOKU_).
|
Co zrobić dalej
Zapisz identyfikator dla wszystkich raportów, które chcesz pobrać. Aby pobrać raport, przejdź do Pobierz raport rozliczeń hurtowych.
Usuń raport rozliczeń hurtowych
Użyj tej procedury, aby usunąć wygenerowany raport rozliczeniowy na podstawie identyfikatora raportu. Oto kilka przykładów sytuacji, w których możesz chcieć usunąć raport:
-
Jeśli chcesz ponownie wygenerować istniejący raport rozliczeniowy, musisz najpierw usunąć istniejący raport. Po usunięciu istniejącego raportu możesz utworzyć nowy raport za ten okres. Nie można usunąć raportu, jeśli jego generowanie się nie powiodło lub jest nadal w toku.
W przypadku raportu z określonego momentu nie trzeba usuwać istniejącego raportu, ponieważ system nie generuje ponownie takich raportów. Każdy raport zawsze odzwierciedla dane według bieżącego znacznika czasu.
-
Jeśli wyślesz wygenerowany adres URL raportu do niewłaściwej osoby, możesz usunąć raport i uniemożliwić jej dostęp do niego.
| 1 |
Ze strony developer.webex.comprzejdź do Usuń raport API rozliczeń hurtowych. |
| 2 |
Wprowadź identyfikator raportu i kliknij Uruchom. |
Pola raportu rozliczeniowego
Raporty rozliczeniowe zawierają następujące pola:
|
Pole |
Opis |
Obsługiwany typ raportu |
Obsługiwana kategoria raportu |
Atrybut obowiązkowy lub opcjonalny |
|---|---|---|---|---|
|
PARTNER_NAZWA |
Nazwa partnera |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
PARTNER_ORG_ID |
Unikalny identyfikator partnera |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
SUBSKRYPCJA_ID |
Unikalny identyfikator subskrypcji |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
KLIENT_GRUPA_ID | Unikalny identyfikator grupy, do której należy klient. Jeżeli klient zostanie przeniesiony do innej grupy w trakcie okresu rozliczeniowego, wykorzystanie zostanie podzielone na podstawie grup, do których należał klient w tym okresie. |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Opcjonalny |
|
NAZWA GRUPY KLIENTÓW__ | Wyświetlana nazwa grupy klientów. Jeżeli nazwa grupy ulegnie zmianie w trakcie okresu rozliczeniowego, używana jest najnowsza nazwa. |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Opcjonalny |
|
KLIENT_ORGANIZACJA_ID |
Wewnętrzny unikalny identyfikator klienta |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
KLIENT_ZEWNĘTRZNY_ID |
Unikalny identyfikator klienta podany przez partnera |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
TYP |
Typ użytkownika lub obszaru roboczego |
KLIENT, UŻYTKOWNIK |
Punkt w czasie |
Wymagane |
|
ID SUBSKRYBENTA_ |
Unikalny identyfikator subskrybenta |
UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
IDENTYFIKATOR UŻYTKOWNIKA_ |
Identyfikator użytkownika Webex subskrybenta |
UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
PRZESTRZEŃ ROBOCZA_ID |
Unikalny identyfikator obszaru roboczego |
UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
USŁUGA_NAZWA |
Nazwa usługi (np. WSPÓLNE_OBSZAR_POŁĄCZENIA, WEBEX_POŁĄCZENIA, WEBEX_SUITE, WEBEX_SPOTKANIA) |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
JM |
SKU dla usługi |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
OPIS |
Opis usługi |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
ZUŻYCIE_DATA ROZPOCZĘCIA_ |
Rozpoczęcie korzystania z usługi. Ta wartość wraz z poniższym polem definiuje okres użytkowania. |
PARTNER, KLIENT, UŻYTKOWNIK |
Uzgodnienie |
Wymagane |
|
KONSUMPCJA_KOŃCOWA_DATA |
Zakończenie użytkowania usługi. Wartość ta wraz z poprzednim polem definiuje okres zużycia użytkowania. |
PARTNER, KLIENT, UŻYTKOWNIK |
Uzgodnienie |
Wymagane |
|
RAPORT_DATA |
Data i godzina wygenerowania raportu. |
KLIENT, UŻYTKOWNIK |
Punkt w czasie |
Wymagane |
|
ILOŚĆ |
Reprezentuje zagregowane zużycie użytkowników na partnera, klienta lub użytkownika (w zależności od raportu i poziomu, na którym przeglądasz dane). Obliczenie: System oblicza dzienną ilość dla każdego użytkownika proporcjonalnie do danego dnia. Stosowanie przez cały dzień = 1 Stosowanie przez pół dnia = 0,5 Następnie sumuje całkowite ilości dla wszystkich dni okresu rozliczeniowego, aby obliczyć całkowitą ilość dla danego użytkownika w danym okresie rozliczeniowym. W raportach na poziomie klienta i partnera sumy dla wszystkich użytkowników są agregowane w celu uzyskania łącznej ilości dla danego klienta lub partnera. Punkt w czasie: Raport klienta zawiera listę pakietów przydzielonych każdemu klientowi. Każdy wiersz przedstawia całkowitą liczbę konkretnych pakietów przypisanych użytkownikom lub obszarom roboczym w obrębie konkretnej organizacji klienta. Ilość wyświetlana jest jako „0”, jeśli nie przydzielono żadnych pakietów. Raport użytkownika zawiera listę pakietów przypisanych użytkownikom lub obszarom roboczym. Każdy wiersz wyświetla liczbę 1, reprezentującą użytkownika lub obszar roboczy i jego indywidualny pakiet lub dodatek. Jeśli użytkownikowi lub obszarowi roboczemu przydzielono wiele pakietów lub dodatków, raport będzie zawierał wiele wpisów, każdy o ilości 1. |
PARTNER, KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Wymagane |
|
LOKALIZACJA_ID |
Unikalny identyfikator lokalizacji |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie Raport punktu w czasie klienta nie zawiera identyfikatora lokalizacji |
Opcjonalny |
|
LICENCJA_ID |
Identyfikator licencji To pole jest widoczne tylko dla pakietów hurtowych W raporcie uzgodnienia identyfikator License_jest pusty w przypadku licencji przypisanych przed wprowadzeniem tego pola. Raport rozliczeniowy zawiera wiele wierszy dla tego samego pakietu hurtowego, jeśli jest on powiązany z różnymi kombinacjami IDENTYFIKATORA LOKALIZACJI_i IDENTYFIKATORA LICENCJI_. |
KLIENT, UŻYTKOWNIK |
Pojednanie, punkt w czasie |
Opcjonalny |
Wybranie opcjonalnych kolumn zmienia kolejność kolumn w raportach uzgodnienia klientów i użytkowników. Poniższa kolejność obowiązuje partnerów, którzy w swojej subskrypcji mają wyłącznie jednostki magazynowe hurtowe:
Raport na poziomie użytkownika — PARTNER_NAZWA, PARTNER_ORGANIZACJA_IDENTYFIKATOR SUBSKRYPCJI_IDENTYFIKATOR GRUPY KLIENTÓW__IDENTYFIKATOR GRUPY KLIENTÓW__NAZWA, KLIENT_ORGANIZACJA [ ] IDENTYFIKATOR KLIENTA_ZEWNĘTRZNY_IDENTYFIKATOR LOKALIZACJI__IDENTYFIKATOR LICENCJI_IDENTYFIKATOR SUBSKRYBENTA_IDENTYFIKATOR UŻYTKOWNIKA_IDENTYFIKATOR PRZESTRZENI ROBOCZEJ_IDENTYFIKATOR USŁUGI_NAZWA, SKU, OPIS, ZUŻYCIE_DATA POCZĄTKOWA_DATA KOŃCOWA__DATA, ILOŚĆ
Raport na poziomie klienta — NAZWA PARTNERA_, PARTNER_ORGANIZACJA_IDENTYFIKATOR SUBSKRYPCJI_IDENTYFIKATOR GRUPY KLIENTÓW__IDENTYFIKATOR GRUPY KLIENTÓW__NAZWA KLIENTA_ORGANIZACJA [] IDENTYFIKATOR KLIENTA [_ZEWNĘTRZNY_IDENTYFIKATOR LOKALIZACJI__IDENTYFIKATOR LICENCJI_IDENTYFIKATOR USŁUGI_NAZWA, SKU, OPIS, ZUŻYCIE_DATA POCZĄTKOWA__DATA KOŃCOWA_DATA, ILOŚĆ
Dostarczenie pakietu użytkownikowi powoduje uruchomienie rozliczeń w ramach usługi Webex Wholesale, natomiast usunięcie przypisania pakietu powoduje jego zatrzymanie.
Jedna organizacja kliencka może w danym momencie należeć tylko do jednej grupy klientów. Obsługa wielu grup klientów na organizację nie jest obecnie dostępna.
