Dziękujemy za opinię.
Opinia?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 zdarzeń i produktów oraz zarządzania nimi, integracji platform innych firm, potężnych pulpitów danych z wieloma zdarzeniami i nie tylko.
Co może zrobić interfejs API zdarzeń Webex
Mówiąc prościej, API to interfejs programistyczny, którego programiści mogą używać do pobierania danych z platformy internetowej lub umieszczania danych na platformie internetowej - w tym przypadku Webex Events.
Możliwości interfejsu API można uprościć do czterech podstawowych pojęć:
-
Utwórz coś, co wcześniej nie istniało, na przykład uczestnika, sesję lub całe wydarzenie.
-
Zaktualiz uj wszystko, czego można utworzyć interfejs API, plus kilka innych rzeczy. Interfejs API może służyć na przykład do utworzenia nowego uczestnika, a następnie edytować imię i nazwisko, adres e-mail, status, grupy, numery telefonów i konta społecznościowe tego uczestnika.
-
Przeczytaj informacje o wszystkim, czego interfejs API może być używany do tworzenia lub edycji, a także o niektórych rzeczach, których nie może.
-
Usuń wszystko, co API może być użyte do utworzenia, z pewnymi wyjątkami.
Pamiętaj o tych pojęciach podczas czytania sekcji „Praca z programistami” tego artykułu.
Jak zacząć
1. Uzyskaj dostęp do interfejsu API
Jeśli jesteś klientem Webex Suite Enterprise Agreement (Suite EA), który ma już aktywowane wydarzenia Webex, automatycznie uzyskasz dostęp do interfejsu API Webex Events! Dla wszystkich innych klientów skontaktuj się ze swoim kontaktem Webex Events lub 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 mogą korzystać programiści. Gdy masz dostęp do interfejsu API, nowa karta jest dodawana do strony „Ustawienia organizacji” na platformie Webex Events. Oto jak uzyskać dostęp do nowej karty i utworzyć pierwszy klucz:
Należy pamiętać, że tylko administratorzy organizacji mogą uzyskać dostęp do strony API.
-
Z dowolnego miejsca na platformie Webex Events kliknij swój obraz profilowy w prawym górnym rogu ekranu, a następnie wybierz Ustawienia organizacji z listy rozwijanej.
-
Na stronie Ustawienia organizacji kliknij kartę API w menu po lewej stronie. Spowoduje to przejście do pulpitu API, gdzie możesz przeglądać użycie interfejsu API, eksportować dzienniki użytkowania, zarządzać kluczami i uzyskać dostęp do naszej dokumentacji API.
-
Kliknij przycisk Utwórz klucz.
-
W module „Utwórz nowy klucz” wprowadź etykietę dla klucza API, która wyjaśnia, do czego będzie on używany.
-
W rozwijanej wersji interfejsu API będzie już wybrana bieżąca wersja, więc po prostu kliknij Zapisz. To ujawnia klucz API.
-
Kliknij przycisk Kopiuj obok klucza i wklej klucz do bezpiecznego dokumentu, aby upewnić się, że nigdy nie zostanie utracony.
OSTRZEŻENIE! To jedyny raz, kiedy 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 Zam kni j.
W większości przypadków potrzebujesz tylko jednego klucza API. Jednak w sytuacjach, w których pracujesz z wieloma zespołami, możesz 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 interfejsu API
Po utworzeniu pierwszego klucza API nowy zespół API jest automatycznie tworzony na platformie Webex Events. Zapewnienie programistom dostępu do wypróbowania interfejsu API Webex Events jest tak proste, jak zaproszenie ich do tego zespołu API. Postępuj zgodnie z instrukcjami zawartymi w naszym artykule na temat zarządzania zespołami, członkami i kredytami, aby dowiedzieć się, jak to zrobić.
Pamiętaj, że piaskownica API jest osobną wersją platformy Webex Events stworzoną specjalnie do testowania. Oznacza to, że wszyscy nowi członkowie zespołu API Sandbox muszą utworzyć nowe konto platformy, aby korzystać z piaskownicy, nawet jeśli mają już konto platformy lub zalogują się za pomocą SSO swojej organizacji.
Osoby z Twojego zespołu API nie mają dostępu do reszty platformy Webex Events tak, jak robią to 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 dane ze świata rzeczywistego. Jeśli chcesz, aby programiści mieli również dostęp do niektórych lub wszystkich rzeczywistych Wydarzeń i Aplikacji na platformie Webex Events, zaproś ich do odpowiednich zespołów innych niż API.
4. Bądź miły dla swoich programistów
Jest to kluczowe, więc zrobiliśmy to cały krok. 😉
„Rzym nie został zbudowany w ciągu jednego dnia”, podobnie jak dobra integracja API. Bądź dobrym przyjacielem swoich programistów i daj im mnóstwo czasu na szybkość korzystania z interfejsu API Webex Events, zanim spodziewasz się, że dostarczą integracje. Będą wdzięczni, że nie będą pod presją.
Zalecamy rozpoczęcie rozmów z programistami co najmniej sześć miesięcy przed rozpoczęciem pracy integracji. Czytaj dalej, aby dowiedzieć się, jak przygotować się i prowadzić te rozmowy.
Praca z programistami
Po zaproszeniu programistów do zespołu Webex Events Sandbox, jednym z pierwszych pytań może być: „Ile czasu zajmie tworzenie integracji?” Odpowiedź na to pytanie zależy od wielu czynników, w tym od liczby programistów, z którymi pracujesz, ile czasu mają na pracę nad integracjami, jak złożone są integracje i nie tylko.
Tylko twoi programiści mogą powiedzieć, ile czasu zajmie konfiguracja integracji i dopiero po kilku kluczowych krokach:
-
Najpierw przeczytaj poniższe sekcje, aby dowiedzieć się, co może zrobić API. Pomoże Ci to zrozumieć, co jest możliwe, abyś mógł jasno komunikować swoje potrzeby z programistami.
-
Spotkaj się ze swoimi programistami, podziel się z nimi naszą dokumentacją API i omów, czego chcesz. Będą mogli przekazać podstawowe informacje zwrotne na temat tego, co mogą, a czego nie mogą dla Ciebie zrobić. Jednak nie będą w stanie podać konkretnych osi czasu, dopóki nie zaznajomią się z interfejsem API zdarzeń Webex.
-
Daj swoim programistom czas na zapoznanie się z API. Udostępnij sobie, aby odpowiedzieć na koncepcyjne lub praktyczne pytania dotyczące wydarzeń, danych, platformy Webex Events i wszystkiego innego.
Co może zrobić API
Interfejs API posiada dwie podstawowe funkcje:
-
Przeczytaj - pobierz dane z Webex Events, aby móc je zbadać lub wciągnąć do innego systemu.
-
Aktualizacja - Umieść dane w wydarzeniach Webex, aby tworzyć nowe elementy lub synchronizować dane, takie jak uczestnicy, z innej platformy. Wszystko, co zmienia coś na platformie Webex Events, jest aktualizacją.
Zespoły i organizacje
-
Tworzenie, aktualizowanie, odczytywanie i usuwanie zespołów i członków zespołu
Wydarzenia
-
Aktualizuj, klonuj i czytaj. Zdarzeń nie można tworzyć ani usuwać za pomocą interfejsu API.
Uczestnicy
-
Tworzenie, aktualizowanie, odczytywanie, przypisywanie do Sesji, przypisywanie do grup i usuwanie informacji o koncie społecznościowym (numer telefonu, obsługa kont społecznościowych itp.). Uczestników nie można usunąć, chociaż można ich zablokować.
Pytania
-
Tworzenie, aktualizowanie, odczytywanie i usuwanie
Wskazówka: W interfejsie API pytania nazywane są „polami niestandardowymi”
Grupy
-
Tworzenie, aktualizowanie, czytanie i usuwanie grup wyłącznych i niewyłącznych
Sesje
-
Tworzenie, aktualizowanie, odczytywanie i usuwanie
Lokalizacje
-
Tworzenie, aktualizowanie, odczytywanie i usuwanie
Wskazówka: W interfejsie API lokalizacje nazywane są „regionami”.
Markowe aplikacje
-
Przeczytaj nazwy aplikacji marki, statusy i nazwy przypisanych Zdarzeń
Aplikacja na wydarzenie
-
Przeczytaj informacje o podstawach, wyglądzie i Web App ustawieniach oraz informacje o nagraniach w centrum wideo
-
Tworzenie, aktualizowanie, odczytywanie i usuwanie następujących funkcji aplikacji zdarzeń i ich elementów, w stosownych przypadkach:
-
Agenda
-
Sponsorzy
-
Głośniki
-
Wystawcy
-
Transmisja na żywo
-
Uczestnicy
-
Lista niestandardowa
-
Pojedynczy przedmiot
-
Link internetowy
-
Lista internetowa
-
Mój kod QR
-
Pamiętaj, że musisz ręcznie dodać i skonfigurować wszystkie funkcje aplikacji Event App, które nie są wymienione powyżej.
Wskazówka: W interfejsie API funkcje nazywane są „komponentami”.
Rejestracja
-
Przeczytaj informacje o podstawach, wyglądzie i ustawieniach, w tym ustawieniach płatności
-
Twórz, czytaj, aktualizuj i usuwaj bilety, formularze, pytania, kody promocyjne
-
Tworzenie, odczytywanie i aktualizowanie zamówień
-
Wysyłaj e-maile z potwierdzeniem zamówienia i biletu
-
Oznacz zamówienia na czeki lub fakturowanie jako opłacone
-
Zaktualizuj informacje o nabywcy zamówienia
-
Anulowanie i zwrot biletów
-
Twórz, czytaj, aktualizuj, usuwaj, wstrzymuj i wznawiaj kody promocyjne
-
Tworzenie, odczytywanie, aktualizowanie i usuwanie podatków
Wskazówka: W interfejsie API pytania nazywane są „polami niestandardowymi”.
Na miejscu
-
Przeczytaj i aktualizuj podstawy i informacje o aplikacji na miejscu
Pobieranie potencjalnych klientów i wyświetlanie na żywo
-
Sprawdź, czy produkt jest aktywny, czy opublikowany w Wydarzeniu
Rzeczy, które warto wiedzieć
-
Interfejs API nie może być używany do tworzenia Zdarzenia ani aktywacji któregokolwiek z produktów w Zdarzeniu, takich jak Aplikacja Event i Onsite. Zanim programiści będą mogli zmodyfikować Zdarzenie za pomocą interfejsu API, musisz aktywować każdy produkt, którego zamierzasz użyć, i wypełnić podstawowe wymagane informacje dla każdego z nich.
-
Od czasu do czasu będziemy wydawać nowe wersje interfejsu API z ulepszeniami i poprawkami. Będziemy nadal obsługiwać stare wersje wystarczająco długo, aby wszyscy mogli przejść do nowej wersji. Będziemy wysyłać e-maile aktualizacje o nowych wersjach, nadchodzących datach wycofania starych wersji i oficjalnych wycofaniach.
-
Żądania API są mierzone i ograniczone, aby zapobiec nadużyciom.
-
Społeczności są również obsługiwane dla klientów Suite.
