Webex Events -sovellusliittymän käytön aloittaminen
list-menuOnko sinulla palautetta?
Mitä API tekee ja miten pääset alkuun

Jos tiimissäsi on kehittäjä, joka osaa käyttää GraphQL-sovellusliittymää, Webex Events -sovellusliittymä voi olla yhdyskäytäväsi tehokkaisiin tapahtumien ja tuotteiden määritys- ja hallintaautomatisointeihin, kolmannen osapuolen alustojen integraatioihin, tehokkaisiin monen tapahtuman tietojen hallintapaneeleihin ja muihin.

Mitä Webex Events -sovellusliittymä voi tehdä

Yksinkertaisesti sanottuna sovellusliittymä on ohjelmointirajapinta, jonka avulla kehittäjät voivat saada tietoja online-alustalta tai laittaa tietoja verkkoalustalle - tässä tapauksessa Webex Events.

API: n ominaisuuksia voidaan yksinkertaistaa neljään peruskäsitteeseen:

  • Luo jotain, jota ei ollut aiemmin olemassa, kuten osallistuja, istunto tai koko tapahtuma.

  • Päiv itä kaikki, mitä sovellusliittymää voidaan käyttää luomiseen, sekä muutama muu asia. Sovellusliittymällä voidaan esimerkiksi luoda uusi osallistuja ja muokata osallistujan nimeä, sähköpostiosoitetta, tilaa, ryhmiä, puhelinnumeroita ja sosiaalisia tilejä.

  • Lue tietoja kaikesta, mitä sovellusliittymää voidaan käyttää luomaan tai muokkaamaan, sekä joistakin asioista, joita se ei voi käyttää.

  • Poista kaikki, mitä sovellusliittymää voidaan käyttää luomaan, joitain poikkeuksia lukuun ottamatta.

Pidä nämä käsitteet mielessä, kun luet tämän artikkelin ”Yhteistyö kehittäjien kanssa” -osaa.

Näin pääset alkuun

1. Pääset käyttämään sovellusliittymää

Jos olet Webex Suite Enterprise Agreement (Suite EA) -asiakas, jonka Webex Events on jo aktivoitu, saat automaattisesti pääsyn Webex Events -sovellusliittymään! Kaikille muille asiakkaille ota yhteyttä Webex Events -yhteyshenkilösi tai tukitiimimme kanssa saadaksesi lisätietoja sovellusliittymän käyttämisestä.

2. Luo API-avain

Nyt sinun on luotava uusi API-avain, jota kehittäjät voivat käyttää. Kun sinulla on pääsy sovellusliittymään, uusi välilehti lisätään Webex Events -alustan ”Organisaation asetukset” -sivulle. Näin pääset uuteen välilehteen ja luot ensimmäisen avaimen:

Muista, että vain organisaation järjestelmänvalvojat voivat käyttää API-sivua.

  1. Napsauta missä tahansa Webex Events -alustassa profiilikuvaasi näytön oikeassa yläkulmassa ja valitse sitten avattavasta valiko sta Organisaatioasetukset.

  2. Napsauta Organisaatioasetukset-sivulla vasemmanpuoleisen valikon API- välilehteä. Tämä vie sinut sovellusliittymän hallintapaneeliin, jossa voit tarkastella sovellusliittymän käyttöä, viedä käyttölokeja, hallita avaimia ja käyttää API-dokumentaatioamme.

  3. Valitse Luo avain.

  4. Kirjoita ”Luo uusi avain” -moduuliin API-avaimen tarra, joka selittää, mihin sitä käytetään.

  5. API-version pudo tusvalikosta on jo valittu nykyinen versio, joten napsauta vain Tallenna. Tämä paljastaa API-avaimen.

  6. Napsauta avaimen vieressä olevaa Kop ioi-painiketta ja liitä avain suojattuun asiakirjaan varmistaaksesi, että se ei koskaan kadota.

VAROITUS! Tämä on ainoa kerta, kun koko API-avain on käytettävissä. Kun olet sulkenut modaalin, koko näppäintä ei voi lukea uudelleen.

  1. Kun olet kopioinut ja tallentanut avaimen, napsauta Sulje -painiketta.

Useimmissa tapauksissa tarvitset vain yhden API-avaimen. Jos kuitenkin työskentelet useiden ryhmien kanssa, sinun kannattaa luoda avain kullekin tiimille. Keskustele kehittäjien kanssa erityisistä käyttötapauksistasi parhaan ratkaisun selvittämiseksi.

3. Kutsu kehittäjiä käyttämään sovellusliittymää

Kun luot ensimmäisen API-avaimen, uusi API-tiimi luodaan automaattisesti Webex Events -alustalle. Kehittäjille mahdollisuus kokeilla Webex Events -sovellusliittymää on yhtä helppoa kuin kutsua heidät kyseiseen API-tiimiin. Noudata tiimien, jäsenten ja opintopisteiden hallintaa koskevia artikkelissamme olevia ohjeita oppiaksesi miten.

Muista, että API-hiekkalaatikko on erillinen versio Webex Events -alustasta, joka on tehty erityisesti testausta varten. Tämä tarkoittaa, että kaikkien API Sandbox -tiimin uusien jäsenten on luotava uusi alustatili hiekkalaatikon käyttämiseksi, vaikka heillä olisi jo alustatili tai he olisivat kirjautuneet 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 sovellusliittymän ”hiekkalaatikkoon”, jossa he voivat testata rakentamaansa vaikuttamatta reaalimaailman tietoihin. Jos haluat kehittäjien pääsevän myös joihinkin tai kaikkiin todellisiin tapahtumiin ja sovelluksiin Webex Events -alustalla, kutsu heidät asiaankuuluviin ei-API-tiimeihin.

4. Ole ystävällinen kehittäjille

Tämä on ratkaisevan tärkeää, joten teimme siitä kokonaisen askeleen. 😉

”Roomaa ei rakennettu päivässä”, eikä myöskään ollut hyvä API-integraatio. Ole hyvä ystävä kehittäjille ja anna heille runsaasti aikaa tutustua Webex Events -sovellusliittymään ennen kuin odotat heidän toimittavan integraatioita. He ovat kiitollisia siitä, ettei heitä painosteta.

Suosittelemme keskustelujen aloittamista kehittäjien kanssa vähintään kuusi kuukautta ennen kuin tarvitset integraatioiden toimimista. Jatka lukemista oppiaksesi valmistautumaan näihin keskusteluihin ja käymään niitä.

Yhteistyö kehittäjien kanssa

Kun olet kutsunut kehittäjät Webex Events Sandbox -tiimiin, yksi ensimmäisistä kysymyksistäsi voi olla ”Kuinka kauan integraatioiden rakentaminen kestää?” Tähän kysymykseen vastaaminen riippuu monista tekijöistä, kuten siitä, kuinka monen kehittäjän kanssa työskentelet, kuinka paljon aikaa heillä on työskennellä integraatioiden parissa, kuinka monimutkaisia integraatiot ovat ja paljon muuta.

Vain kehittäjät voivat kertoa sinulle, kuinka kauan integraation käyttöönotto kestää, ja vasta muutaman tärkeän vaiheen jälkeen:

  1. Lue ensin alla olevat kohdat oppiaksesi, mitä sovellusliittymä voi tehdä. Tämä auttaa sinua ymmärtämään, mikä on mahdollista, jotta voit kommunikoida tarpeistasi selkeästi kehittäjillesi.

  2. Tapaa kehittäjiäsi, jaa API-dokumentaati omme heidän kanssaan, ja keskustele haluamastasi. He voivat antaa peruspalautetta siitä, mitä he voivat ja eivät voi tehdä puolestasi. He eivät kuitenkaan voi antaa sinulle tiettyjä aikatauluja, ennen kuin he tuntevat Webex Events -sovellusliittymän.

  3. Anna kehittäjille aikaa tutustua sovellusliittymään. Ole käytettävissä vastaamaan käsitteellisiin tai käytännön kysymyksiin tapahtumistasi, tiedoistasi, Webex Events -alustasta ja kaikesta muusta.

Mitä API voi tehdä

API:lla on kaksi perustoimintoa:

  • Lue - Hae tietoja Webex Events -tapahtumista, jotta voit tutkia niitä tai vetää ne toiseen järjestelmään.

  • Päivitys - Lisää tietoja Webex Events -tapahtumiin luodaksesi uusia kohteita tai synkronoidaksesi tietoja, kuten osallistujia, toisesta alustasta. Kaikki, mikä muuttaa jotain Webex Events -alustassa, on päivitys.

Tiimit ja organisaatiot

  • Luo, päivitä, lue ja poista tiimejä ja tiimin jäseniä

Tapahtumat

  • Päivitä, kloonaa ja lue. Tapahtumia ei voi luoda tai poistaa sovellusliittymällä.

Osallistujat

  • Luo, päivitä, lue, määritä istuntoja, määritä ryhmille ja poista sosiaalisen median tilitietoja (puhelinnumero, sosiaalisen median tilien kahvat jne.). Osallistujia ei voi poistaa, vaikka heidät voidaan estää.

Kysymyksiä

  • Luo, päivitä, lue ja poista

Vihje: Sovellusliittymässä kysymyksiä kutsutaan ”mukautetuiksi kentiksi”

Ryhmät

  • Luo, päivitä, lue ja poista sekä yksinomaisia että ei-yksinomaisia ryhmiä

Istunnot

  • Luo, päivitä, lue ja poista

Sijainnit

  • Luo, päivitä, lue ja poista

Vihje: Sovellusliittymässä sijainteja kutsutaan ”alueiksi”.

Tuotemerkkisovellukset

  • Lue tuotemerkkisten sovellusten nimet, tilat ja määritettyjen tapahtumien nimet

Tapahtumasovellus

  • Lue perusteet, ulkoasu ja Web App asetukset sekä Video Center Recording -tiedot

  • Luo, päivitä, lue ja poista seuraavat Tapahtumasovelluksen ominaisuudet ja niiden kohteet tarvittaessa:

    • Esityslista

    • Sponsorit

    • Kaiuttimet

    • Näytteilleasettajat

    • Suoratoisto

    • Osallistujat

    • Mukautettu luettelo

    • Yksittäinen tuote

    • Web-linkki

    • Verkkoluettelo

    • Oma QR-koodi

Muista, että sinun on lisättävä ja määritettävä manuaalisesti kaikki tapahtumasovelluksen ominaisuudet, joita ei ole lueteltu yllä.

Vihje: Sovellusliittymässä ominaisuuksia kutsutaan ”komponenteiksi”.

Rekisteröityminen

  • Lue perusteet-, ulkoasu- ja asetustiedot, mukaan lukien kassan asetukset

  • Luo, lue, päivitä ja poista lippuja, lomakkeita, kysymyksiä ja tarjouskoodeja

  • Luo, lue ja päivitä tilauksia

  • Lähetä tilaus- ja lippunvahvistussä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

  • Verojen luominen, lukeminen, päivittäminen ja poistaminen

Vihje: Sovellusliittymässä kysymyksiä kutsutaan ”mukautetuiksi kentiksi”.

Paikan päällä

  • Lue ja päivitä perusteet ja paikan päällä -sovelluksen tiedot

Liidien haku ja live-näyttö

  • Lue, onko tuote aktiivinen vai julkaistu Tapahtumassa

Asiat, jotka on tiedettävä

  • Ohjelmointirajapintaa ei voi käyttää tapahtuman luomiseen tai tapahtuman tuotteiden aktivointiin, kuten Tapahtumasovellusta ja Onsite-sovelluksesta. Ennen kuin kehittäjät voivat muokata tapahtumaa sovellusliittymällä, sinun on aktivoitava jokainen tuote, jota aiot käyttää, ja täytettävä jokaiselle vaaditut perustiedot.

  • Julkaisemme ajoittain uusia sovellusliittymän 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 vanhentumispäivistä ja virallisista vanhentumispäivistä.

  • API-pyynnöt mitataan ja rajoitetaan väärinkäytön estämiseksi.

  • Yhteisöjä tuetaan myös Suite-asiakkaille.

Oliko tästä artikkelista apua?
Oliko tästä artikkelista apua?