Začíname s Webex Events API
list-menuSpätná väzba?
Čo robí API a ako začať

Ak máte vo svojom tíme vývojára, ktorý vie, ako používať GraphQL API, rozhranie Webex Events API môže byť vašou bránou k výkonným automatizáciám nastavenia a správy udalostí a produktov, integrácii platforiem tretích strán, výkonným informačným panelom s viacerými udalosťami a ďalším.

Čo dokáže Webex Events API

Zjednodušene povedané, API je programovacie rozhranie, ktoré môžu vývojári použiť na získavanie údajov z online platformy alebo na umiestnenie údajov - v tomto prípade Webex Events.

Možnosti rozhrania API možno zjednodušiť na štyri základné pojmy:

  • Vyt vorte niečo, čo predtým neexistovalo, napríklad účastníka, reláciu alebo celú udalosť.

  • Aktualiz ujte čokoľvek, na vytvorenie rozhrania API, plus niekoľko ďalších vecí. Rozhranie API môže byť napríklad použité na vytvorenie nového účastníka a potom na úpravu mena účastníka, e-mailu, stavu, skupín, telefónnych čísel a sociálnych účtov účastníka.

  • Prečítajte si informácie o všetkom, čo API môže použiť na vytvorenie alebo úpravu, plus o niektorých veciach, ktoré nemôžu.

  • Odstrá ňte čokoľvek, na vytvorenie rozhrania API, s niektorými výnimkami.

Majte na pamäti tieto pojmy pri čítaní časti „Práca s vývojármi“ tohto článku.

Ako začať

1. Získajte prístup k rozhraniu API

Ak ste zákazníkom Webex Suite Enterprise Agreement (Suite EA), ktorý už má aktivované Webex Events, automaticky získate prístup k rozhraniu Webex Events API! Pre všetkých ostatných zákazníkov sa porozprávajte so svojím kontaktom Webex Events alebo naším tímom podpory, aby ste sa dozvedeli o prístupe k rozhraniu API.

2. Vytvorte kľúč API

Teraz musíte vytvoriť nový kľúč API, ktorý môžu používať vaši vývojári. Keď máte prístup k rozhraniu API, na stránku „Nastavenia organizácie“ v platforme Webex Events sa pridá nová karta. Tu je postup, ako získať prístup k novej karte a vytvoriť prvý kľúč:

Majte na pamäti, že na stránku API majú prístup iba správcovia organizácie.

  1. Odkiaľkoľvek na platforme Webex Events kliknite na svoj profilový obrázok v pravom hornom rohu obrazovky a potom v rozbaľovacej ponuke vyberte položku Nastavenia organiz ácie.

  2. Na stránke Nastavenia organizácie kliknite na kartu API v ľavej ponuke. Týmto sa dostanete na panel API, kde môžete skontrolovať používanie rozhrania API, exportovať protokoly používania, spravovať kľúče a získať prístup k našej dokumentácii API.

  3. Kliknite na položku Vytvoriť kľúč.

  4. V modále „Vytvoriť nový kľúč“ zadajte štítok pre kľúč API, ktorý vysvetľuje, na čo sa bude používať.

  5. Rozbaľov acia verzia rozhrania API už bude mať vybranú aktuálnu verziu, takže jednoducho kliknite na tlačidlo Uložiť. To odhaľuje kľúč API.

  6. Kliknite na tlačidlo Kopí rovať vedľa kľúča a vložte ho do zabezpečeného dokumentu, aby ste sa uistili, že sa nikdy nestratí.

VAROVANIE! Toto je jediný prípad, kedy je možné pristupovať k úplnému kľúču API. Po zatvorení modálu sa celý kľúč nedá znova prečítať.

  1. Po skopírovaní a uložení kľúča kliknite na tlačidlo Zav rieť.

Vo väčšine prípadov potrebujete iba jeden kľúč API. Avšak v situáciách, keď pracujete s viacerými tímami, možno budete chcieť vytvoriť kľúč pre každý tím. Porozprávajte sa so svojimi vývojármi o vašich konkrétnych prípadoch použitia, aby ste zistili najlepšie riešenie.

3. Pozvite vývojárov na prístup k rozhraniu API

Keď vytvoríte prvý kľúč API, na platforme Webex Events sa automaticky vytvorí nový tím API. Poskytnúť svojim vývojárom prístup k vyskúšaniu rozhrania Webex Events API je také jednoduché, ako ich pozvať do tohto tímu API. Postupujte podľa pokynov v našom článku o riadení tímov, členov a kreditov, aby ste sa dozvedeli, ako to urobiť.

Majte na pamäti, že API sandbox je samostatná verzia platformy Webex Events vyrobená špeciálne na testovanie. To znamená, že všetci noví členovia tímu API Sandbox musia vytvoriť nový účet platformy, aby mohli používať sandbox, aj keď už majú účet platformy alebo sa prihlásia pomocou SSO svojej organizácie.

Ľudia vo vašom tíme API nemajú prístup k zvyšku platformy Webex Events tak, ako to robia organizátori. Namiesto toho majú členovia tímu API prístup k „sandboxu“ API, kde môžu testovať, čo budujú, bez toho, aby ovplyvnili údaje v reálnom svete. Ak chcete, aby vývojári mali prístup aj k niektorým alebo všetkým vašim skutočným udalostiam a aplikáciám v platforme Webex Events, pozvite ich do príslušných tímov, ktoré nie sú API.

4. Buďte láskaví k svojim vývojárom

Je to rozhodujúce, takže sme to urobili celý krok. 😉

„Rím nebol postavený za jeden deň“ a nebola ani dobrá integrácia API. Buďte dobrým priateľom pre svojich vývojárov a dajte im dostatok času na to, aby sa zrýchlili v rozhraní Webex Events API predtým, ako očakávate, že budú poskytovať integrácie. Budú vďační, že nebudú pod tlakom.

Minimálne odporúčame začať konverzácie so svojimi vývojármi najmenej šesť mesiacov predtým, ako budete potrebovať integráciu. Pokračujte v čítaní, aby ste sa naučili, ako sa na tieto rozhovory pripraviť a viesť ich.

Práca s vývojármi

Po pozvaní vývojárov do svojho tímu Webex Events Sandbox môže byť jednou z vašich prvých otázok: „Ako dlho bude trvať vytvorenie integrácií?“ Odpoveď na túto otázku závisí od mnohých faktorov, vrátane toho, koľko vývojárov pracujete, koľko času majú pracovať na integráciách, ako zložité sú integrácie a ďalšie.

Iba vaši vývojári vám môžu povedať, ako dlho bude trvať nastavenie integrácie, a to až po niekoľkých dôležitých krokoch:

  1. Najprv si prečítajte nižšie uvedené časti, aby ste sa dozvedeli, čo rozhranie API dokáže. To vám pomôže pochopiť, čo je možné, aby ste mohli jasne komunikovať svoje potreby so svojimi vývojármi.

  2. Stretnite sa so svojimi vývojármi, zdieľajte s nimi našu dokumentáciu API a diskutujte o tom, čo chcete. Budú schopní poskytnúť základnú spätnú väzbu o tom, čo pre vás môžu a nemôžu urobiť. Nebudú vám však môcť poskytnúť konkrétne časové harmonogramy, kým nebudú oboznámení s rozhraním API Webex Events API.

  3. Dajte svojim vývojárom čas na oboznámenie sa s rozhraním API. Sprístupnite sa, aby ste odpovedali na koncepčné alebo praktické otázky týkajúce sa vašich udalostí, údajov, platformy Webex Events a čokoľvek iného.

Čo môže API urobiť

Rozhranie API má dve základné funkcie:

  • Čítať - Získajte údaje z Webex Events, aby ste ich mohli preskúmať alebo vtiahnuť do iného systému.

  • Aktualiz ácia - Vložte údaje do udalostí Webex, aby ste vytvorili nové položky alebo synchronizovali údaje, napríklad účastníkov, z inej platformy. Všetko, čo niečo zmení na platforme Webex Events, je aktualizácia.

Tímy a organizácie

  • Vytváranie, aktualizácia, čítanie a odstraňovanie tímov a členov tímu

Podujatia

  • Aktualizujte, klonujte a čítajte. Udalosti nie je možné vytvárať ani odstrániť pomocou rozhrania API.

Účastníci

  • Vytvárajte, aktualizujte, čítajte, priraďujte k reláciám, priraďujte k skupinám a odstraňujte informácie o sociálnych účtoch (telefónne číslo, spracovanie sociálnych účtov atď.). Účastníkov nemožno odstrániť, hoci môžu byť zablokovaní.

Otázky

  • Vytváranie, aktualizácia, čítanie a odstránenie

Tip: V rozhraní API sa otázky nazývajú „vlastné polia“

Skupiny

  • Vytváranie, aktualizácia, čítanie a odstránenie exkluzívnych aj neexkluzívnych skupín

Zasadnutia

  • Vytváranie, aktualizácia, čítanie a odstránenie

Lokality

  • Vytváranie, aktualizácia, čítanie a odstránenie

Tip: V rozhraní API sa umiestnenia nazývajú „regióny“.

Značkové aplikácie

  • Prečítajte si názvy značkových aplikácií, stavy a názvy priradených udalostí

Aplikácia udalostí

  • Prečítajte si základné informácie, vzhľad a Web App nastavenia a informácie o nahrávkach Video Center

  • Vytvorte, aktualizujte, čítajte a odstráňte nasledujúce funkcie aplikácie udalostí a ich položky, ak je to vhodné:

    • Program

    • Sponzori

    • Reproduktory

    • Vystavovateľov

    • Živý prenos

    • Účastníci

    • Vlastný zoznam

    • Jedna položka

    • Webový odkaz

    • Zoznam webových stránok

    • Môj QR kód

Majte na pamäti, že musíte manuálne pridať a nakonfigurovať všetky funkcie aplikácie Event App, ktoré nie sú uvedené vyššie.

Tip: V rozhraní API sa funkcie nazývajú „komponenty“.

Registrácia

  • Prečítajte si informácie o základoch, vzhľade a nastaveniach vrátane nastavení platby

  • Vytvárajte, čítajte, aktualizujte a odstraňujte lístky, formuláre, otázky, propagačné kódy

  • Vytváranie, čítanie a aktualizácia objednávok

  • Pošlite e-maily s potvrdením objednávky a lístkov

  • Označiť objednávky šeku alebo faktúry ako zaplatené

  • Aktualizujte informácie o kupujúcom objednávke

  • Zrušenie a vrátenie lístkov

  • Vytváranie, čítanie, aktualizácia, odstraňovanie, pozastavenie a obnovenie propagačných kódov

  • Vytváranie, čítanie, aktualizácia a odstraňovanie daní

Tip: V rozhraní API sa otázky nazývajú „vlastné polia“.

Na mieste

  • Prečítajte si a aktualizujte základné informácie a informácie o aplikácii na mieste

Vyhľadávanie potenciálnych zákazníkov a živé zobrazenie

  • Prečítajte si, či je produkt aktívny alebo publikovaný v podujatí

Veci, ktoré treba vedieť

  • Rozhranie API nie je možné použiť na vytvorenie udalosti alebo aktiváciu akéhokoľvek z produktov v udalosti, ako je napríklad aplikácia Event a Onsite. Predtým, ako môžu vývojári upraviť udalosť pomocou rozhrania API, musíte aktivovať každý produkt, ktorý chcete použiť, a vyplniť základné požadované informácie pre každý z nich.

  • Príležitostne vydáme nové verzie rozhrania API s vylepšeniami a opravami. Budeme naďalej podporovať staré verzie dostatočne dlho, aby všetci mohli prejsť na novú verziu. Pošleme e-mailom aktualizácie o nových verziách, nadchádzajúcich dátumoch vyradenia starých verzií a oficiálnych zrušení.

  • Požiadavky API sú merané a obmedzené, aby sa zabránilo zneužitiu.

  • Komunity sú podporované aj pre zákazníkov Suite.

Bol tento článok užitočný?
Bol tento článok užitočný?