Acest articol a fost tradus din engleză folosind traducerea automată.
Dacă aveți un dezvoltator în echipa dvs. care știe să folosească un API GraphQL, API-ul Webex Events ar putea fi poarta dvs. de acces către automatizări puternice de configurare și gestionare a produselor și a evenimentelor, integrări cu platforme terțe, tablouri de bord puternice cu date cu mai multe evenimente și multe altele .
Ce poate face API-ul Webex Events
Mai simplu, un API este o interfață de programare pe care dezvoltatorii o pot folosi pentru a obține date sau pentru a pune date într-o platformă online - în acest caz, Webex Events.
Capacitățile API-ului pot fi simplificate la patru concepte de bază:
Creați ceva care nu exista înainte, cum ar fi un participant, o sesiune sau un eveniment întreg.
Actualizați orice poate fi folosit API-ul pentru a crea, plus alte câteva lucruri. De exemplu, API-ul poate fi folosit pentru a crea un nou participant și apoi edita numele, e-mailul, starea, grupurile, numerele de telefon și conturile sociale ale acestuia.
Citiți informații despre orice API-ul poate fi folosit pentru a crea sau edita, plus unele lucruri pe care nu le poate utiliza.
Ștergeți orice pentru a crea API-ul, cu unele excepții.
Țineți cont de aceste concepte în timp ce citiți secțiunea „Lucrul cu dezvoltatorii” din acest articol.
Cum să începeți
1. Obțineți acces la API
Dacă sunteți client Webex Suite Enterprise Agreement (Suite EA) care are deja Webex Events activat, obțineți automat acces la API-ul Webex Events ! Pentru toți ceilalți clienți, discutați cu persoana de contact Webex Events sau cu echipa noastră de asistență pentru a afla despre accesarea API-ului.
2. Creați o cheie API
Acum trebuie să creați o nouă cheie API pe care să o utilizeze dezvoltatorii dvs. Când aveți acces la API, o filă nouă este adăugată la pagina „Setări organizație” din platforma Webex Events . Iată cum să accesați noua filă și să creați prima cheie:
💡 Rețineți că numai administratorii organizației pot accesa pagina API.
De oriunde în platforma Webex Events , faceți clic pe imaginea de profil din colțul din dreapta sus al ecranului, apoi selectați Setări organizație din meniul drop-down.
În pagina Setări organizație, faceți clic pe fila API din meniul din stânga. Aceasta vă duce la tabloul de bord API unde puteți examina utilizarea API, puteți exporta jurnalele de utilizare, puteți gestiona cheile și puteți accesa documentația noastră API.
Faceți clic pe Creare cheie .
În modalul „Creați o cheie nouă”, introduceți o etichetă pentru cheia API care explică pentru ce va fi folosită.
Meniul drop-down Versiunea API va avea deja selectată versiunea curentă, așa că pur și simplu faceți clic pe Salvați . Aceasta dezvăluie cheia API.
Faceți clic pe butonul Copiați de lângă cheie și inserați cheia într-un document securizat pentru a vă asigura că nu se pierde niciodată.
⚠️ AVERTISMENT! Aceasta este singura dată când cheia API completă poate fi accesată. După ce închideți modulul, cheia completă nu poate fi citită din nou.
După ce ați copiat și salvat cheia, faceți clic pe butonul Închidere .
În cele mai multe cazuri, aveți nevoie de o singură cheie API. Cu toate acestea, în situațiile în care lucrați cu mai multe echipe, este posibil să doriți să creați o cheie pentru fiecare echipă. Discutați cu dezvoltatorii dvs. despre cazurile de utilizare specifice pentru a găsi cea mai bună soluție.
3. Invitați dezvoltatorii să acceseze API-ul
Când creați prima cheie API, o nouă echipă API este creată automat în platforma Webex Events . A oferi dezvoltatorilor dvs. acces pentru a încerca API-ul Webex Events este la fel de simplu ca să-i invitați în acea echipă API. Urmați instrucțiunile din articolul nostru despre gestionarea echipelor, a membrilor și a creditelor pentru a afla cum.
💡 Rețineți că sandbox-ul API este o versiune separată a platformei Webex Events , creată special pentru testare. Aceasta înseamnă că toți membrii noi ai echipei API Sandbox trebuie să creeze un nou cont de platformă pentru a utiliza sandbox-ul, chiar dacă au deja un cont de platformă sau se conectează cu SSO-ul organizației lor.
Oamenii din echipa ta API nu au acces la restul platformei Webex Events așa cum o fac organizatorii. În schimb, membrii echipei API au acces la un „sandbox” API unde pot testa ceea ce construiesc fără a afecta datele din lumea reală. Dacă doriți ca dezvoltatorii să aibă și acces la unele sau la toate evenimentele și aplicațiile dvs. reale din platforma Webex Events , invitați-i la echipe relevante non-API.
4. Pregătiți un eveniment
Deoarece API-ul nu poate activa niciunul dintre produsele dintr-un Eveniment, cum ar fi Event App și Onsite, trebuie să activați fiecare produs pe care intenționați să îl utilizați în evenimentul dvs., completând informațiile de bază necesare.
Lucrul cu dezvoltatorii
Este important să comunicați clar cu dezvoltatorii dvs., astfel încât aceștia să poată construi ceea ce aveți nevoie. Aceasta înseamnă că trebuie să știți ce părți ale platformei Webex Events poate accesa API-ul. Continuați să citiți pentru a afla exact ce poate accesa și controla API-ul, plus câteva sfaturi pentru a vă ajuta să „vorbiți aceeași limbă” ca și dezvoltatorul dvs.
Când sunteți familiarizat cu capabilitățile de bază, puteți începe să discutați cu dezvoltatorul despre construirea de instrumente și automatizări cu API.
Echipe și organizații
Creați, actualizați, citiți și ștergeți echipe și membri ai echipei
Evenimente
Creați, actualizați, clonați și citiți. Evenimentele nu pot fi șterse.
Participantii
Creați, actualizați, citiți, atribuiți sesiunilor, atribuiți grupurilor și ștergeți informațiile contului social (număr de telefon, numere de cont social etc.). Participanții nu pot fi șterși, deși pot fi blocați.
Întrebări
Creați, actualizați, citiți și ștergeți
Sfat: în API, întrebările se numesc „câmpuri personalizate”
Grupuri
Creați, actualizați, citiți și ștergeți atât grupuri exclusive, cât și neexclusive
Sesiuni
Creați, actualizați, citiți și ștergeți
Locații
Creați, actualizați, citiți și ștergeți
Sfat: în API, locațiile sunt numite „regiuni”.
Branded Apps
Citiți numele Branded App , stările și numele evenimentelor atribuite
Event App
Citiți elementele de bază, aspectul și setările aplicației web, plus informații despre înregistrările din Video Center
Creați, actualizați, citiți și ștergeți următoarele caracteristici ale Event App și elementele acestora, acolo unde este cazul:
Agendă
Sponsori
Difuzoare
Expozanti
Transmitere live
Participantii
Listă personalizată
Un singur articol
Link Web
Lista web
Codul meu QR
💡 Rețineți că trebuie să adăugați și să configurați manual orice caracteristici ale Event App care nu sunt enumerate mai sus.
Sfat: în API, caracteristicile sunt numite „componente”.
Înregistrare
Citiți informații de bază, aspect și setări, inclusiv setările de plată
Creați, citiți, actualizați și ștergeți bilete, formulare, întrebări, coduri promoționale
Creați, citiți și actualizați comenzi
Trimiteți e-mailuri de confirmare a comenzii și a biletelor
Marcați comenzile cu cec sau factură ca fiind plătite
Actualizați informațiile cumpărătorului comenzii
Anulați și rambursați biletele
Creați, citiți, actualizați, ștergeți, întrerupeți și reluați coduri promoționale
Creați, citiți, actualizați și ștergeți taxe
Sfat: în API, întrebările se numesc „câmpuri personalizate”.
Pe Onsite
Citiți și actualizați informațiile de bază și despre Onsite App
Lead Retrieval și Live Display
Citiți dacă produsul este activ sau publicat în Eveniment
Lucruri de știut
Vom lansa ocazional noi versiuni ale API-ului cu îmbunătățiri și remedieri. Vom continua să acceptăm versiunile vechi suficient de mult pentru ca toată lumea să facă tranziția la noua versiune. Vom trimite actualizări prin e-mail despre noile versiuni, viitoarele date de depreciere a versiunilor vechi și despre depreciările oficiale.
Solicitările API sunt măsurate și limitate pentru a preveni abuzul.
Comunitățile sunt, de asemenea, acceptate pentru clienții Suite.