Začínáme s Webex Events API

Pokud máte ve svém týmu vývojáře, který ví, jak používat rozhraní GraphQL API, může být rozhraní Webex Events API vaší bránou k výkonným automatizacím nastavení a správy událostí a produktů, integracím platforem třetích stran, výkonným řídicím panelům dat pro více událostí a dalším.

Co umí rozhraní Webex Events API

Jednoduše řečeno, API je programovací rozhraní, které mohou vývojáři použít k získávání dat nebo vkládání dat do online platformy - v tomto případě Webex Events.

Možnosti rozhraní API lze zjednodušit na čtyři základní pojmy:

Vytvořte něco, co dříve neexistovalo, například účastníka, relaci nebo celou událost.
Aktualiz ujte vše, co lze API použít k vytvoření, plus několik dalších věcí. Rozhraní API lze například použít k vytvoření nového účastníka a k úpravě jména, e-mailu, stavu, skupin, telefonních čísel a sociálních účtů účastníka.
Přečtěte si informace o čemkoli, co lze API použít k vytvoření nebo úpravě, plus o některých věcech, které nemůže.
Od straňte vše, co lze API použít k vytvoření, až na některé výjimky.

Při čtení části „Práce s vývojáři“ tohoto článku mějte na paměti tyto koncepty.

Jak začít

1. Získejte přístup k API

Pokud jste zákazníkem Webex Suite Enterprise Agreement (Suite EA), který již má aktivované Webex Events, automaticky získáte přístup k rozhraní Webex Events API! Pokud jde o všechny ostatní zákazníky, obraťte se na svého kontaktu Webex Events nebo s naším týmem podpory a dozvíte se o přístupu k rozhraní API.

2. Vytvoření klíče API

Nyní musíte vytvořit nový klíč API, který budou vaši vývojáři používat. Když máte přístup k rozhraní API, na stránku „Nastavení organizace“ na platformě Webex Events se přidá nová karta. Zde je návod, jak otevřít novou kartu a vytvořit svůj první klíč:

Mějte na paměti, že na stránku API mají přístup pouze správci organizace.

Odkudkoli na platformě Webex Events klikněte na svůj profilový obrázek v pravém horním rohu obrazovky a poté z rozevíracího seznamu vyberte Nastavení organizace.
Na stránce Nastavení organizace klikněte na kartu API v levé nabídce. Tím se dostanete na řídicí panel API, kde můžete zkontrolovat využití API, exportovat protokoly využití, spravovat klíče a přistupovat k naší dokumentaci API.
Klikněte na Vytvořit klíč.
V modulu „Vytvořit nový klíč“ zadejte štítek pro klíč API, který vysvětluje, k čemu bude použit.
Rozevírací nabídka verze rozhraní API již bude mít vybranou aktuální verzi, takže jednoduše klikněte na Uložit. To odhalí klíč API.
Klikněte na tlačítko Kopírovat vedle klíče a vložte klíč do zabezpečeného dokumentu, abyste se ujistili, že se nikdy neztratí.

VAROVÁNÍ! Toto je jediný případ, kdy lze získat přístup k úplnému klíči API. Po zavření modálu nelze úplnou klávesu znovu přečíst.

Po zkopírování a uložení klíče klikněte na tlačítko Zav řít.

Ve většině případů potřebujete pouze jeden klíč API. V situacích, kdy pracujete s více týmy, však možná budete chtít vytvořit klíč pro každý tým. Promluvte si se svými vývojáři o konkrétních případech použití a vyhledejte nejlepší řešení.

3. Pozvěte vývojáře k přístupu k API

Když vytvoříte svůj první klíč API, v platformě Webex Events se automaticky vytvoří nový tým API. Poskytnout vývojářům přístup k vyzkoušení rozhraní Webex Events API je stejně jednoduché jako pozvat je do tohoto týmu API. Postupujte podle pokynů v našem článku o správě týmů, členů a kreditů a zjistěte, jak na to.

Mějte na paměti, že karanténa API je samostatná verze platformy Webex Events vytvořená speciálně pro testování. To znamená, že všichni noví členové týmu API Sandbox si musí vytvořit nový účet platformy, aby mohli sandboxu používat, i když již mají účet platformy nebo se přihlásí pomocí SSO své organizace.

Lidé ve vašem týmu API nemají přístup ke zbytku platformy Webex Events jako organizátoři. Místo toho mají členové týmu API přístup k „sandboxu“ API, kde mohou otestovat, co vytvářejí, aniž by to ovlivnilo data z reálného světa. Pokud chcete, aby vývojáři měli také přístup k některým nebo všem vašim skutečným událostem a aplikacím na platformě Webex Events, pozvěte je do příslušných týmů jiných než API.

4. Buďte laskaví ke svým vývojářům

To je zásadní, takže jsme z toho udělali celý krok. 😉

„Řím nebyl postaven za den“ a nebyla ani dobrá integrace API. Buďte dobrým přítelem svých vývojářů a dejte jim dostatek času na to, aby se seznámili s Webex Events API, než očekáváte, že budou poskytovat integrace. Budou vděční, že nebudou pod tlakem.

Minimálně, doporučujeme zahájit konverzaci se svými vývojáři nejméně šest měsíců před tím, než budete potřebovat integrace fungovat. Pokračujte ve čtení, abyste se naučili, jak se na tyto konverzace připravit a vést je.

Spolupráce s vývojáři

Poté, co pozvete vývojáře do svého týmu Webex Events Sandbox, jedna z vašich prvních otázek může být: „Jak dlouho bude trvat vytvoření integrací?“ Odpověď na tuto otázku závisí na mnoha faktorech, včetně počtu vývojářů, s nimiž pracujete, kolik času mají na práci na integracích, jak složité jsou integrace a další.

Pouze vaši vývojáři vám mohou sdělit, jak dlouho bude integrace trvat, a to až po několika zásadních krocích:

Nejprve si přečtěte níže uvedené části a zjistěte, co může API udělat. To vám pomůže pochopit, co je možné, takže můžete jasně komunikovat své potřeby se svými vývojáři.
Seznamte se se svými vývojáři, sdí lejte s nimi naši dokumentaci API, a diskutujte o tom, co chcete. Budou schopni poskytnout základní zpětnou vazbu o tom, co pro vás mohou a nemohou udělat. Nebudou vám však moci poskytnout konkrétní časové osy, dokud nebudou obeznámeni s Webex Events API.
Dejte svým vývojářům čas, aby se seznámili s API. Buďte k dispozici pro zodpovězení koncepčních nebo praktických otázek týkajících se vašich událostí, dat, platformy Webex Events a čehokoli jiného.

Co API umí

API má dvě základní funkce:

Čí st - Získejte data z Webex Events, abyste je mohli prozkoumat nebo přetáhnout do jiného systému.
Aktualizace - Vložte data do Webex Events a vytvořte nové položky nebo synchronizujte data, například účastníci, z jiné platformy. Cokoli, co něco změní na platformě Webex Events, je aktualizace.

Týmy a organizace

Vytváření, aktualizace, čtení a mazání týmů a členů týmu

Události

Aktualizujte, klonujte a čtěte. Události nelze vytvářet ani mazat pomocí rozhraní API.

Účastníci

Vytvářejte, aktualizujte, čtěte, přiřaďte k relacím, přiřazujte skupinám a odstraňujte informace o sociálních účtech (telefonní číslo, popisovače sociálních účtů atd.). Účastníky nelze smazat, i když je lze zablokovat.

Otázky

Vytváření, aktualizace, čtení a mazání

Tip: V API se otázky nazývají „vlastní pole“

Skupiny

Vytváření, aktualizace, čtení a mazání exkluzivních i neexkluzivních skupin

Zasedání

Vytváření, aktualizace, čtení a mazání

Lokality

Vytváření, aktualizace, čtení a mazání

Tip: V rozhraní API se umístění nazývají „regiony“.

Značkové aplikace

Přečtěte si názvy značkových aplikací, stavy a názvy přiřazených událostí

Aplikace pro události

Přečtěte si základy, vzhled a Web App nastavení a informace o záznamech Video Center
Vytvořte, aktualizujte, přečtěte si a odstraňte následující funkce aplikace Event App a jejich položky, pokud je to vhodné:
- Agenda
- Sponzoři
- Reproduktory
- Vystavovatelé
- Živý přenos
- Účastníci
- Vlastní seznam
- Jedna položka
- Webový odkaz
- Seznam webových stránek
- Můj QR kód

Mějte na paměti, musíte ručně přidat a nakonfigurovat všechny funkce aplikace Event, které nejsou uvedeny výše.

Tip: V API se funkce nazývají „komponenty“.

Registrace

Přečtěte si informace o základech, vzhledu a nastavení, včetně nastavení pokladny
Vytváření, čtení, aktualizace a mazání vstupenek, formulářů, otázek, promo kódů
Vytváření, čtení a aktualizace objednávek
Odeslat e-maily s potvrzením objednávky a vstupenky
Označit šekové nebo fakturační objednávky jako zaplacené
Aktualizovat informace o odběrateli objednávky
Zrušení a vrácení vstupenek
Vytváření, čtení, aktualizace, mazání, pozastavení a obnovení propagačních kódů
Vytváření, čtení, aktualizace a odstranění daní

Tip: V API se otázky nazývají „vlastní pole“.

Na místě

Přečtěte si a aktualizujte základní informace a informace o aplikacích na pracovišti

Vyhledávání potenciálních zákazníků a živé zobrazení

Přečtěte si, zda je produkt aktivní nebo publikovaný v Události

Věci, které byste měli vědět

Rozhraní API nelze použít k vytvoření události ani k aktivaci žádného z produktů v Události, jako je aplikace Event a Onsite. Než vývojáři mohou upravit událost pomocí API, musíte aktivovat každý produkt, který hodláte použít, a vyplnit základní požadované informace pro každý z nich.
Příležitostně vydáme nové verze API s vylepšeními a opravami. Budeme i nadále podporovat staré verze dostatečně dlouho, aby všichni mohli přejít na novou verzi. Budeme zasílat e-mailové aktualizace o nových verzích, nadcházejících datech zastaralých verzí a oficiálních zastaralých verzí.
Požadavky API jsou měřeny a omezeny, aby se zabránilo zneužití.
Komunity jsou podporovány také pro zákazníky Suite.

Cisco AI Assistant

Děkujeme za vaši zpětnou vazbu.