Ten artykuł został przetłumaczony z języka angielskiego za pomocą tłumaczenia maszynowego.
Jeśli masz w swoim zespole programistę, który wie, jak korzystać z interfejsu API GraphQL, interfejs API Webex Events może być bramą do zaawansowanych automatyzacji konfiguracji wydarzeń i produktów oraz zarządzania nimi, integracji platform innych firm, wydajnych pulpitów nawigacyjnych z danymi obejmującymi wiele zdarzeń i nie tylko .
Co potrafi interfejs Webex Events API
Mówiąc najprościej, interfejs API to interfejs programistyczny, za pomocą którego programiści mogą pobierać dane z platformy internetowej lub umieszczać je na platformie internetowej — w tym przypadku Webex Events.
Możliwości API można uprościć do czterech podstawowych koncepcji:
Stwórz coś, czego wcześniej nie było, na przykład uczestnika, sesję lub całe wydarzenie.
Zaktualizuj wszystko, do czego można utworzyć interfejs API, a także kilka innych rzeczy. Za pomocą interfejsu API można na przykład utworzyć nowego uczestnika, a następnie edytować jego imię i nazwisko, adres e-mail, status, grupy, numery telefonów i konta społecznościowe.
Przeczytaj informacje o wszystkim, co można utworzyć lub edytować za pomocą interfejsu API, a także o niektórych rzeczach, których nie może.
Usuń wszystko, do czego można utworzyć interfejs API, z pewnymi wyjątkami.
Pamiętaj o tych pojęciach, czytając sekcję „Praca z programistami” w tym artykule.
Jak zacząć
1. Uzyskaj dostęp do API
Jeśli jesteś klientem umowy Webex Suite Enterprise Agreement (pakiet EA), który ma już aktywowaną Webex Events , automatycznie uzyskasz dostęp do interfejsu Webex Events API! W przypadku wszystkich pozostałych klientów porozmawiaj ze swoją osobą kontaktową w Webex Events lub z naszym zespołem pomocy technicznej, aby dowiedzieć się, jak uzyskać dostęp do interfejsu API.
2. Utwórz klucz API
Teraz musisz utworzyć nowy klucz API, z którego będą mogli korzystać programiści. Gdy uzyskasz dostęp do interfejsu API, na stronie „Ustawienia organizacji” na platformie Webex Events zostanie dodana nowa zakładka. Oto jak uzyskać dostęp do nowej karty i utworzyć pierwszy klucz:
💡 Pamiętaj, że dostęp do strony API mają tylko administratorzy organizacji.
W dowolnym miejscu platformy Webex Events kliknij swoje zdjęcie profilowe w prawym górnym rogu ekranu, a następnie z menu rozwijanego wybierz Ustawienia organizacji .
Na stronie Ustawienia organizacji kliknij kartę API w menu po lewej stronie. Spowoduje to przejście do panelu API, w którym możesz przeglądać wykorzystanie API, eksportować dzienniki użytkowania, zarządzać kluczami i uzyskać dostęp do naszej dokumentacji API.
Kliknij opcję Utwórz klucz .
W trybie „Utwórz nowy klucz” wprowadź etykietę klucza API, która wyjaśnia, do czego będzie on używany.
W menu rozwijanym Wersja API będzie już wybrana bieżąca wersja, więc po prostu kliknij Zapisz . Spowoduje to ujawnienie klucza API.
Kliknij przycisk Kopiuj obok klucza i wklej klucz do bezpiecznego dokumentu, aby mieć pewność, że nigdy go nie zgubisz.
⚠️UWAGA! Jest to jedyny moment, w którym można uzyskać dostęp do pełnego klucza API. Po zamknięciu modalu nie można ponownie odczytać pełnego klucza.
Po skopiowaniu i zapisaniu klucza kliknij przycisk Zamknij .
W większości przypadków potrzebny jest tylko jeden klucz API. Jednak w sytuacjach, gdy pracujesz z wieloma zespołami, możesz chcieć utworzyć klucz dla każdego zespołu. Porozmawiaj z programistami o konkretnych przypadkach użycia, aby znaleźć najlepsze rozwiązanie.
3. Zaproś programistów do dostępu do API
Po utworzeniu pierwszego klucza API na platformie Webex Events automatycznie tworzony jest nowy zespół API. Zapewnienie programistom dostępu do interfejsu API Webex Events jest tak proste, jak zaproszenie ich do tego zespołu API. Aby dowiedzieć się, jak to zrobić, postępuj zgodnie z instrukcjami zawartymi w naszym artykule na temat zarządzania zespołami, członkami i kredytami .
💡 Pamiętajcie, sandbox API to osobna wersja platformy Webex Events stworzona specjalnie na potrzeby testów. Oznacza to, że wszyscy nowi członkowie zespołu API Sandbox muszą utworzyć nowe konto platformy, aby móc korzystać z piaskownicy, nawet jeśli mają już konto na platformie lub logują się za pomocą logowania jednokrotnego swojej organizacji.
Osoby z Twojego zespołu API nie mają dostępu do pozostałej części platformy Webex Events w taki sam sposób, jak organizatorzy. Zamiast tego członkowie zespołu API mają dostęp do „piaskownicy” API, w której mogą testować to, co budują, bez wpływu na rzeczywiste dane. Jeśli chcesz, aby programiści mieli również dostęp do niektórych lub wszystkich Twoich prawdziwych wydarzeń i aplikacji na platformie Webex Events , zaproś ich do odpowiednich zespołów innych niż API.
4. Przygotuj wydarzenie
Ponieważ interfejs API nie może aktywować żadnego produktu w Wydarzeniu, takiego jak Event App i Na Onsite, musisz aktywować każdy produkt, którego zamierzasz używać podczas Wydarzenia, podając podstawowe wymagane informacje.
Współpraca z programistami
Ważne jest, aby jasno komunikować się z programistami, aby mogli stworzyć to, czego potrzebujesz. Oznacza to, że musisz wiedzieć, do jakich części platformy Webex Events ma dostęp interfejs API. Czytaj dalej, aby dowiedzieć się dokładnie, do czego interfejs API może uzyskać dostęp i nad czym kontrolę, a także kilka wskazówek, które pomogą Ci „mówić tym samym językiem”, co Twój programista.
Kiedy już zaznajomisz się z podstawowymi możliwościami, możesz zacząć rozmawiać ze swoim programistą na temat tworzenia narzędzi i automatyzacji za pomocą API.
Zespoły i organizacje
Twórz, aktualizuj, czytaj i usuwaj zespoły i członków zespołów
Wydarzenia
Twórz, aktualizuj, klonuj i czytaj. Wydarzeń nie można usunąć.
Uczestnicy
Twórz, aktualizuj, czytaj, przypisuj do sesji, przypisuj do grup i usuwaj informacje o kontach społecznościowych (numer telefonu, uchwyty kont społecznościowych itp.). Uczestników nie można usunąć, chociaż można ich zablokować.
pytania
Twórz, aktualizuj, czytaj i usuwaj
Wskazówka: w API pytania nazywane są „polami niestandardowymi”
Grupy
Twórz, aktualizuj, czytaj i usuwaj zarówno grupy ekskluzywne, jak i niewyłączne
Sesje
Twórz, aktualizuj, czytaj i usuwaj
Lokalizacje
Twórz, aktualizuj, czytaj i usuwaj
Wskazówka: w interfejsie API lokalizacje nazywane są „regionami”.
Branded Apps
Przeczytaj nazwy, statusy i nazwy przypisanych wydarzeń do Branded App
Event App
Przeczytaj Podstawy, Wygląd i ustawienia aplikacji internetowej oraz informacje o nagraniach w Video Center
Twórz, aktualizuj, czytaj i usuwaj następujące funkcje Event App i ich elementy, jeśli ma to zastosowanie:
Porządek obrad
Sponsorzy
Głośniki
Wystawcy
Transmisja na żywo
Uczestnicy
Lista niestandardowa
Pojedynczy przedmiot
Link do strony internetowej
Lista internetowa
Mój kod QR
💡 Pamiętaj, że musisz ręcznie dodać i skonfigurować wszystkie funkcje Event App, które nie są wymienione powyżej.
Wskazówka: w interfejsie API funkcje nazywane są „komponentami”.
Rejestracja
Przeczytaj informacje dotyczące podstaw, wyglądu i ustawień, w tym ustawień realizacji transakcji
Twórz, czytaj, aktualizuj i usuwaj bilety, formularze, pytania, kody promocyjne
Twórz, czytaj i aktualizuj zamówienia
Wysyłaj e-maile z potwierdzeniem zamówienia i biletu
Oznacz zamówienia czekiem lub fakturą jako opłacone
Zaktualizuj informacje o nabywcy zamówienia
Anuluj i zwróć bilety
Twórz, czytaj, aktualizuj, usuwaj, wstrzymuj i wznawiaj kody promocyjne
Twórz, czytaj, aktualizuj i usuwaj podatki
Wskazówka: w interfejsie API pytania nazywane są „polami niestandardowymi”.
Na Onsite
Przeczytaj i zaktualizuj informacje podstawowe i Onsite App
Lead Retrieval i Live Display
Przeczytaj, czy produkt jest aktywny lub opublikowany w Wydarzeniu
Rzeczy, które warto wiedzieć
Od czasu do czasu będziemy wydawać nowe wersje interfejsu API z ulepszeniami i poprawkami. Będziemy nadal wspierać stare wersje wystarczająco długo, aby wszyscy mogli przejść na nową wersję. Będziemy wysyłać e-maile z aktualizacjami dotyczącymi nowych wersji, nadchodzących dat wycofania starych wersji i oficjalnych wycofań.
Żądania API są mierzone i ograniczane, aby zapobiec nadużyciom.
Społeczności są również obsługiwane dla klientów pakietu Suite.