Uvod v uporabo API-ja Webex Events

Če imate v svoji ekipi razvijalca, ki zna uporabljati API GraphQL, je API Webex Events lahko vaš prehod do zmogljivih nastavitev in avtomatizacije upravljanja dogodkov in izdelkov, integracij platform tretjih oseb, zmogljivih nadzornih plošč podatkov z več dogodki in še več.

Kaj lahko naredi Webex Events API

Preprosto povedano, API je programski vmesnik, ki ga razvijalci lahko uporabljajo za pridobivanje podatkov iz spletne platforme ali vstavljanje podatkov v spletno platformo - v tem primeru Webex Events.

Zmogljivosti API-ja je mogoče poenostaviti na štiri osnovne koncepte:

Ustvar ite nekaj, kar prej ni bilo, na primer udeleženca, sejo ali celoten dogodek.
Po sodobite vse, kar lahko ustvarite API, in še nekaj stvari. API lahko na primer uporabite za ustvarjanje novega udeleženca in nato uredite ime udeleženca, e-pošto, status, skupine, telefonske številke in socialne račune tega udeleženca.
Preberite informacije o vsem, kar lahko API uporabite za ustvarjanje ali urejanje, in o nekaterih stvareh, česar ne morete.
Izbri šite vse, kar lahko API ustvarite, z nekaterimi izjemami.

Upoštevajte te koncepte, ko berete razdelek« Delo z razvijalci »tega članka.

Kako začeti

1. Pridobite dostop do API-ja

Če ste stranka Webex Suite Enterprise Agreement (Suite EA), ki je že aktivirala Webex Events, samodejno dobite dostop do API-ja Webex Events! Za vse druge stranke se pogovorite s svojim kontaktom Webex Events ali našo ekipo za podporo, če želite izvedeti več o dostopu do API-ja.

2. Ustvarite ključ API

Zdaj morate ustvariti nov ključ API, ki ga bodo lahko uporabljali vaši razvijalci. Ko imate dostop do API-ja, se na stran« Nastavitve organizacije »na platformi Webex Events doda nov zavihek. Tukaj je opisano, kako dostopati do novega zavihka in ustvariti prvi ključ:

Upoštevajte, da lahko do strani API dostopajo samo skrbniki organizacije.

Kjerkoli na platformi Webex Events kliknite sliko profila v zgornjem desnem kotu zaslona in nato v spustnem meniju izberite Nastavitve organizacije.
Na strani z nastavitvami organizacije kliknite zavihek API v levem meniju. To vas pripelje do nadzorne plošče API-ja, kjer lahko pregledate uporabo API-ja, izvozite dnevnike uporabe, upravljate ključe in dostopate do naše dokumentacije API- ja.
Kliknite Ustvari ključ.
V modalni »Ustvari nov ključ« vnesite oznako za ključ API, ki pojasnjuje, za kaj se bo uporabljal.
V spust nem oknu različice API- ja bo že izbrana trenutna različica, zato preprosto kliknite Shrani. To razkriva ključ API.
Kliknite gumb Kopira j poleg ključa in ga prilepite v varen dokument, da zagotovite, da nikoli ne bo izgubljen.

OPOZORILO! To je edini čas, ko je mogoče dostopati do celotnega ključa API. Ko zaprete modalni modul, celotnega ključa ni mogoče ponovno prebrati.

Ko kopirate in shranite ključ, kliknite gumb Zap ri.

V večini primerov potrebujete samo en ključ API. V primerih, ko delate z več skupinami, pa boste morda želeli ustvariti ključ za vsako ekipo. Pogovorite se s svojimi razvijalci o svojih posebnih primerih uporabe, da ugotovite najboljšo rešitev.

3. Povabite razvijalce k dostopu do API-ja

Ko ustvarite prvi ključ API, se na platformi Webex Events samodejno ustvari nova ekipa API. Da bi svojim razvijalcem omogočili preizkus API-ja Webex Events, je tako preprosto, kot da jih povabite v to skupino API-ja. Upoštevajte navodila v našem članku o upravljanju ekip, članov in kreditov, če želite izvedeti, kako.

Upoštevajte, da je peskovnik API ločena različica platforme Webex Events, izdelana posebej za testiranje. To pomeni, da morajo vsi novi člani ekipe API Sandbox ustvariti nov račun platforme za uporabo peskovnika, tudi če že imajo račun platforme ali se prijavijo s SSO svoje organizacije.

Ljudje v vaši ekipi API nimajo dostopa do ostale platforme Webex Events, kot to počnejo organizatorji. Namesto tega imajo člani ekipe API dostop do »peskovnika« API-ja, kjer lahko preizkusijo, kaj gradijo, ne da bi vplivali na podatke iz resničnega sveta. Če želite, da imajo razvijalci dostop tudi do nekaterih ali vseh vaših resničnih dogodkov in aplikacij na platformi Webex Events, jih povabite k ustreznim skupinam, ki niso API-ji.

4. Bodite prijazni do svojih razvijalcev

To je ključnega pomena, zato smo naredili cel korak. 😉

»Rim ni bil zgrajen v enem dnevu«, prav tako pa ni bila dobra integracija API-ja. Bodite dober prijatelj svojim razvijalcem in jim dajte dovolj časa, da se pospešijo z API-jem Webex Events, preden pričakujete, da bodo zagotovili integracije. Hvaležni bodo, da ne bodo pod pritiskom.

Priporočamo, da začnete pogovore z razvijalci vsaj šest mesecev, preden potrebujete delovanje integracij. Nadaljujte z branjem, če želite izvedeti, kako se pripraviti na te pogovore in jih voditi.

Delo z razvijalci

Ko povabite razvijalce v svojo ekipo Webex Events Sandbox, je eno vaših prvih vprašanj morda: »Koliko časa bo trajalo za izgradnjo integracij?« Odgovor na to vprašanje je odvisen od številnih dejavnikov, vključno s številom razvijalcev, s katerimi sodelujete, koliko časa imajo za delo na integracijah, kako zapletene so integracije in še več.

Samo vaši razvijalci vam lahko povedo, kako dolgo bo trajalo nastavitev integracije, in šele po nekaj ključnih korakih:

Najprej preberite spodnje razdelke, če želite izvedeti, kaj lahko naredi API. To vam bo pomagalo razumeti, kaj je mogoče, tako da boste lahko jasno sporočili svoje potrebe s svojimi razvijalci.
Spoznajte svoje razvijalce, delite z njimi našo dokumentacijo API- ja in se pogovorite o tem, kaj želite. Dali bodo lahko osnovne povratne informacije o tem, kaj lahko in kaj ne morejo storiti za vas. Vendar vam ne bodo mogli dati določenih časovnih rokov, dokler ne bodo seznanjeni z API-jem Webex Events.
Dajte svojim razvijalcem čas, da se seznanijo z API-jem. Bodite na voljo, da odgovorite na konceptualna ali praktična vprašanja o svojih dogodkih, podatkih, platformi Webex Events in vsem drugem.

Kaj lahko naredi API

API ima dve osnovni funkciji:

Preberite - Pridobite podatke iz Webex Events, da jih lahko pregledate ali povlečete v drug sistem.
Posodobit ev — vnesite podatke v dogodke Webex, da ustvarite nove elemente ali sinhronizirate podatke, kot so udeleženci, z druge platforme. Vse, kar nekaj spremeni na platformi Webex Events, je posodobitev.

Ekipe in organizacije

Ustvarjanje, posodabljanje, branje in brisanje ekip in članov ekipe

Dogodki

Posodobi, klonira in bere. Dogodkov ni mogoče ustvariti ali izbrisati z API-jem.

Udeleženci

Ustvarjanje, posodabljanje, branje, dodeljevanje sejam, dodeljevanje skupinam in brisanje podatkov o družabnem računu (telefonska številka, upravljanje socialnih računov itd.). Udeležencev ni mogoče izbrisati, čeprav jih je mogoče blokirati.

Vprašanja

Ustvarjanje, posodabljanje, branje in brisanje

Nasvet: V API-ju se vprašanja imenujejo »polja po meri«

Skupine

Ustvarjanje, posodabljanje, branje in brisanje tako ekskluzivnih kot neekskluzivnih skupin

Seje

Ustvarjanje, posodabljanje, branje in brisanje

Lokacije

Ustvarjanje, posodabljanje, branje in brisanje

Nasvet: V API-ju se lokacije imenujejo »regije«.

Aplikacije z blagovno znamko

Preberite imena aplikacij z blagovno znamko, statuse in imena dodeljenih dogodkov

Aplikacija za dogodke

Preberite osnove, videz in Web App nastavitve ter informacije o posnetkih video centra
Ustvarite, posodobite, preberite in izbrišite naslednje funkcije aplikacije za dogodke in njihove elemente, kadar je to primerno:
- Dnevni red
- Sponzorji
- Zvočniki
- Razstavljavci
- Prenos v živo
- Udeleženci
- Seznam po meri
- Posamezni predmet
- Spletna povezava
- Spletni seznam
- Moja QR koda

Upoštevajte, da morate ročno dodati in konfigurirati vse funkcije aplikacije za dogodke, ki niso navedene zgoraj.

Nasvet: V API-ju se funkcije imenujejo »komponente«.

Registracija

Preberite informacije o osnovah, videzu in nastavitvah, vključno z nastavitvami plačila
Ustvarjanje, prebranje, posodabljanje in brisanje vstopnic, obrazcev, vprašanj, promocijskih kod
Ustvarjanje, branje in posodabljanje naročil
Pošiljanje e-poštnih sporočil o potrditvi naročila
Naročila čekov ali računov označite kot plačana
Posodobitev informacij o kupcu naročila
Preklic in vračilo vstopnic
Ustvarjanje, branje, posodabljanje, brisanje, zaustavitev in nadaljevanje promocijskih kod
Ustvarjanje, branje, posodabljanje in brisanje davkov

Nasvet: V API-ju se vprašanja imenujejo »polja po meri«.

Na kraju samem

Preberite in posodabljajte osnove in informacije o aplikacijah na kraju samem

Iskanje potencialnih strank in prikaz v živo

Preberite, ali je izdelek aktiven ali objavljen v dogodku

Stvari, ki jih je treba vedeti

API-ja ni mogoče uporabiti za ustvarjanje dogodka ali aktiviranje katerega koli izdelka v dogodku, kot sta aplikacija Dogodek in Onsite. Preden lahko razvijalci spremenijo Dogodek z API-jem, morate aktivirati vsak izdelek, ki ga nameravate uporabiti, in izpolniti osnovne zahtevane podatke za vsakega.
Občasno bomo izdali nove različice API-ja z izboljšavami in popravki. Še naprej bomo podpirali stare različice dovolj dolgo, da bodo vsi lahko prešli na novo različico. Poslali bomo posodobitve po e-pošti o novih različicah, prihajajočih datumih zastarelosti stare različice in uradnih zastarelih.
Zahteve za API so merjene in omejene, da se prepreči zloraba.
Skupnosti so podprte tudi za stranke Suite.

Cisco AI Assistant

Hvala za povratne informacije.