Přeskočit na hlavní obsah
Všechny sbírkyIntegrace a partnerství
Začínáme s rozhraním Webex Events API
Začínáme s rozhraním Webex Events API

Co dělá API a jak začít

Daniel Murphey avatar
Autor: Daniel Murphey
Aktualizováno před více než týdnem

Tento článek byl přeložen z angličtiny pomocí strojového překladu.

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

Co umí rozhraní Webex Events API

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

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

  • Vytvořte něco, co dříve neexistovalo, jako je účastník, relace nebo celá událost.

  • Aktualizujte vše, co lze použít k vytvoření API, plus několik dalších věcí. Rozhraní API lze například použít k vytvoření nového účastníka a poté k úpravě jména, e-mailu, stavu, skupin, telefonních čísel a sociálních účtů tohoto účastníka.

  • Přečtěte si informace o čemkoli, co může API použít k vytvoření nebo úpravě, plus některé věci, které nemůže.

  • Smažte vše, co lze použít k vytvoření API, s některými výjimkami.

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

Jak začít

1. Získejte přístup k API

Pokud jste zákazníkem Webex Suite Enterprise Agreement (Suite EA), který již má Webex Events aktivované, automaticky získáte přístup k Webex Events API! Pokud jde o všechny ostatní zákazníky, promluvte si se svým kontaktem na Webex Events nebo s naším týmem podpory, abyste se dozvěděli o přístupu k API.

2. Vytvořte klíč 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 získat přístup k nové kartě a vytvořit svůj první klíč:

💡 Mějte na paměti, že na stránku API mají přístup pouze administrátoři organizace.

  1. Kdekoli na platformě Webex Events klikněte na svůj profilový obrázek v pravém horním rohu obrazovky a z rozbalovací nabídky vyberte Nastavení organizace .

  2. Na stránce Nastavení organizace klikněte v levé nabídce na kartu API . Tím se dostanete na řídicí panel rozhraní API, kde můžete zkontrolovat využití rozhraní API, exportovat protokoly použití, spravovat klíče a získat přístup k naší dokumentaci rozhraní API.

  3. Klikněte na Vytvořit klíč .

  4. V modálu „Vytvořit nový klíč“ zadejte popisek pro klíč API, který vysvětluje, k čemu bude použit.

  5. V rozevíracím seznamu Verze API již bude vybrána aktuální verze, takže jednoduše klikněte na Uložit . Tím se odhalí klíč API.

  6. Klikněte na tlačítko Kopírovat vedle klíče a vložte klíč do zabezpečeného dokumentu, abyste zajistili, že se nikdy neztratí.

    ⚠️ POZOR! Toto je jediný případ, kdy lze získat přístup k úplnému klíči API. Po zavření modalu nelze celý klíč znovu přečíst.

  7. 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 vašich konkrétních případech použití, abyste zjistili nejlepší řešení.

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

Když vytvoříte svůj první klíč API, na platformě Webex Events se automaticky vytvoří nový tým API. Poskytnout svým 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 API sandbox 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 sandbox používat, a to i v případě, že 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 do „sandboxu“ API, kde mohou testovat, co vytvářejí, aniž by to ovlivnilo reálná data. 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 relevantních týmů mimo API.

4. Připravte událost

Protože API nemůže aktivovat žádný z produktů v Události, jako je Event App a Onsite, musíte aktivovat každý produkt, který hodláte použít ve své Události, a vyplnit základní požadované informace.

Práce s vývojáři

Je důležité, abyste jasně komunikovali se svými vývojáři, aby mohli vytvořit to, co potřebujete. To znamená, že potřebujete vědět, ke kterým částem platformy Webex Events má API přístup. Pokračujte ve čtení, abyste se dozvěděli, k čemu přesně může rozhraní API přistupovat a ovládat, plus několik tipů, které vám pomohou „mluvit stejným jazykem“ jako váš vývojář.

Když se seznámíte se základními možnostmi, můžete se svým vývojářem začít mluvit o nástrojích a automatizaci vytváření pomocí API.

Týmy a organizace

  • Vytvářejte, aktualizujte, čtěte a mažte týmy a členy týmu

Události

  • Vytvářejte, aktualizujte, klonujte a čtěte. Události nelze smazat.

Účastníci

  • Vytvářejte, aktualizujte, čtěte, přiřazujte k relacím, přiřazujte ke skupinám a mažte informace o sociálních účtech (telefonní číslo, popisy sociálních účtů atd.). Účastníky nelze smazat, ale lze je zablokovat.

Otázky

  • Vytvářejte, aktualizujte, čtěte a mažte

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

Skupiny

  • Vytvářejte, aktualizujte, čtěte a mažte exkluzivní i nevýhradní skupiny

Relace

  • Vytvářejte, aktualizujte, čtěte a mažte

Místa

  • Vytvářejte, aktualizujte, čtěte a mažte

Tip: V rozhraní API se místa nazývají „regiony“.

Branded Apps

  • Přečtěte si názvy Branded App , stavy a názvy přiřazených událostí

Event App

  • Přečtěte si Základy, Vzhled a Nastavení webové aplikace a informace o nahrávkách Video Center

  • Vytvářejte, aktualizujte, čtěte a mažte následující funkce Event App a jejich položky, pokud je to možné:

    • Denní program

    • sponzoři

    • Řečníci

    • Vystavovatelé

    • Živý přenos

    • Účastníci

    • Vlastní seznam

    • Jedna položka

    • Webový odkaz

    • Webový seznam

    • Můj QR kód

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

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

Registrace

  • Přečtěte si informace o Základech, Vzhledu a Nastavení, včetně nastavení pokladny

  • Vytvářejte, čtěte, aktualizujte a mažte vstupenky, formuláře, otázky, propagační kódy

  • Vytvářejte, čtěte a aktualizujte objednávky

  • Odešlete e-maily s potvrzením objednávky a vstupenky

  • Označte objednávky šekem nebo fakturou jako zaplacené

  • Aktualizujte informace o kupujícím objednávky

  • Zrušení a vrácení vstupenek

  • Vytvářejte, čtěte, aktualizujte, mažte, pozastavujte a obnovujte propagační kódy

  • Vytvářejte, čtěte, aktualizujte a mažte daně

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

Na Onsite

  • Přečtěte si a aktualizujte základní informace a informace o Onsite App

Lead Retrieval a Live Display

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

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

  • Občas uvolníme nové verze API s vylepšeními a opravami. Budeme i nadále podporovat staré verze dostatečně dlouho na to, aby každý mohl přejít na novou verzi. Budeme vám zasílat e-mailové aktualizace o nových verzích, nadcházejících datech ukončení podpory starých verzí a oficiálních ukončeních podpory.

  • Požadavky API jsou měřeny a omezeny, aby se zabránilo zneužití.

  • Komunity jsou podporovány také pro zákazníky sady.

Dostali jste odpověď na svou otázku?