Ovaj je članak preveden s engleskog pomoću strojnog prijevoda.
Ako u svom timu imate programera koji zna kako 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 više .
Što Webex Events API može
Pojednostavljeno rečeno, API je programsko sučelje koje programeri mogu koristiti za dobivanje podataka ili za stavljanje podataka u online platformu — u ovom slučaju, Webex Events.
Mogućnosti API-ja mogu se pojednostaviti u četiri osnovna koncepta:
Stvorite nešto što prije nije postojalo, poput sudionika, sesije ili cijelog događaja.
Ažurirajte sve što se API može koristiti za stvaranje, plus još nekoliko stvari. Na primjer, API se može koristiti za stvaranje novog sudionika, a zatim za uređivanje imena, e-pošte, statusa, grupa, telefonskih brojeva i društvenih računa tog sudionika.
Pročitajte informacije o svemu što API može koristiti za stvaranje ili uređivanje, plus neke stvari koje ne može.
Izbrišite sve što se API može koristiti za stvaranje, uz neke iznimke.
Imajte na umu ove koncepte dok čitate odjeljak 'Rad s programerima' u ovom članku.
Kako započeti
1. Dobijte pristup API-ju
Ako ste klijent Webex Suite Enterprise Agreement (Suite EA) koji već ima aktiviran Webex Events , automatski dobivate pristup Webex Events API-ju! Za sve ostale kupce, razgovarajte sa svojim kontaktom za Webex Events ili našim timom za podršku kako biste saznali više o pristupu API-ju.
2. Stvorite API ključ
Sada morate izraditi novi API ključ koji će vaši programeri koristiti. Kada imate pristup API-ju, na stranicu 'Postavke organizacije' na platformi Webex Events dodaje se nova kartica. Evo kako pristupiti novoj kartici i izraditi svoj prvi ključ:
💡 Imajte na umu da samo administratori organizacije mogu pristupiti API stranici.
S bilo kojeg mjesta na platformi Webex Events kliknite svoju profilnu sliku u gornjem desnom kutu zaslona, a zatim s padajućeg izbornika odaberite Postavke organizacije .
Na stranici s postavkama organizacije kliknite karticu API u lijevom izborniku. Ovo vas vodi do nadzorne ploče API-ja gdje možete pregledati korištenje API-ja, izvesti zapisnike korištenja, upravljati ključevima i pristupiti našoj dokumentaciji API-ja.
Kliknite Stvori ključ .
U modal "Stvori novi ključ" unesite oznaku za API ključ koji objašnjava za što će se koristiti.
Na padajućem izborniku API verzija već će biti odabrana trenutna verzija, pa jednostavno kliknite Spremi . Ovo otkriva API ključ.
Kliknite gumb Kopiraj pored ključa i zalijepite ključ u siguran dokument kako se nikada ne bi izgubio.
⚠️ UPOZORENJE! Ovo je jedini put kada se može pristupiti punom 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 Zatvori .
U većini slučajeva potreban vam je samo jedan API ključ. Međutim, u situacijama kada radite s više timova, možda biste trebali izraditi ključ za svaki tim. Razgovarajte sa svojim programerima o vašim specifičnim slučajevima upotrebe kako biste pronašli najbolje rješenje.
3. Pozovite programere da pristupe API-ju
Kada izradite svoj prvi API ključ, novi API tim automatski se stvara na platformi Webex Events . Omogućiti svojim programerima pristup da isprobaju Webex Events API jednostavno je kao pozvati ih u taj API tim. Slijedite upute u našem članku o upravljanju timovima, članovima i kreditima da biste saznali kako.
💡 Imajte na umu da je API sandbox zasebna verzija platforme Webex Events napravljena posebno za testiranje. To znači da svi novi članovi API Sandbox tima moraju stvoriti novi račun platforme za korištenje sandboxa, čak i ako već imaju račun platforme ili se prijavljuju pomoću SSO-a svoje organizacije.
Ljudi u vašem API timu nemaju pristup ostatku platforme Webex Events na način na koji to imaju organizatori. Umjesto toga, članovi API tima imaju pristup API "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 povezani s API-jem.
4. Pripremite događaj
Budući da API ne može aktivirati niti jedan proizvod u događaju, kao što su Event App i Onsite, morate aktivirati svaki proizvod koji namjeravate koristiti u svom događaju, ispunjavajući osnovne potrebne informacije.
Rad s programerima
Za vas je važno da jasno komunicirate sa svojim programerima kako bi mogli izgraditi ono što vam je potrebno. To znači da trebate znati kojim dijelovima platforme Webex Events API može pristupiti. Nastavite čitati kako biste saznali čemu točno API može pristupiti i kontrolirati te nekoliko savjeta koji će vam pomoći da "govorite istim jezikom" kao i vaš programer.
Kada se upoznate s osnovnim mogućnostima, možete početi razgovarati sa svojim programerom o izradi alata i automatizacije s API-jem.
Timovi i organizacije
Stvaranje, ažuriranje, čitanje i brisanje timova i članova tima
Događaji
Stvorite, ažurirajte, klonirajte i čitajte. Događaji se ne mogu brisati.
Polaznici
Stvaranje, ažuriranje, čitanje, dodjeljivanje sesijama, dodjeljivanje grupama i brisanje podataka o društvenim računima (telefonski broj, oznake društvenih računa itd.). Sudionici se ne mogu izbrisati, ali se mogu blokirati.
Pitanja
Stvarajte, ažurirajte, čitajte i brišite
Savjet: U API-ju se pitanja nazivaju "prilagođena polja"
grupe
Stvorite, ažurirajte, čitajte i brišite isključive i neisključive grupe
Sjednice
Stvarajte, ažurirajte, čitajte i brišite
Lokacije
Stvarajte, ažurirajte, čitajte i brišite
Savjet: u API-ju se lokacije nazivaju "regije".
Branded Apps
Pročitajte nazive Branded App , statuse i nazive dodijeljenih događaja
Event App
Pročitajte postavke o osnovama, izgledu i web-aplikaciji te informacije o snimkama Video Center
Stvorite, ažurirajte, pročitajte i izbrišite sljedeće značajke Event App i njihove stavke, gdje je primjenjivo:
Dnevni red
Sponzori
Zvučnici
Izlagači
Uživo prijenos
Polaznici
Prilagođeni popis
Pojedinačna stavka
Web poveznica
Web lista
Moj QR kod
💡 Imajte na umu da morate ručno dodati i konfigurirati sve značajke Event App 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 naplate
Kreirajte, čitajte, ažurirajte i brišite ulaznice, obrasce, pitanja, promotivne kodove
Kreirajte, čitajte i ažurirajte narudžbe
Pošaljite e-poruke s potvrdom narudžbe i ulaznice
Označite narudžbe s čekovima ili fakturama kao plaćene
Ažurirajte podatke o kupcu narudžbe
Otkažite i vratite ulaznice
Stvorite, čitajte, ažurirajte, brišite, pauzirajte i nastavite s promotivnim kodovima
Stvaranje, čitanje, ažuriranje i brisanje poreza
Savjet: U API-ju se pitanja nazivaju "prilagođena polja".
Na Onsite
Pročitajte i ažurirajte informacije o osnovama i Onsite App
Lead Retrieval i Live Display
Pročitajte je li proizvod aktivan ili objavljen u Događaju
Stvari koje treba znati
Povremeno ćemo objaviti nove verzije API-ja s poboljšanjima i popravcima. Nastavit ćemo podržavati stare verzije dovoljno dugo da svi prijeđu na novu verziju. E-poštom ćemo slati ažuriranja o novim verzijama, nadolazećim datumima obustave stare verzije i službenim obustavama.
API zahtjevi se mjere i ograničavaju kako bi se spriječila zlouporaba.
Zajednice su također podržane za korisnike Suitea.