Tämä artikkeli on käännetty englannista konekäännöksellä.
Jos tiimissäsi on kehittäjä, joka osaa käyttää GraphQL-sovellusliittymää, Webex Events API voi olla porttisi tehokkaisiin tapahtumien ja tuotteiden määritys- ja hallintaautomaatioihin, kolmannen osapuolen alustaintegraatioihin, tehokkaisiin usean tapahtuman datan hallintapaneeleihin ja muihin. .
Mitä Webex Events API voi tehdä
Yksinkertaisesti sanottuna API on ohjelmointirajapinta, jota kehittäjät voivat käyttää saadakseen tietoja tai sijoittaakseen tietoja online-alustalle – tässä tapauksessa Webex Events.
API:n ominaisuudet voidaan yksinkertaistaa neljään peruskonseptiin:
Luo jotain, jota ei ollut aiemmin, kuten osallistuja, istunto tai koko tapahtuma.
Päivitä kaikki, mitä API voi käyttää luomiseen, sekä muutama muu asia. API:n avulla voidaan esimerkiksi luoda uusi osallistuja ja muokata sitten osallistujan nimeä, sähköpostiosoitetta, tilaa, ryhmiä, puhelinnumeroita ja sosiaalisia tilejä.
Lue tietoja kaikesta, jota API voi käyttää luomiseen tai muokkaamiseen, sekä joistakin asioista, joita se ei voi käyttää.
Poista kaikki, mitä API voi käyttää luomiseen, joitain poikkeuksia lukuun ottamatta.
Pidä nämä käsitteet mielessä, kun luet tämän artikkelin "Työskentely kehittäjien kanssa" -osiota.
Kuinka päästä alkuun
1. Hanki sovellusliittymän käyttöoikeus
Jos olet Webex Suite Enterprise -sopimuksen (Suite EA) asiakas, jolla on jo Webex Events aktivoitu, saat automaattisesti pääsyn Webex Events API:han! Kaikkien muiden asiakkaiden osalta ota yhteyttä Webex Events -yhteyshenkilöösi tai tukitiimiimme saadaksesi lisätietoja API:n käyttämisestä.
2. Luo API-avain
Nyt sinun on luotava uusi API-avain kehittäjien käytettäväksi. Kun pääset käyttämään APIa, Webex Events -alustan Organisaatioasetukset-sivulle lisätään uusi välilehti. Näin pääset uuteen välilehteen ja luot ensimmäisen avaimesi:
💡 Muista, että vain organisaation järjestelmänvalvojat pääsevät API-sivulle.
Napsauta missä tahansa Webex Events -alustassa profiilikuvaasi näytön oikeassa yläkulmassa ja valitse sitten avattavasta valikosta Organisaatioasetukset .
Napsauta Organisaatioasetukset-sivun vasemmanpuoleisessa valikossa API- välilehteä. Tämä vie sinut API-hallintapaneeliin, jossa voit tarkastella sovellusliittymän käyttöä, viedä käyttölokeja, hallita avaimia ja käyttää API-dokumentaatiota.
Napsauta Luo avain .
Kirjoita Luo uusi avain -modaaliin API-avaimen Label, joka selittää, mihin sitä käytetään.
Avattavasta API-versiovalikosta on jo valittu nykyinen versio, joten napsauta Tallenna . Tämä paljastaa API-avaimen.
Napsauta avaimen vieressä olevaa Kopioi- painiketta ja liitä avain suojattuun asiakirjaan varmistaaksesi, että se ei koskaan katoa.
⚠️ VAROITUS! Tämä on ainoa kerta, kun koko API-avainta voidaan käyttää. Kun olet sulkenut modaalin, koko avainta ei voida lukea uudelleen.
Kun olet kopioinut ja tallentanut avaimen, napsauta Sulje- painiketta.
Useimmissa tapauksissa tarvitset vain yhden API-avaimen. Kuitenkin tilanteissa, joissa työskentelet useiden tiimien kanssa, sinun kannattaa luoda avain jokaiselle tiimille. Keskustele kehittäjien kanssa erityisistä käyttötapauksistasi löytääksesi parhaan ratkaisun.
3. Kutsu kehittäjiä käyttämään sovellusliittymää
Kun luot ensimmäisen API-avaimesi, Webex Events -alustalle luodaan automaattisesti uusi API-tiimi. Webex Events -sovellusliittymän kokeiluoikeuden antaminen kehittäjillesi on yhtä helppoa kuin kutsua heidät kyseiseen API-tiimiin. Seuraa artikkelimme ohjeita tiimien, jäsenten ja hyvitysten hallinnasta saadaksesi lisätietoja.
💡 Muista, että API-hiekkalaatikko on Webex Events -alustan erillinen versio, joka on tehty erityisesti testausta varten. Tämä tarkoittaa, että kaikkien API Sandbox -tiimin uusien jäsenten on luotava uusi alustatili käyttääkseen hiekkalaatikkoa, vaikka heillä olisi jo alustatili tai he kirjautuisivat sisään organisaationsa SSO:lla.
API-tiimisi henkilöillä ei ole pääsyä muuhun Webex Events -alustaan järjestäjien tapaan. Sen sijaan API-tiimin jäsenillä on pääsy API "hiekkalaatikkoon", jossa he voivat testata rakentamaansa vaikuttamatta todelliseen dataan. Jos haluat, että kehittäjät pääsevät myös joihinkin tai kaikkiin todellisiin tapahtumiisi ja sovelluksiisi Webex Events -alustalla, kutsu heidät asiaankuuluviin ei-API-tiimeihin.
4. Valmistele tapahtuma
Koska API ei voi aktivoida mitään tapahtuman tuotteista, kuten Event App ja Onsite, sinun on aktivoitava jokainen tapahtumassasi käytettävä tuote ja täytettävä vaaditut perustiedot.
Työskentely kehittäjien kanssa
On tärkeää, että kommunikoit selkeästi kehittäjien kanssa, jotta he voivat rakentaa tarvitsemasi. Tämä tarkoittaa, että sinun on tiedettävä, mitä Webex Events -alustan osia API voi käyttää. Jatka lukemista oppiaksesi tarkalleen, mitä API voi käyttää ja hallita, sekä muutamia vinkkejä, joiden avulla voit "puhua samaa kieltä" kuin kehittäjäsi.
Kun olet perehtynyt perusominaisuuksiin, voit alkaa puhua kehittäjäsi kanssa työkalujen ja automaatioiden rakentamisesta API:n avulla.
Joukkueet ja organisaatiot
Luo, päivitä, lue ja poista ryhmiä ja tiimin jäseniä
Tapahtumat
Luo, päivitä, kloonaa ja lue. Tapahtumia ei voi poistaa.
Osallistujat
Luo, päivitä, lue, määritä istuntoihin, määritä ryhmiin ja poista sosiaalisen tilin tietoja (puhelinnumero, sosiaalisten tilien kahvat jne.). Osallistujia ei voi poistaa, vaikka heidät voidaan estää.
Kysymyksiä
Luo, päivitä, lue ja poista
Vinkki: API:ssa kysymyksiä kutsutaan "muokatuiksi kentiksi".
ryhmät
Luo, päivitä, lue ja poista sekä eksklusiivisia että ei-yksinomaisia ryhmiä
Istunnot
Luo, päivitä, lue ja poista
Sijainnit
Luo, päivitä, lue ja poista
Vinkki: API:ssa sijainteja kutsutaan "alueiksi".
Branded Apps
Lue Branded App nimet, tilat ja määritettyjen tapahtumien nimet
Event App
Lue perus-, ulkoasu- ja verkkosovellusasetukset sekä Video Center tallenteiden tiedot
Luo, päivitä, lue ja poista seuraavat Event App -ominaisuudet ja niiden kohteet soveltuvin osin:
Agenda
Sponsorit
Kaiuttimet
Näytteilleasettajat
Suora lähetys
Osallistujat
Mukautettu luettelo
Yksittäinen kohde
Nettilinkki
Verkkoluettelo
Minun QR-koodini
💡 Muista, että sinun on lisättävä ja määritettävä manuaalisesti kaikki Event App -ominaisuudet, joita ei ole lueteltu yllä.
Vinkki: API:ssa ominaisuuksia kutsutaan "komponenteiksi".
Rekisteröinti
Lue perustiedot, ulkoasu ja asetukset, mukaan lukien kassaasetukset
Luo, lue, päivitä ja poista lippuja, lomakkeita, kysymyksiä, tarjouskoodeja
Luo, lue ja päivitä tilauksia
Lähetä tilaus- ja lippuvahvistussähköpostit
Merkitse sekki- tai laskutilaukset maksetuiksi
Päivitä tilauksen ostajan tiedot
Peruuta ja hyvitä liput
Luo, lue, päivitä, poista, keskeytä ja jatka tarjouskoodeja
Luo, lue, päivitä ja poista veroja
Vinkki: API:ssa kysymyksiä kutsutaan "muokatuiksi kentiksi".
Onsite
Lue ja päivitä perustiedot ja Onsite App -tiedot
Lead Retrieval ja Live Display
Lue, onko tuote aktiivinen vai julkaistu Tapahtumassa
Asiat tietää
Julkaisemme ajoittain uusia API-versioita parannuksilla ja korjauksilla. Jatkamme vanhojen versioiden tukemista riittävän kauan, jotta kaikki voivat siirtyä uuteen versioon. Lähetämme sähköpostipäivityksiä uusista versioista, tulevista vanhojen versioiden poistumispäivistä ja virallisista poistoista.
API-pyynnöt mitataan ja rajoitetaan väärinkäytösten estämiseksi.
Yhteisöt ovat myös tuettuja Suite-asiakkaille.