Első lépések a Webex Events API-val

Ha csapatában van olyan fejlesztő, aki tudja, hogyan kell használni a GraphQL API-t, a Webex Events API lehet az átjáró az erőteljes esemény- és termékbeállítási és -kezelési automatizálásokhoz, harmadik féltől származó platformintegrációhoz, nagy teljesítményű többeseményes adatkezelési pultokhoz és egyebekhez.

Mit tehet a Webex Events API

Egyszerűen fogalmazva, az API egy olyan programozási felület, amelyet a fejlesztők arra használhatnak, hogy adatokat szerezzenek vagy adatokat helyezjenek el egy online platformra - ebben az esetben a Webex Eseményekre.

Az API képességei négy alapfogalomra egyszerűsíthetők:

Hozzon létre valamit, ami korábban nem létezett, például egy résztvevőt, egy munkamenetet vagy egy egész Eseményt.
F rissítsen bármit, amit az API létrehozhat, plusz néhány további dolgot. Az API-val például új résztvevő létrehozása, majd szerkeszthető a résztvevő neve, e-mail címe, állapota, csoportjai, telefonszáma és közösségi fiókja.
Olvas son információkat bármiről, amivel az API létrehozható vagy szerkeszthető, valamint néhány olyan dologról, amit nem tud.
Töröl jön bármit, amit az API létrehozhat, néhány kivételtől eltekintve.

Tartsa szem előtt ezeket a fogalmakat, miközben olvassa a cikk „Fejlesztőkkel való együttműködés” szakaszát.

Hogyan kezdjünk el

1. Hozzáférés az API-hoz

Ha Ön vállalati szerződéses Webex Suite (Suite EA) ügyfél, akinek már aktiválta a Webex eseményeket, akkor automatikusan hozzáférhet a Webex Events API-hoz! Az összes többi ügyfél számára beszéljen a Webex Events kapcsolattartójával vagy ügyfélszolgálatunkkal, hogy megtudjon az API-hoz való hozzáférésről.

2. API kulcs létrehozása

Most létre kell hoznia egy új API-kulcsot a fejlesztők számára. Ha hozzáférést kap az API-hoz, egy új lap kerül hozzáadásra a Webex események platform „Szervezeti beállítások” oldalához. Így érheti el az új fület és létrehozhatja az első kulcsot:

Ne feledje, hogy csak a szervezeti adminisztrátorok férhetnek hozzá az API-oldalhoz.

A Webex Events platform bárhonnan kattintson a profilképére a képernyő jobb felső sarkában, majd válassza a Szervezeti beállítások lehetőséget a legördülő listából.
A Szervezeti beállítások oldalon kattintson a bal oldali menü API fülére. Ez az API irányítópultra vezet, ahol áttekintheti az API-használatát, exportálhatja a használati naplókat, kezelheti a kulcsokat, és hozzáférhet API-dokumentációhoz.
Kattintson a Kulcs létrehozása gom bra.
Az „Új kulcs létrehozása” modálban írja be az API-kulcs címkét, amely elmagyarázza, hogy mire fogják használni.
Az API verzió legördülő listája már kiválasztja az aktuális verziót, ezért egyszerűen kattintson a Mentés gombra. Ez feltárja az API kulcsot.
Kattintson a gomb melletti Másolás gombra, és illessze be a kulcsot egy biztonságos dokumentumba, hogy soha ne veszjen el.

FIGYELMEZTETÉS! Ez az egyetlen alkalom, amikor a teljes API-kulcs elérhető. A modál bezárása után a teljes gomb nem olvasható újra.

A gomb másolása és mentése után kattintson a Bezár ás gombra.

A legtöbb esetben csak egy API kulcsra van szüksége. Azonban olyan helyzetekben, amikor több csapattal dolgozik, érdemes minden csapat számára létrehozni egy kulcsot. Beszéljen a fejlesztőivel a konkrét felhasználási esetekről, hogy megtalálja a legjobb megoldást.

3. Kérje meg a fejlesztőket az API-hoz való hozzáférésre

Az első API-kulcs létrehozásakor automatikusan létrejön egy új API-csapat a Webex Events platformon. A fejlesztőknek hozzáférést biztosítani a Webex Events API kipróbálásához olyan egyszerű, mint meghívni őket az API-csapatba. Kövesse a cikkünkben található utasításokat a csapatok, tagok és kreditek kezeléséről, hogy megtudhatja, hogyan.

Ne feledje, hogy az API sandbox a Webex Events platform külön verziója, amelyet kifejezetten tesztelésre készítettek. Ez azt jelenti, hogy az API Sandbox csapat minden új tagjának létre kell hoznia egy új platformfiókot a sandbox használatához, még akkor is, ha már rendelkezik platformfiókkal, vagy bejelentkezik a szervezet SSO-jával.

Az API-csapatod munkatársai nem férhetnek hozzá a Webex Events platform többi részéhez, ahogy a szervezők teszik. Ehelyett az API-csapat tagjai hozzáférhetnek egy API „sandboxhoz”, ahol tesztelhetik, mit építenek anélkül, hogy befolyásolnák a valós adatokat. Ha azt szeretné, hogy a fejlesztők hozzáférjenek a Webex Events platformon található valós eseményeinek és alkalmazásainak egy részéhez vagy mindegyikéhez, hívja meg őket az API-n kívüli releváns csapatokhoz.

4. Legyen kedves a fejlesztőivel

Ez kulcsfontosságú, ezért egy teljes lépést tettünk. 😉

„Róma nem egy nap alatt épült”, és nem volt jó API-integráció sem. Legyen jó barátja a fejlesztőinek, és adjon nekik rengeteg időt arra, hogy felgyorsítsák a Webex Events API-t, mielőtt elvárnák tőlük, hogy integrációkat biztosítsanak. Hálásak lesznek, hogy nem nyomást gyakorolnak.

Legalább azt javasoljuk, hogy legalább hat hónappal kezdjen el beszélgetéseket a fejlesztőivel, mielőtt integrációkra lenne szükség. Olvassa tovább, hogy megtanulja, hogyan kell felkészülni ezekre a beszélgetésekre és folytatni őket.

Fejlesztőkkel való együttműködés

Miután meghívta a fejlesztőket a Webex Events Sandbox csapatába, az egyik első kérdése a következő lehet: „Mennyi ideig tart az integrációk felépítése?” A kérdés megválaszolása számos tényezőtől függ, beleértve azt, hogy hány fejlesztővel dolgozik együtt, mennyi idővel kell dolgozniuk az integráción, mennyire összetettek az integrációk stb.

Csak a fejlesztők tudják megmondani, hogy mennyi ideig tart egy integráció beállí tása, és csak néhány fontos lépés után:

Először olvassa el az alábbi szakaszokat, hogy megtudja, mit tehet az API. Ez segít megérteni, mi lehetséges, így egyértelműen kommunikálhatja igényeit a fejlesztőivel.
Találkozzon fejlesztőivel, ossza meg velük API-dokument ációnkat, és beszélje meg, mit szeretne. Alapvető visszajelzést adhatnak arról, hogy mit tehetnek és mit nem tehetnek érted. Mindazonáltal addig nem tudnak konkrét idővonalakat adni, amíg nem ismerik a Webex Events API-t.
Adjon időt fejlesztőinek, hogy megismerkedjenek az API-val. Legyen elérhetővé, hogy megválaszoljon az eseményeivel, adataival, a Webex Events platformjával és bármi mással kapcsolatos fogalmi vagy gyakorlati kérdésekre.

Mit tehet az API

Az API két alapvető funkcióval rendelkezik:

Olvas sa el - Szerezzen adatokat a Webex Events-ről, hogy megvizsgálhassa vagy más rendszerbe húzhassa őket.
Frissítés - Helyezze be adatokat a Webex Eseményekbe, hogy új elemeket hozzon létre, vagy szinkronizálja az adatokat, például a résztvevőket egy másik platformról. Bármi, ami megváltoztatja valamit a Webex Events platformon, az frissítés.

Csapatok és szervezetek

Csapatok és csapattagok létrehozása, frissítése, olvasása és törlése

Események

Frissítse, klónozza és olvassa el. Az események nem hozhatók létre vagy törölhetők az API-val.

Résztvevők

Közösségi fiókadatok létrehozása, frissítése, olvasása, munkamenetek hozzárendelése, csoportokhoz való hozzárendelése és törlése a közösségi fiók adatait (telefonszám, közösségi fiókkezelők stb.). A résztvevők nem törölhetők, bár blokkolhatók.

Kérdések

Létrehozás, frissítés, olvasás és törlés

Tipp: Az API-ban a kérdéseket „egyéni mezőknek” nevezik

Csoportok

Kizárólagos és nem kizárólagos csoportok létrehozása, frissítése, olvasása és törlése

Foglalkozások

Létrehozás, frissítés, olvasás és törlés

Helyszínek

Létrehozás, frissítés, olvasás és törlés

Tipp: Az API-ban a helyeket „régióknak” nevezik.

Márkás alkalmazások

Olvassa el a márkás alkalmazások nevét, állapotát és a hozzárendelt események nevét

Esemény alkalmazás

Olvassa el az alapokat, a megjelenést és a Web App beállításokat, valamint a Video Center Recordings információkat
Az Eseményalkalmazás következő funkcióinak és elemeinek létrehozása, frissítése, olvasása és törlése, adott esetben:
- Napirend
- Szponzorok
- Hangszórók
- Kiállítók
- Élő közvetítés
- Résztvevők
- Egyéni lista
- Egyetlen tétel
- Webes link
- Weblista
- Saját QR-kódom

Ne feledje, hogy manuálisan hozzá kell adnia és konfigurálnia kell a fent felsorolt Eseményalkalmazás-funkciókat.

Tipp: Az API-ban a funkciókat „összetevőknek” nevezik.

Regisztráció

Olvassa el az Alapok, a megjelenés és a Beállítások információkat, beleértve a fizetési beállításokat
Jegyek, űrlapok, kérdések, promóciós kódok létrehozása, olvasása, frissítése és törlése
Rendelések létrehozása, olvasása és frissítése
Rendelési és jegyvisszaigazoló e-mailek küldése
Jelölje meg a csekk- vagy számlárendeléseket fizetettként
A megrendelés vásárlói adatainak frissítése
Jegyek törlése és visszatérítése
Promóciós kódok létrehozása, olvasása, frissítése, törlése, szüneteltetése és folytatása
Adók létrehozása, olvasása, frissítése és törlése

Tipp: Az API-ban a kérdéseket „egyéni mezőknek” nevezik.

A helyszínen

Olvassa el és frissítse az alapokat és a helyszíni alkalmazásokkal kapcsolatos információkat

Lead visszakeresés és élő megjelenítés

Olvassa el, hogy a termék aktív-e vagy közzétette-e az Eseményen

Tudandó dolgok

Az API nem használható Esemény létrehozására vagy az Esemény bármely termékének aktiválására, például az Eseményalkalmazásban és az Onsite alkalmazásban. Mielőtt a fejlesztők módosíthatnák az Eseményt az API-val, aktiválnia kell az összes használni kívánt terméket, és ki kell töltenie mindegyikhez szükséges alapvető információkat.
Időnként kiadjuk az API új verzióit fejlesztésekkel és javításokkal. Továbbra is elég sokáig támogatjuk a régi verziókat ahhoz, hogy mindenki átválthassa az új verziót. E-mailben küldünk frissítéseket az új verziókról, a közelgő régi verziók elavulásának dátumairól és a hivatalos elavulásról.
Az API-kérelmeket mérjük és korlátozzák a visszaélések megelőzése érdekében.
A közösségek a Suite ügyfelek számára is támogatottak.

Cisco AI Assistant

Köszönjük visszajelzését.