Ugrás a fő tartalomra
Minden kollekcióIntegrációk és partnerségek
Első lépések a Webex Events API-val
Első lépések a Webex Events API-val

Mit csinál az API, és hogyan kezdje el

Daniel Murphey avatar
Írta: Daniel Murphey
Több mint 5 hónappal ezelőtt frissítve

Ezt a cikket angolról gépi fordítással fordították le.

Ha van egy fejlesztő a csapatában, aki tudja, hogyan kell használni a GraphQL API-t, a Webex Events API átjárója lehet a hatékony esemény- és termékbeállítási és -kezelési automatizálásoknak, harmadik féltől származó platformintegrációknak, hatékony többesemény-adat-irányítópultoknak és sok másnak. .

Mire képes a Webex Events API

Leegyszerűsítve, az API egy programozási felület, amelyet a fejlesztők használhatnak adatok beszerzésére vagy adatok elhelyezésére egy online platformról – jelen esetben a Webex Events.

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.

  • Frissítsen bármit, amit az API létrehozhat, valamint még néhány dolgot. Az API-val például új résztvevőt hozhat létre, majd szerkesztheti a résztvevő nevét, e-mail-címét, állapotát, csoportjait, telefonszámait és közösségi fiókjait.

  • Olvasson információkat mindenről, amit az API létrehozhat vagy szerkeszthet, valamint néhány olyan dologról, amelyet nem.

  • Néhány kivételtől eltekintve töröljön mindent, amit az API létrehozhat.

Tartsa szem előtt ezeket a fogalmakat, miközben elolvassa a cikk „Munka a fejlesztőkkel” című részét.

Hogy kezdjed

1. Szerezzen hozzáférést az API-hoz

Ha Ön Webex Suite Enterprise Agreement (Suite EA) ügyfél, aki már aktiválta a Webex Events szolgáltatást, automatikusan hozzáférést kap a Webex Events API-hoz! Az összes többi ügyfél esetében forduljon a Webex Events kapcsolattartójához vagy ügyfélszolgálati csapatunkhoz, hogy tájékozódjon az API eléréséről.

2. Hozzon létre egy API-kulcsot

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

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

  1. A Webex Events platform bármely részén 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ő menüből.

  2. A Szervezeti beállítások oldalon kattintson az API fülre a bal oldali menüben. Ezzel az API irányítópultjára jut, ahol áttekintheti az API-használatot, exportálhatja a használati naplókat, kezelheti a kulcsokat, és hozzáférhet API-dokumentációinkhoz.

  3. Kattintson a Kulcs létrehozása elemre .

  4. Az „Új kulcs létrehozása” módban adjon meg egy címkét az API-kulcshoz, amely elmagyarázza, hogy mire fogja használni.

  5. Az API verzió legördülő menüjében már az aktuális verzió van kiválasztva, ezért egyszerűen kattintson a Mentés gombra . Ez felfedi az API kulcsot.

  6. Kattintson a kulcs melletti Másolás gombra, és illessze be a kulcsot egy biztonságos dokumentumba, hogy soha ne vesszen el.

    ⚠️ FIGYELEM! Ez az egyetlen alkalom, amikor a teljes API-kulcs elérhető. A modális bezárása után a teljes kulcs nem olvasható újra.

  7. A kulcs 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 lehet létrehozni egy kulcsot minden csapat számára. Beszéljen fejlesztőivel az Ön konkrét felhasználási eseteiről, hogy megtalálja a legjobb megoldást.

3. Hívja meg a fejlesztőket az API-hoz való hozzáférésre

Amikor létrehozza az első API-kulcsot, automatikusan létrejön egy új API-csapat a Webex Events platformon. Hozzáférést adni a fejlesztőknek a Webex Events API kipróbálásához olyan egyszerű, mint meghívni őket az API-csapatba. Kövesse a csapatok, tagok és kreditek kezeléséről szóló cikkünkben található utasításokat, hogy megtudja, hogyan.

💡 Ne feledje, az API sandbox a Webex Events platform különálló verziója, amelyet kifejezetten tesztelésre készítettek. Ez azt jelenti, hogy az API Sandbox csapatának 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 szervezete egyszeri bejelentkezésével.

Az API-csapat tagjai nem férhetnek hozzá a Webex Events platform többi részéhez, ahogyan a szervezők teszik. Ehelyett az API-csapat tagjai hozzáférhetnek egy API „sandboxhoz”, ahol a valós adatok befolyásolása nélkül tesztelhetik, amit építenek. Ha azt szeretné, hogy a fejlesztők is hozzáférjenek néhány vagy az összes valós eseményhez és alkalmazáshoz a Webex Events platformon, hívja meg őket a megfelelő nem API-csapatokba.

4. Esemény előkészítése

Mivel az API nem tudja aktiválni az Esemény egyik termékét sem, például az Event App és a Onsite, aktiválnia kell minden terméket, amelyet az Eseményében használni kíván, és megadja az alapvető szükséges információkat.

Együttműködés a fejlesztőkkel

Fontos, hogy egyértelműen kommunikáljon a fejlesztőivel, hogy elkészíthessék, amire szüksége van. Ez azt jelenti, hogy tudnia kell, hogy a Webex Events platform mely részeihez férhet hozzá az API. Olvassa tovább, hogy megtudja, pontosan mit férhet hozzá és vezérelhet az API, valamint néhány tippet, amelyek segítségével „ugyanazt a nyelvet beszélheti”, mint a fejlesztő.

Ha már ismeri az alapvető képességeket, elkezdhet beszélni a fejlesztővel az API-val történő eszközök és automatizálások kiépítéséről.

Csapatok és szervezetek

  • Hozzon létre, frissítsen, olvasson és töröljön csapatokat és csapattagokat

Események

  • Hozzon létre, frissítsen, klónozzon és olvasson. Az események nem törölhetők.

Résztvevők

  • Létrehozhat, frissíthet, olvashat, munkamenetekhez hozzárendelhet, csoportokhoz rendelhet, és törölheti a közösségi fiók adatait (telefonszám, közösségi fiók kezelõi stb.). A résztvevők nem törölhetők, de letilthatók.

Kérdések

  • Hozzon létre, frissítsen, olvasson és töröljön

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

Csoportok

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

Munkamenetek

  • Hozzon létre, frissítsen, olvasson és töröljön

Helyszínek

  • Hozzon létre, frissítsen, olvasson és töröljön

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

Branded Apps

  • Olvassa el a Branded App neveit, állapotait és a hozzárendelt események nevét

Event App

  • Olvassa el az alapokat, a megjelenést és a webalkalmazás beállításait, valamint a Video Center Recordings-információit

  • Létrehozhatja, frissítheti, olvassa és törölje az Event App következő funkcióit és elemeiket, ahol alkalmazható:

    • Napirend

    • Szponzorok

    • Hangszórók

    • Kiállítók

    • Élő adás

    • Résztvevők

    • Egyéni lista

    • Egyetlen tétel

    • Web Link

    • Web lista

    • Az én QR kódom

💡 Ne feledje, hogy manuálisan kell hozzáadnia és konfigurálnia az Event App összes fent felsorolt ​​funkcióját.

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

Bejegyzés

  • Olvassa el az alapokkal, a megjelenéssel és a beállításokkal kapcsolatos információkat, beleértve a fizetési beállításokat is

  • 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ést és jegyet megerősítő e-mailt küld

  • A csekk- vagy számlarendeléseket kifizetettként jelölje meg

  • Frissítse a megrendelő vásárlói adatait

  • 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.

Onsite

  • Olvassa el és frissítse az alapok és a Onsite App információit

Lead Retrieval és Live Display

  • Olvassa el, hogy a termék aktív-e, vagy megjelent-e az Eseményben

Tudnivalók

  • Időnként kiadjuk az API új verzióit fejlesztésekkel és javításokkal. Továbbra is támogatjuk a régi verziókat addig, amíg mindenki át tudja állítani az új verziót. Frissítéseket küldünk e-mailben az új verziókról, a közelgő régi verziók megszűnési dátumairól és a hivatalos megszüntetésről.

  • Az API-kéréseket mérik és korlátozzák a visszaélések megelőzése érdekében.

  • A közösségek a Suite ügyfelei számára is támogatottak.

Választ kapott a kérdésére?