Mulțumim pentru feedback.
Feedback?Dacă aveți un dezvoltator în echipa dvs. care știe cum să utilizeze un API GraphQL, API-ul Webex Events ar putea fi poarta dvs. de acces către automatizări puternice de configurare și gestionare a evenimentelor și a produselor, integrări de platforme terțe, tablouri de bord puternice de date multi-eveniment și multe altele.
Ce poate face API-ul Webex Events
Mai simplu spus, un API este o interfață de programare pe care dezvoltatorii o pot utiliza pentru a obține date de la 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ă:
-
Cre ați ceva care nu exista înainte, cum ar fi un participant, o sesiune sau un eveniment întreg.
-
Actu alizați orice poate fi folosit API-ul pentru a crea, plus alte câteva lucruri. De exemplu, API-ul poate fi utilizat pentru a crea un nou participant, apoi pentru a edita numele, adresa de e-mail, starea, grupurile, numerele de telefon și conturile sociale ale participantului respectiv.
-
Citiți informații despre orice poate fi folosit API-ul pentru a crea sau edita, plus unele lucruri pe care nu le poate.
-
Ștergeți orice poate fi folosit 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ă începi
1. Obțineți acces la API
Dacă sunteți un client al Acordului Webex Suite Enterprise (Suite EA) care are deja activat Webex Events, veți obține 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 dezvoltatorii dvs. să o folosească. 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 din 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 derulant.
-
În pagina Setări organizație, faceți clic pe fila API din meniul din stânga. Acest lucru vă duce la tabloul de bord API, unde puteți examina utilizarea API, exporta jurnalele de utilizare, gestiona cheile și accesa documentația noastră API.
-
Faceți clic pe Creare cheie.
-
În modalul „Creare cheie nouă” introduceți o etichetă pentru cheia API care explică pentru ce va fi utilizată.
-
Versiunea derul antă API va avea deja versiunea curentă selectată, așa că pur și simplu faceți clic pe Salvare. Aceasta dezvăluie cheia API.
-
Faceți clic pe butonul Copiere de lângă cheie și lipiț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 modalul, tasta completă nu poate fi citită din nou.
-
După ce ați copiat și salvat cheia, faceți clic pe butonul În chidere.
În cele mai multe cazuri, aveți nevoie doar de o 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 afla 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. Oferirea accesului dezvoltatorilor dvs. pentru a încerca API-ul Webex Events este la fel de simplu ca invitarea lor la acea echipă API. Urmați instrucțiunile din articolul nostru despre gestionarea echipelor, membrilor și creditelor pentru a afla cum.
Rețineți că sandbox-ul API este o versiune separată a platformei Webex Events realizată 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 al organizației lor.
Persoanele din echipa dvs. 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ă acces și la unele sau la toate evenimentele și aplicațiile dvs. reale din platforma Webex Events, invitați-i la echipe relevante non-API.
4. Fii amabil cu dezvoltatorii tăi
Acest lucru este crucial, așa că am făcut un pas întreg. 😉
„Roma nu a fost construită într-o zi” și nici o integrare API bună. Fiți un bun prieten pentru dezvoltatorii dvs. și acordați-le suficient timp pentru a se familiariza cu API-ul Webex Events înainte de a vă aștepta să furnizeze integrări. Vor fi recunoscători că nu sunt presați.
Cel puțin, vă recomandăm să începeți conversațiile cu dezvoltatorii dvs. cu cel puțin șase luni înainte de a avea nevoie de integrări care funcționează. Continuați să citiți pentru a afla cum să vă pregătiți și să purtați aceste conversații.
Lucrul cu dezvoltatorii
După ce ați invitat dezvoltatorii la echipa Webex Events Sandbox, una dintre primele întrebări poate fi: „Cât timp va dura pentru a construi integrări?” Răspunsul la această întrebare depinde de mulți factori, inclusiv câți dezvoltatori lucrați, cât timp au pentru a lucra la integrări, cât de complexe sunt integrările și multe altele.
Doar dezvoltatorii dvs. vă pot spune cât timp va dura configurarea unei integr ări și numai după câțiva pași cruciali:
-
Mai întâi, citiți secțiunile de mai jos pentru a afla ce poate face API-ul. Acest lucru vă va ajuta să înțelegeți ce este posibil, astfel încât să puteți comunica în mod clar nevoile dvs. cu dezvoltatorii dvs.
-
Faceți cunoștință cu dezvoltatorii dvs., împărtăș iți documentația noastră API cu ei și discutați ce doriți. Vor putea oferi feedback de bază despre ceea ce pot și nu pot face pentru dvs. Cu toate acestea, aceștia nu vă vor putea oferi cronologii specifice până când nu sunt familiarizați cu API-ul Webex Events.
-
Oferă-le dezvoltatorilor timp să se familiarizeze cu API-ul. Fii disponibil pentru a răspunde la întrebări conceptuale sau practice despre evenimentele tale, datele, platforma Webex Events și orice altceva.
Ce poate face API-ul
API-ul are două funcții de bază:
-
Citire - Obțineți date de la Webex Events, astfel încât să le puteți examina sau să le trageți într-un alt sistem.
-
Actualizare - Introduceți date în Webex Events pentru a crea elemente noi sau a sincroniza date, cum ar fi participanții, de pe o altă platformă. Orice lucru care schimbă ceva în platforma Webex Events este o actualizare.
Echipe și organizații
-
Crearea, actualizarea, citirea și ștergerea echipelor și a membrilor echipei
Evenimente
-
Actualizați, clonați și citiți. Evenimentele nu pot fi create sau șterse cu API.
Participanți
-
Creați, actualizați, citiți, atribuiți sesiunilor, atribuiți grupurilor și ștergeți informațiile contului social (număr de telefon, mânere de conturi sociale 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 sunt numite „câmpuri personalizate”
Grupuri
-
Creați, actualizați, citiți și ștergeți grupuri exclusive ș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”.
Aplicații de marcă
-
Citiți numele aplicațiilor de marcă, stările și numele evenimentelor atribuite
Aplicația Evenimentului
-
Citiți elementele de bază, aspectul și Web App setările, plus informațiile despre înregistrările Centrului video
-
Creați, actualizați, citiți și ștergeți următoarele caracteristici ale aplicației Eveniment și elementele acestora, după caz:
-
Agenda
-
Sponsori
-
Difuzoare
-
Expozanți
-
Transmisiune în direct
-
Participanți
-
Lista personalizată
-
Articol unic
-
Link Web
-
Lista web
-
Codul meu QR
-
Rețineți că trebuie să adăugați și să configurați manual orice caracteristici ale aplicației pentru evenimente care nu sunt enumerate mai sus.
Sfat: În API, caracteristicile sunt numite „componente”.
Înregistrare
-
Citiți informațiile 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
-
Crearea, citirea și actualizarea comenzilor
-
Trimiteți e-mailuri de confirmare a comenzii și a biletului
-
Marcați comenzile de verificare sau factură ca plătite
-
Actualizați informațiile despre cumpărătorul comenzii
-
Anularea și rambursarea biletelor
-
Creați, citiți, actualizați, ștergeți, întrerupeți și reluați codurile promoționale
-
Crearea, citirea, actualizarea și ștergerea taxelor
Sfat: În API, întrebările sunt numite „câmpuri personalizate”.
La fața locului
-
Citiți și actualizați elementele de bază și informațiile despre aplicația la fața locului
Recuperare clienți potențiali și afișare live
-
Citiți dacă produsul este activ sau publicat în Eveniment
Lucruri de știut
-
API-ul nu poate fi utilizat pentru a crea un Eveniment sau pentru a activa oricare dintre produsele dintr-un Eveniment, cum ar fi Aplicația Eveniment și Onsite. Înainte ca dezvoltatorii să poată modifica un Eveniment cu API, trebuie să activați fiecare produs pe care intenționați să îl utilizați și să completați informațiile de bază necesare pentru fiecare.
-
Ocazional vom lansa noi versiuni ale API-ului cu îmbunătățiri și remedieri. Vom continua să susținem versiunile vechi suficient de mult pentru ca toată lumea să poată trece la noua versiune. Vom trimite actualizări prin e-mail despre versiunile noi, datele viitoare de expirare a versiunilor vechi și încetările oficiale.
-
Cererile API sunt măsurate și limitate pentru a preveni abuzul.
-
Comunitățile sunt, de asemenea, acceptate pentru clienții Suite.
