Prvi koraci s Webex Events-API-jem

Ako u svom timu imate programera koji zna koristiti GraphQL API, Webex Events API mogao bi biti vaš pristup moćnim automatizacijama postavljanja i upravljanja događajima i proizvodima, integracijama platformi trećih strana, moćnim nadzornim pločama podataka s više događaja i još mnogo toga.

Što Webex Events API može učiniti

Jednostavno rečeno, API je programsko sučelje koje programeri mogu koristiti za dobivanje podataka ili stavljanje podataka na internetsku platformu - u ovom slučaju Webex Events.

Mogućnosti API-ja mogu se pojednostaviti na četiri osnovna koncepta:

St vorite nešto što prije nije postojalo, poput sudionika, sesije ili cijelog događaja.
A žurirajte sve što se API može koristiti za izradu, plus još nekoliko stvari. Na primjer, API se može koristiti za stvaranje novog sudionika, a zatim uređivanje imena, e-pošte, statusa, grupa, telefonskih brojeva i društvenih računa tog sudionika.
Pročitajte informacije o bilo čemu što se API može koristiti za izradu ili uređivanje, plus neke stvari koje ne mogu.
Izbri šite sve što se API može koristiti za izradu, uz neke iznimke.

Imajte na umu ove koncepte dok čitate odjeljak "Rad s programerima" ovog članka.

Kako započeti

1. Pristupite API-ju

Ako ste korisnik Webex Suite Enterprise Agreement (Suite EA) koji već ima aktivirane Webex Events, automatski dobivate pristup Webex Events API-ju! Za sve ostale kupce razgovarajte sa svojim Webex Events kontaktom ili našim timom za podršku kako biste saznali više o pristupu API-ju.

2. Stvorite API ključ

Sada morate stvoriti novi API ključ koji će koristiti vaši programeri. Kada imate pristup API-ju, nova kartica dodaje se na stranicu 'Postavke organizacije' na platformi Webex Events. Evo kako pristupiti novoj kartici i stvoriti svoj prvi ključ:

Imajte na umu da samo administratori organizacije mogu pristupiti API stranici.

S bilo kojeg mjesta na platformi Webex Events kliknite sliku profila u gornjem desnom kutu zaslona, a zatim s padajućeg izbornika odaberite Postavke organizacije.
Na stranici Org postavki kliknite karticu API u lijevom izborniku. Ovo vas vodi do nadzorne ploče API-ja gdje možete pregledati upotrebu API-ja, izvesti zapisnike upotrebe, upravljati ključevima i pristupiti našoj API dokumentaciji.
Kliknite St vori ključ.
U modalu 'Stvori novi ključ' unesite oznaku za API ključ koja objašnjava za što će se koristiti.
Padaju ća verzija API- ja već će imati odabranu trenutnu verziju, pa jednostavno kliknite S premi. Ovo otkriva API ključ.
Kliknite gumb Kopira j pored ključa i zalijepite ključ u siguran dokument kako biste bili sigurni da nikada nije izgubljen.

UPOZORENJE! Ovo je jedini put da se može pristupiti cijelom API ključu. Nakon što zatvorite modal, puni ključ se ne može ponovno pročitati.

Nakon što ste kopirali i spremili ključ, kliknite gumb Zat vori.

U većini slučajeva potreban vam je samo jedan API ključ. Međutim, u situacijama kada radite s više timova, možda ćete htjeti stvoriti ključ za svaki tim. Razgovarajte sa svojim programerima o svojim specifičnim slučajevima upotrebe kako biste pronašli najbolje rješenje.

3. Pozovite programere da pristupe API-ju

Kada kreirate svoj prvi API ključ, automatski se stvara novi API tim na platformi Webex Events. Davanje pristupa programerima da isprobaju Webex Events API jednostavno je kao i pozivanje u taj API tim. Slijedite upute u našem članku o upravljanju timovima, članovima i kreditima kako biste saznali kako.

Imajte na umu da je API sandbox zasebna verzija platforme Webex Events izrađena posebno za testiranje. To znači da svi novi članovi tima API Sandbox moraju stvoriti novi račun platforme za korištenje sandboxa, čak i ako već imaju račun platforme ili se prijavljuju s SSO-om svoje organizacije.

Ljudi u vašem API timu nemaju pristup ostatku platforme Webex Events na način na koji to čine organizatori. Umjesto toga, članovi API-ja tima imaju pristup API-ju "sandboxu" gdje mogu testirati ono što grade bez utjecaja na podatke iz stvarnog svijeta. Ako želite da programeri također imaju pristup nekim ili svim vašim stvarnim događajima i aplikacijama na platformi Webex Events, pozovite ih u relevantne timove koji nisu API.

4. Budite ljubazni prema svojim programerima

Ovo je presudno, pa smo napravili cijeli korak. 😉

"Rim nije izgrađen u jednom danu", a nije bila ni dobra integracija API-ja. Budite dobar prijatelj svojim programerima i dajte im dovoljno vremena da ubrzaju Webex Events API prije nego što očekujete da će isporučiti integracije. Bit će zahvalni što ne budu pod pritiskom.

Najmanje preporučujemo da započnete razgovore sa svojim programerima najmanje šest mjeseci prije nego što vam zatrebaju integracije. Nastavite čitati kako biste naučili kako se pripremiti i voditi te razgovore.

Rad s programerima

Nakon što ste pozvali programere u svoj Webex Events Sandbox tim, jedno od vaših prvih pitanja može biti: "Koliko će vremena trebati za izgradnju integracija?" Odgovor na ovo pitanje ovisi o mnogim čimbenicima, uključujući s koliko programera radite, koliko vremena imaju za rad na integracijama, koliko su integracije složene i još mnogo toga.

Samo vaši programeri mogu vam reći koliko će vremena trebati za postavljanje integracije i to tek nakon nekoliko ključnih koraka:

Prvo pročitajte odjeljke u nastavku da biste saznali što API može učiniti. To će vam pomoći da shvatite što je moguće kako biste jasno komunicirali svoje potrebe sa svojim programerima.
Upoznajte se sa svojim programerima, podijelite s njima našu API dokument aciju i razgovarajte o tome što želite. Oni će moći dati osnovne povratne informacije o tome što mogu, a što ne mogu učiniti za vas. Međutim, neće vam moći dati određene vremenske rokove dok ne budu upoznati s Webex Events API-jem.
Dajte svojim programerima vremena da se upoznaju s API-jem. Budite dostupni da odgovorite na konceptualna ili praktična pitanja o svojim događajima, podacima, platformi Webex Events i bilo čemu drugom.

Što API može učiniti

API ima dvije osnovne funkcije:

Pročitajte - Nabavite podatke iz Webex događaja kako biste ih mogli pregledati ili povući u drugi sustav.
Ažuriranje - Unesite podatke u Webex događaje kako biste stvorili nove stavke ili sinkronizirali podatke, poput sudionika, s druge platforme. Sve što nešto promijeni na platformi Webex Events je ažuriranje.

Timovi i organizacije

Stvaranje, ažuriranje, čitanje i brisanje timova i članova tima

Događaji

Ažurirajte, klonirate i čitajte. Događaji se ne mogu kreirati ili izbrisati pomoću API-ja.

Sudionici

Stvorite, ažurirajte, čitajte, dodijelite sesijama, dodijelite grupama i brišite podatke o društvenom računu (telefonski broj, rukovanje društvenim računima itd.). Sudionici se ne mogu izbrisati, iako se mogu blokirati.

Pitanja

Stvaranje, ažuriranje, čitanje i brisanje

Savjet: U API-ju se pitanja nazivaju "prilagođena polja"

Grupe

Stvaranje, ažuriranje, čitanje i brisanje ekskluzivnih i neekskluzivnih grupa

Sjednice

Stvaranje, ažuriranje, čitanje i brisanje

Lokacije

Stvaranje, ažuriranje, čitanje i brisanje

Savjet: U API-ju lokacije se nazivaju "regije".

Brendirane aplikacije

Pročitajte imena brendiranih aplikacija, statuse i nazive dodijeljenih događaja

Aplikacija za događaje

Pročitajte osnove, izgled i Web App postavke te informacije o snimkama video centra
Stvorite, ažurirajte, pročitajte i brišite sljedeće značajke aplikacije za događaje i njihove stavke, gdje je primjenjivo:
- Dnevni red
- Sponzori
- Zvučnici
- Izlagači
- Prijenos uživo
- Sudionici
- Prilagođeni popis
- Pojedinačna stavka
- Veb veza
- Web lista
- Moj QR kod

Imajte na umu da morate ručno dodati i konfigurirati sve značajke aplikacije za događaje koje nisu gore navedene.

Savjet: U API-ju se značajke nazivaju "komponente".

Registracija

Pročitajte informacije o osnovama, izgledu i postavkama, uključujući postavke plaćanja
Stvaranje, čitanje, ažuriranje i brisanje ulaznica, obrazaca, pitanja, promotivnih kodova
Stvaranje, čitanje i ažuriranje narudžbi
Pošaljite e-poruke s potvrdom narudžbe i ulaznica
Označite narudžbe čekova ili fakture kao plaćene
Ažurirajte podatke o kupcu narudžbe
Otkazivanje i povrat ulaznica
Stvaranje, čitanje, ažuriranje, brisanje, pauziranje i nastavak promotivnih kodova
Stvaranje, čitanje, ažuriranje i brisanje poreza

Savjet: U API-ju pitanja se nazivaju "prilagođena polja".

Na licu mjesta

Pročitajte i ažurirajte osnove i informacije o aplikaciji na licu mjesta

Preuzimanje potencijalnih klijenata i prikaz uživo

Pročitajte je li proizvod aktivan ili objavljen u Događaju

Stvari koje treba znati

API se ne može koristiti za stvaranje događaja ili aktiviranje bilo kojeg proizvoda u događaju, kao što su aplikacija za događaj i na licu mjesta. Prije nego što programeri mogu izmijeniti događaj pomoću API-ja, morate aktivirati svaki proizvod koji namjeravate koristiti i ispuniti osnovne potrebne podatke za svaki od njih.
Povremeno ćemo objavljivati nove verzije API-ja s poboljšanjima i popravcima. Nastavit ćemo podržavati stare verzije dovoljno dugo da svi mogu preći na novu verziju. Poslat ćemo ažuriranja putem e-pošte o novim verzijama, nadolazećim datumima zastarivanja starih verzija i službenim zastarjelima.
API zahtjevi su mjereni i ograničeni kako bi se spriječila zlouporaba.
Zajednice su također podržane za korisnike Suite.

Cisco AI Assistant

Hvala na povratnim informacijama.